Opened 12 years ago

Last modified 12 years ago

#312 closed defect (FIXED)

Use mongokit's "Dot Notation"

Reported by: Elrond Owned by: Christopher Allan Webber
Priority: minor Milestone: 0.2.1
Component: programming Keywords: sql
Cc: Parent Tickets:


mongokit supports accessing fields not only as ``doc['field']`` but
also as ``doc.field``.

-  This might look more pythonic.
-  This will ease a possible transition to sqlalchemy (as this it
   the sqlalchemy way)
-  Docs: Main
-  Switch it on now or in the sql-migration branch?
-  If switching it on now, should all accesses be converted to the
   new syntax?

Change History (17)

comment:1 by Elrond, 12 years ago

Component: Programming

comment:1 by Christopher Allan Webber, 12 years ago

Assuming we're doing the SQL migration, we should do this move
before rather than later.

comment:2 by Christopher Allan Webber, 12 years ago


    <Elrond> paroneayea - The question is somewhat "Would doing it now hurt in any
             way, no matter what we decide on sql?" ;)  [08:29]
    <paroneayea> Elrond: I think it would be pretty harmless!  [08:30]
    <paroneayea> and could be potentially helpful
    <paroneayea> I'll say as such in the ticket :)

It's also much more pythonic looking. This move gets a thumbs up
from me.

comment:3 by Elrond, 12 years ago

-  Migrations use pymongo: No Dot-Notation there!
-  ``new_obj = db.MediaEntry(), new_obj._id = ObjectId()`` doesn't
   seem to work as needed. I have no idea, what's actually going

So I vote for switching on Dot Notation just now and then
**slowly** migrate accesses over.

comment:4 by Elrond, 12 years ago

1. Enabling the whole thing (really simple, three lines)
2. Convert all Users.\* fields over to the dot-notation. (~900
   lines diff, 141 lines changed)
3. unit tests pass!
4. I'm stopping here.
5. I'm tempted to push (1) alone just today...
6. I have no idea, what might have broken.
7. I have no idea, what to do with (2)

comment:5 by Christopher Allan Webber, 12 years ago

If things are working, I say pushing what you have into master
right now is a good idea! We can keep this bug open to get the
other models, too.

comment:6 by Elrond, 12 years ago

pushing stuff¶

Okay, pushed (1) (enabling dot notation). Let's see, if this breaks
somethign for someone in the next 24 hours.
I will push ``['_id']`` -> ``._id`` tomorrow (it's the biggest
part) and let it be there for 48 hours.
Then I'll push all the remaining Users fields.

About ``._id``

About setting .\_id, here's a failing simple test case:


     test_user = mg_globals.database.User()
     test_user._id = u"some_id" 
     assert_equal(test_user['_id'], u"some_id")

I don't know, if this is a mongokit bug or feature. I haven't
checked mongokit's docs on this either.

Note: The following works, which is good!


     test_user = mg_globals.database.User()
     test_user['_id'] = u"some_id" 
     assert_equal(test_user._id, u"some_id")

So basicly, we should not assign to ``._id`` for now or create some
descriptor trickery to help this case. Or create the descriptor
trickery to help us move to something we want to have.

comment:7 by Elrond, 12 years ago

Okay, here is a snippet of code, which might help with the ``_id``
thing and help us migrate to a better named primary key column:


    class MongoPK(object):
            def __get__(self, instance, cls):
                    return instance['_id']   
            def __set__(self, instance, val):
                    instance['_id'] = val  
            def __delete__(self, instance):
                    del instance['_id']
    class C(dict):
            pk = MongoPK()

comment:8 by Christopher Allan Webber, 12 years ago

The primary key stuff might help a small amount, but I think we
shouldn't worry about it too much. Whatever involves primary keys
will probably have to change anyway, so probably not worth spending
too much time on. I think this bug is mostly useful in that it
helps tackle some low hanging fruit that would be useful for the
->SQL conversion, if we go that route.

comment:9 by Elrond, 12 years ago

``._id`` accesses are a lot of the accesses in the code. And not
all are really that specific, they're just to use "some primary key
like thingy". So not much will need to be changed there.

If we have an sql(alchemy) schema with primary keys, we can change
the accesses before going the sql branch.

comment:10 by Elrond, 12 years ago

Status: NewIn Progress

comment:10 by Elrond, 12 years ago

Milestone: 0.2.1
Owner: set to Elvenlord Elrond
I will try to get this done mostly after 0.2.0.

comment:11 by Elrond, 12 years ago

Owner: changed from Elvenlord Elrond to Christopher Webber
Status: In ProgressFeedback
Okay, as I'm out of town for a bit, I've pushed my current work
into a personal branch: ``sql/dot-notation``

Please (review and) merge **after** 0.2.0.

It doesn't seem to break anything for me. I don't want to break
0.2.0 just that lately. Let's break it afterwards, so that there is
plenty of time to fix it.

After merging, don't close this bug, set it back to "In Progress",
as I haven't converted all stuff over.

comment:12 by Elrond, 12 years ago

Status: FeedbackIn Progress
Okay, merged.

comment:13 by Christopher Allan Webber, 12 years ago

Status: In ProgressClosed
I've only vaguely looked at this, but things have been working for
the last month and I think it's safe to say that this was a good
idea transitionally. Closed!

comment:14 by Will Kahn-Greene, 12 years ago

The original url for this bug was .
#379: blocks

comment:15 by Elrond, 12 years ago

Keywords: sql added
Note: See TracTickets for help on using tickets.