Add docs for get_mapper

This commit is contained in:
Konsta Vesterinen
2014-05-14 15:51:32 +03:00
parent 73a133490e
commit 04a5292425
2 changed files with 28 additions and 1 deletions

View File

@@ -34,6 +34,12 @@ get_declarative_base
.. autofunction:: get_declarative_base
get_mapper
^^^^^^^^^^
.. autofunction:: get_mapper
get_primary_keys
^^^^^^^^^^^^^^^^

View File

@@ -23,7 +23,28 @@ def get_mapper(mixed):
"""
Return related SQLAlchemy Mapper for given SQLAlchemy object.
:param mixed: SQLAlchemy Table object
:param mixed: SQLAlchemy Table / Alias / Mapper / declarative model object
::
from sqlalchemy_utils import get_mapper
get_mapper(User)
get_mapper(User())
get_mapper(User.__table__)
get_mapper(User.__mapper__)
get_mapper(sa.orm.aliased(User))
get_mapper(sa.orm.aliased(User.__table__))
Raises:
ValueError: if multiple mappers were found for given argument
.. versionadded: 0.26.1
"""