Changeset 3404

Timestamp:

07/29/07 23:18:30 (1 year ago)

Author:

mscott

Message:

Merging #59 to trunk:

Implementation of relabel, and some more thorough documentation
about labels.

Files:

• trunk/Schevo/doc/SchevoPublicApi.txt (modified) (3 diffs)
• trunk/Schevo/schevo/label.py (modified) (1 diff)
• trunk/Schevo/schevo/schema.py (modified) (2 diffs)
• trunk/Schevo/schevo/test/test_label.py (modified) (2 diffs)

trunk/Schevo/doc/SchevoPublicApi.txt

@@ -70 +70 @@
-
-
+Database labels
+---------------
+
+By default, a database instance is labeled "Schevo Database"::
+
+    >>> from schevo.label import label, relabel
+    >>> t = DocTest("""
+    ...     class Foo(E.Entity):
+    ...         pass
+    ...     """)
+    >>> print label(t.db)
+    Schevo Database
+
+Override the label by using `relabel`::
+
+    >>> relabel(t.db, 'My Database')
+    >>> print label(t.db)
+    My Database
+
+
-Extent instances
-================
@@ -103 +123 @@
-
-See the ``tests/test_relax_index.py`` test case for code examples.
+
+
+Extent labels
+-------------
+
+By default, an extent has a singular and plural label based on the
+entity class name associated with the extent::
+
+    >>> from schevo.label import label, plural
+    >>> t = DocTest("""
+    ...     class GreatPerson(E.Entity):
+    ...
+    ...         name = f.unicode()
+    ...     """)
+    >>> print label(t.db.GreatPerson)
+    Great Person
+    >>> print plural(t.db.GreatPerson)
+    Great Persons
+
+To override the singular and/or plural labels of an extent, assign
+values to the `_label` and/or `_plural` attributes of the associated
+entity class::
+
+    >>> from schevo.label import label, plural
+    >>> t = DocTest("""
+    ...     class GreatPerson(E.Entity):
+    ...      
+    ...         name = f.unicode()
+    ...
+    ...         _label = 'Great PERSON'
+    ...         _plural = 'Great PEOPLE'
+    ...     """)
+    >>> print label(t.db.GreatPerson)
+    Great PERSON
+    >>> print plural(t.db.GreatPerson)
+    Great PEOPLE
-
-
@@ -139 +195 @@
-
-  # Doctest to go here.
+
+
+Entity labels
+-------------
+
+The `label` of an entity instance is the same as the `unicode`
+representation of the entity instance.
+
+By default, the label is determined by the default key defined in the
+entity class::
+
+    >>> from schevo.label import label
+    >>> t = DocTest("""
+    ...     class State(E.Entity):
+    ...     
+    ...         name = f.unicode()
+    ...         abbreviation = f.unicode()
+    ...         
+    ...         _key(name)
+    ...         _key(abbreviation)
+    ...         
+    ...         _initial = [
+    ...             ('Missouri', 'MO'),
+    ...             ]
+    ...     """)
+    >>> missouri = t.db.State.findone(name='Missouri')
+    >>> print label(missouri)
+    Missouri
+
+If the key has more than one field, the values are separated by two
+colons::
+
+    >>> t = DocTest("""
+    ...     class City(E.Entity):
+    ...
+    ...         name = f.unicode()
+    ...         state = f.entity('State')
+    ...         
+    ...         _key(name, state)
+    ...
+    ...         _initial = [
+    ...             ('Monett', ('Missouri',)),
+    ...             ]
+    ...
+    ...     class State(E.Entity):
+    ...     
+    ...         name = f.unicode()
+    ...         abbreviation = f.unicode()
+    ...         
+    ...         _key(name)
+    ...         _key(abbreviation)
+    ...         
+    ...         _initial = [
+    ...             ('Missouri', 'MO'),
+    ...             ]
+    ...     """)
+    >>> missouri = t.db.State.findone(name='Missouri')
+    >>> monett = t.db.City.findone(name='Monett', state=missouri)
+    >>> print label(monett)
+    Monett :: Missouri
+
+Override the `__unicode__` method of an entity class to customize the
+label::
+
+    >>> t = DocTest("""
+    ...     class City(E.Entity):
+    ...
+    ...         name = f.unicode()
+    ...         state = f.entity('State')
+    ...         
+    ...         _key(name, state)
+    ...
+    ...         def __unicode__(self):
+    ...             return u'%s, %s' % (self.name, self.state.abbreviation)
+    ...
+    ...         _initial = [
+    ...             ('Monett', ('Missouri',)),
+    ...             ]
+    ...
+    ...     class State(E.Entity):
+    ...     
+    ...         name = f.unicode()
+    ...         abbreviation = f.unicode()
+    ...         
+    ...         _key(name)
+    ...         _key(abbreviation)
+    ...
+    ...         _initial = [
+    ...             ('Missouri', 'MO'),
+    ...             ]
+    ...     """)
+    >>> missouri = t.db.State.findone(name='Missouri')
+    >>> monett = t.db.City.findone(name='Monett', state=missouri)
+    >>> print label(monett)
+    Monett, MO
-
-

trunk/Schevo/schevo/label.py

@@ -82 +82 @@
-
-
+def relabel(obj, new_label):
+    """Relabel an object with a new label."""
+    obj._label = new_label
+
+
-optimize.bind_all(sys.modules[__name__])  # Last line of module.
-

trunk/Schevo/schevo/schema.py

@@ -24 +24 @@
-    'UNASSIGNED',
-    'extentmethod',
+    'relabel',
-    'schevo',  # And, indirectly, 'schevo.error'.
-    'with_label',
@@ -42 +43 @@
-    UNASSIGNED,
-    )
-
+relabel, 
-
-import schevo.base

trunk/Schevo/schevo/test/test_label.py

@@ -130 +130 @@
-            tx.from_account = self
-            tx.f.from_account.readonly = True
-tx._label = 'Transfer Funds From %s' % self
+relabel(tx, 'Transfer Funds From %s' % self)
-            return tx
-
@@ -341 +341 @@
-        assert label.label(db) == 'Schevo Database'
-        # It can be easily overridden.
-db.label = 'Custom Label'
+label.relabel(db, 'Custom Label')
-        assert label.label(db) == 'Custom Label'
-