diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-04-14 13:15:21 -0400 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-04-14 13:15:21 -0400 |
commit | cea03be855514d592b6671fa6dbc074a19a795fb (patch) | |
tree | f127540bda77a4ea5d9935cffedf04d8b01776a9 /lib/sqlalchemy/orm/base.py | |
parent | a898ade3bc36ca27cf9475d1348249646eb40e95 (diff) | |
download | sqlalchemy-cea03be855514d592b6671fa6dbc074a19a795fb.tar.gz |
Run search and replace of symbolic module names
Replaces a wide array of Sphinx-relative doc references
with an abbreviated absolute form now supported by
zzzeeksphinx.
Change-Id: I94bffcc3f37885ffdde6238767224296339698a2
Diffstat (limited to 'lib/sqlalchemy/orm/base.py')
-rw-r--r-- | lib/sqlalchemy/orm/base.py | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/lib/sqlalchemy/orm/base.py b/lib/sqlalchemy/orm/base.py index 6df8acf1e..07809282b 100644 --- a/lib/sqlalchemy/orm/base.py +++ b/lib/sqlalchemy/orm/base.py @@ -166,7 +166,7 @@ EXT_SKIP = util.symbol("EXT_SKIP") ONETOMANY = util.symbol( "ONETOMANY", - """Indicates the one-to-many direction for a :func:`.relationship`. + """Indicates the one-to-many direction for a :func:`_orm.relationship`. This symbol is typically used by the internals but may be exposed within certain API features. @@ -176,7 +176,7 @@ ONETOMANY = util.symbol( MANYTOONE = util.symbol( "MANYTOONE", - """Indicates the many-to-one direction for a :func:`.relationship`. + """Indicates the many-to-one direction for a :func:`_orm.relationship`. This symbol is typically used by the internals but may be exposed within certain API features. @@ -186,7 +186,7 @@ MANYTOONE = util.symbol( MANYTOMANY = util.symbol( "MANYTOMANY", - """Indicates the many-to-many direction for a :func:`.relationship`. + """Indicates the many-to-many direction for a :func:`_orm.relationship`. This symbol is typically used by the internals but may be exposed within certain API features. @@ -298,7 +298,7 @@ def object_state(instance): Raises :class:`sqlalchemy.orm.exc.UnmappedInstanceError` if no mapping is configured. - Equivalent functionality is available via the :func:`.inspect` + Equivalent functionality is available via the :func:`_sa.inspect` function as:: inspect(instance) @@ -336,7 +336,7 @@ def _class_to_mapper(class_or_mapper): def _mapper_or_none(entity): - """Return the :class:`.Mapper` for the given class or None if the + """Return the :class:`_orm.Mapper` for the given class or None if the class is not mapped. """ @@ -349,7 +349,7 @@ def _mapper_or_none(entity): def _is_mapped_class(entity): """Return True if the given object is a mapped class, - :class:`.Mapper`, or :class:`.AliasedClass`. + :class:`_orm.Mapper`, or :class:`.AliasedClass`. """ insp = inspection.inspect(entity, False) @@ -422,14 +422,14 @@ def _inspect_mapped_class(class_, configure=False): def class_mapper(class_, configure=True): - """Given a class, return the primary :class:`.Mapper` associated + """Given a class, return the primary :class:`_orm.Mapper` associated with the key. Raises :exc:`.UnmappedClassError` if no mapping is configured on the given class, or :exc:`.ArgumentError` if a non-class object is passed. - Equivalent functionality is available via the :func:`.inspect` + Equivalent functionality is available via the :func:`_sa.inspect` function as:: inspect(some_mapped_class) @@ -451,7 +451,7 @@ def class_mapper(class_, configure=True): class InspectionAttr(object): """A base class applied to all ORM objects that can be returned - by the :func:`.inspect` function. + by the :func:`_sa.inspect` function. The attributes defined here allow the usage of simple boolean checks to test basic facts about the object returned. @@ -467,7 +467,8 @@ class InspectionAttr(object): __slots__ = () is_selectable = False - """Return True if this object is an instance of :class:`.Selectable`.""" + """Return True if this object is an instance of """ + """:class:`expression.Selectable`.""" is_aliased_class = False """True if this object is an instance of :class:`.AliasedClass`.""" @@ -476,7 +477,7 @@ class InspectionAttr(object): """True if this object is an instance of :class:`.InstanceState`.""" is_mapper = False - """True if this object is an instance of :class:`.Mapper`.""" + """True if this object is an instance of :class:`_orm.Mapper`.""" is_property = False """True if this object is an instance of :class:`.MapperProperty`.""" @@ -493,7 +494,7 @@ class InspectionAttr(object): .. seealso:: - :attr:`.Mapper.all_orm_descriptors` + :attr:`_orm.Mapper.all_orm_descriptors` """ @@ -505,7 +506,8 @@ class InspectionAttr(object): """ is_clause_element = False - """True if this object is an instance of :class:`.ClauseElement`.""" + """True if this object is an instance of """ + """:class:`_expression.ClauseElement`.""" extension_type = NOT_EXTENSION """The extension type, if any. @@ -538,7 +540,8 @@ class InspectionAttrInfo(InspectionAttr): The dictionary is generated when first accessed. Alternatively, it can be specified as a constructor argument to the - :func:`.column_property`, :func:`.relationship`, or :func:`.composite` + :func:`.column_property`, :func:`_orm.relationship`, or + :func:`.composite` functions. .. versionchanged:: 1.0.0 :attr:`.MapperProperty.info` is also |