@mapperproperty -> @declared_attr

1 files changed, 31 insertions, 31 deletions

diff --git a/lib/sqlalchemy/ext/declarative.py b/lib/sqlalchemy/ext/declarative.py
index be1cb75ec..cbda848e8 100755
--- a/lib/sqlalchemy/ext/declarative.py
+++ b/lib/sqlalchemy/ext/declarative.py
@@ -589,13 +589,13 @@ keys, as a :class:`ForeignKey` itself contains references to columns
 which can't be properly recreated at this level.  For columns that 
 have foreign keys, as well as for the variety of mapper-level constructs
 that require destination-explicit context, the
-:func:`~.mapperproperty` decorator is provided so that
+:func:`~.declared_attr` decorator is provided so that
 patterns common to many classes can be defined as callables::
 
-    from sqlalchemy.ext.declarative import mapperproperty
+    from sqlalchemy.ext.declarative import declared_attr
     
     class ReferenceAddressMixin(object):
-        @mapperproperty
+        @declared_attr
         def address_id(cls):
             return Column(Integer, ForeignKey('address.id'))
             
@@ -608,14 +608,14 @@ point at which the ``User`` class is constructed, and the declarative
 extension can use the resulting :class:`Column` object as returned by
 the method without the need to copy it.
 
-Columns generated by :func:`~.mapperproperty` can also be
+Columns generated by :func:`~.declared_attr` can also be
 referenced by ``__mapper_args__`` to a limited degree, currently 
 by ``polymorphic_on`` and ``version_id_col``, by specifying the 
 classdecorator itself into the dictionary - the declarative extension
 will resolve them at class construction time::
 
     class MyMixin:
-        @mapperproperty
+        @declared_attr
         def type_(cls):
             return Column(String(50))
 
@@ -630,18 +630,18 @@ Mixing in Relationships
 
 Relationships created by :func:`~sqlalchemy.orm.relationship` are provided
 with declarative mixin classes exclusively using the
-:func:`.mapperproperty` approach, eliminating any ambiguity
+:func:`.declared_attr` approach, eliminating any ambiguity
 which could arise when copying a relationship and its possibly column-bound
 contents. Below is an example which combines a foreign key column and a
 relationship so that two classes ``Foo`` and ``Bar`` can both be configured to
 reference a common target class via many-to-one::
 
     class RefTargetMixin(object):
-        @mapperproperty
+        @declared_attr
         def target_id(cls):
             return Column('target_id', ForeignKey('target.id'))
     
-        @mapperproperty
+        @declared_attr
         def target(cls):
             return relationship("Target")
     
@@ -664,11 +664,11 @@ To reference the mixin class in these expressions, use the given ``cls``
 to get it's name::
 
     class RefTargetMixin(object):
-        @mapperproperty
+        @declared_attr
         def target_id(cls):
             return Column('target_id', ForeignKey('target.id'))
         
-        @mapperproperty
+        @declared_attr
         def target(cls):
             return relationship("Target",
                 primaryjoin="Target.id==%s.target_id" % cls.__name__
@@ -681,12 +681,12 @@ Like :func:`~sqlalchemy.orm.relationship`, all
 :class:`~sqlalchemy.orm.interfaces.MapperProperty` subclasses such as
 :func:`~sqlalchemy.orm.deferred`, :func:`~sqlalchemy.orm.column_property`,
 etc. ultimately involve references to columns, and therefore, when 
-used with declarative mixins, have the :func:`.mapperproperty` 
+used with declarative mixins, have the :func:`.declared_attr` 
 requirement so that no reliance on copying is needed::
 
     class SomethingMixin(object):
 
-        @mapperproperty
+        @declared_attr
         def dprop(cls):
             return deferred(Column(Integer))
 
@@ -711,10 +711,10 @@ where you wanted to use that mixin in a single table inheritance
 hierarchy, you can explicitly specify ``__tablename__`` as ``None`` to
 indicate that the class should not have a table mapped::
 
-    from sqlalchemy.ext.declarative import mapperproperty
+    from sqlalchemy.ext.declarative import declared_attr
 
     class Tablename:
-        @mapperproperty
+        @declared_attr
         def __tablename__(cls):
             return cls.__name__.lower()
 
@@ -738,11 +738,11 @@ has a mapped table.
 As an example, here's a mixin that will only allow single table
 inheritance::
 
-    from sqlalchemy.ext.declarative import mapperproperty
+    from sqlalchemy.ext.declarative import declared_attr
     from sqlalchemy.ext.declarative import has_inherited_table
 
     class Tablename:
-        @mapperproperty
+        @declared_attr
         def __tablename__(cls):
             if has_inherited_table(cls):
                 return None
@@ -762,11 +762,11 @@ table inheritance, you would need a slightly different mixin and use
 it on any joined table child classes in addition to their parent
 classes::
 
-    from sqlalchemy.ext.declarative import mapperproperty
+    from sqlalchemy.ext.declarative import declared_attr
     from sqlalchemy.ext.declarative import has_inherited_table
 
     class Tablename:
-        @mapperproperty
+        @declared_attr
         def __tablename__(cls):
             if (has_inherited_table(cls) and
                 Tablename not in cls.__bases__):
@@ -796,11 +796,11 @@ In the case of ``__table_args__`` or ``__mapper_args__``
 specified with declarative mixins, you may want to combine
 some parameters from several mixins with those you wish to
 define on the class iteself. The
-:func:`.mapperproperty` decorator can be used
+:func:`.declared_attr` decorator can be used
 here to create user-defined collation routines that pull
 from multiple collections::
 
-    from sqlalchemy.ext.declarative import mapperproperty
+    from sqlalchemy.ext.declarative import declared_attr
 
     class MySQLSettings:
         __table_args__ = {'mysql_engine':'InnoDB'}             
@@ -811,7 +811,7 @@ from multiple collections::
     class MyModel(Base,MySQLSettings,MyOtherMixin):
         __tablename__='my_model'
 
-        @mapperproperty
+        @declared_attr
         def __table_args__(self):
             args = dict()
             args.update(MySQLSettings.__table_args__)
@@ -897,7 +897,7 @@ def _as_declarative(cls, classname, dict_):
     tablename = None
     parent_columns = ()
     
-    declarative_props = (mapperproperty, util.classproperty)
+    declarative_props = (declared_attr, util.classproperty)
     
     for base in cls.__mro__:
         class_mapped = _is_mapped_class(base)
@@ -1265,30 +1265,30 @@ def comparable_using(comparator_factory):
         return comparable_property(comparator_factory, fn)
     return decorate
 
-class mapperproperty(property):
+class declared_attr(property):
     """Mark a class-level method as representing the definition of
     a mapped property or special declarative member name.
 
-    .. note:: @mapperproperty is available as 
+    .. note:: @declared_attr is available as 
       sqlalchemy.util.classproperty for SQLAlchemy versions
       0.6.2, 0.6.3, 0.6.4.
       
-    @mapperproperty turns the attribute into a scalar-like
+    @declared_attr turns the attribute into a scalar-like
     property that can be invoked from the uninstantiated class.
     Declarative treats attributes specifically marked with 
-    @mapperproperty as returning a construct that is specific
+    @declared_attr as returning a construct that is specific
     to mapping or declarative table configuration.  The name
     of the attribute is that of what the non-dynamic version
     of the attribute would be.
     
-    @mapperproperty is more often than not applicable to mixins,
+    @declared_attr is more often than not applicable to mixins,
     to define relationships that are to be applied to different
     implementors of the class::
     
         class ProvidesUser(object):
             "A mixin that adds a 'user' relationship to classes."
             
-            @mapperproperty
+            @declared_attr
             def user(self):
                 return relationship("User")
     
@@ -1299,11 +1299,11 @@ class mapperproperty(property):
             id = Column(Integer, primary_key=True)
             type = Column(String(50), nullable=False)
             
-            @mapperproperty
+            @declared_attr
             def __tablename__(cls):
                 return cls.__name__.lower()
             
-            @mapperproperty
+            @declared_attr
             def __mapper_args__(cls):
                 if cls.__name__ == 'Employee':
                     return {
@@ -1316,7 +1316,7 @@ class mapperproperty(property):
     """
     
     def __init__(self, fget, *arg, **kw):
-        super(mapperproperty, self).__init__(fget, *arg, **kw)
+        super(declared_attr, self).__init__(fget, *arg, **kw)
         self.__doc__ = fget.__doc__
         
     def __get__(desc, self, cls):