From: Jeffrey Finkelstein Date: Wed, 4 May 2016 00:46:20 +0000 (-0400) Subject: Corrects some references in ORM documentation. X-Git-Tag: rel_1_1_0b1~56^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e6251c3e40e623aaadc7356c0b3c94101710079c;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git Corrects some references in ORM documentation. --- diff --git a/doc/build/faq/ormconfiguration.rst b/doc/build/faq/ormconfiguration.rst index 3a2ea29a67..faaee449e9 100644 --- a/doc/build/faq/ormconfiguration.rst +++ b/doc/build/faq/ormconfiguration.rst @@ -89,7 +89,8 @@ To get at the :class:`.Mapper` for a particular mapped class, call the mapper = inspect(MyClass) -From there, all information about the class can be acquired using such methods as: +From there, all information about the class can be accessed through properties +such as: * :attr:`.Mapper.attrs` - a namespace of all mapped attributes. The attributes themselves are instances of :class:`.MapperProperty`, which contain additional diff --git a/lib/sqlalchemy/orm/mapper.py b/lib/sqlalchemy/orm/mapper.py index 06d903e9cf..858c353447 100644 --- a/lib/sqlalchemy/orm/mapper.py +++ b/lib/sqlalchemy/orm/mapper.py @@ -2121,7 +2121,7 @@ class Mapper(InspectionAttr): .. warning:: - the :attr:`.Mapper.relationships` accessor namespace is an + The :attr:`.Mapper.attrs` accessor namespace is an instance of :class:`.OrderedProperties`. This is a dictionary-like object which includes a small number of named methods such as :meth:`.OrderedProperties.items` @@ -2167,14 +2167,15 @@ class Mapper(InspectionAttr): .. warning:: - the :attr:`.Mapper.relationships` accessor namespace is an + The :attr:`.Mapper.all_orm_descriptors` accessor namespace is an instance of :class:`.OrderedProperties`. This is a dictionary-like object which includes a small number of named methods such as :meth:`.OrderedProperties.items` and :meth:`.OrderedProperties.values`. When accessing attributes dynamically, favor using the dict-access - scheme, e.g. ``mapper.attrs[somename]`` over - ``getattr(mapper.attrs, somename)`` to avoid name collisions. + scheme, e.g. ``mapper.all_orm_descriptors[somename]`` over + ``getattr(mapper.all_orm_descriptors, somename)`` to avoid name + collisions. .. versionadded:: 0.8.0 @@ -2214,8 +2215,8 @@ class Mapper(InspectionAttr): @_memoized_configured_property def relationships(self): - """Return a namespace of all :class:`.RelationshipProperty` - properties maintained by this :class:`.Mapper`. + """A namespace of all :class:`.RelationshipProperty` properties + maintained by this :class:`.Mapper`. .. warning:: @@ -2225,8 +2226,9 @@ class Mapper(InspectionAttr): named methods such as :meth:`.OrderedProperties.items` and :meth:`.OrderedProperties.values`. When accessing attributes dynamically, favor using the dict-access - scheme, e.g. ``mapper.attrs[somename]`` over - ``getattr(mapper.attrs, somename)`` to avoid name collisions. + scheme, e.g. ``mapper.relationships[somename]`` over + ``getattr(mapper.relationships, somename)`` to avoid name + collisions. .. seealso::