ets-labs/python-dependency-injector
1
1
Fork 0
mirror of https://github.com/ets-labs/python-dependency-injector.git synced 2025-05-03 23:43:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update catalogs API docs

Browse Source
This commit is contained in:
Roman Mogilatov 2015-11-24 09:59:53 +02:00
parent 9de675b385
commit a064ce97da
1 changed files with 21 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
dependency_injector/catalogs.py
View File

@ -34,8 +34,7 @@ class CatalogBundle(object):
catalog = None catalog = None
"""Bundle's catalog. """Bundle's catalog.
:type: :py:class:`dependency_injector.catalogs.DeclarativeCatalog` | :type: :py:class:`DeclarativeCatalog` | :py:class:`DynamicCatalog`
:py:class:`dependency_injector.catalogs.DynamicCatalog`
""" """
__IS_CATALOG_BUNDLE__ = True __IS_CATALOG_BUNDLE__ = True
@ -45,9 +44,8 @@ class CatalogBundle(object):
def sub_cls_factory(cls, catalog): def sub_cls_factory(cls, catalog):
"""Create bundle subclass for catalog. """Create bundle subclass for catalog.
:return: Subclass of :return: Subclass of :py:class:`CatalogBundle`
:py:class:`dependency_injector.catalogs.CatalogBundle` :rtype: :py:class:`CatalogBundle`
:rtype: :py:class:`dependency_injector.catalogs.CatalogBundle`
""" """
return type('BundleSubclass', (cls,), dict(catalog=catalog)) return type('BundleSubclass', (cls,), dict(catalog=catalog))
@ -139,7 +137,7 @@ class DynamicCatalog(object):
self.Bundle = CatalogBundle.sub_cls_factory(self) self.Bundle = CatalogBundle.sub_cls_factory(self)
"""Catalog's bundle class. """Catalog's bundle class.
:type: :py:class:`dependency_injector.catalogs.CatalogBundle` :type: :py:class:`CatalogBundle`
""" """
self.name = '.'.join((self.__class__.__module__, self.name = '.'.join((self.__class__.__module__,
@ -163,8 +161,7 @@ class DynamicCatalog(object):
"""Tuple of overriding catalogs. """Tuple of overriding catalogs.
:type: tuple[ :type: tuple[
:py:class:`dependency_injector.catalogs.DeclarativeCatalog` | :py:class:`DeclarativeCatalog` | :py:class:`DynamicCatalog`]
:py:class:`dependency_injector.catalogs.DynamicCatalog`]
""" """
self.bind_providers(providers) self.bind_providers(providers)
@ -174,7 +171,7 @@ class DynamicCatalog(object):
"""Check if catalog is bundle owner. """Check if catalog is bundle owner.
:param bundle: Catalog's bundle instance :param bundle: Catalog's bundle instance
:type bundle: :py:class:`dependency_injector.catalogs.CatalogBundle` :type bundle: :py:class:`CatalogBundle`
:rtype: bool :rtype: bool
""" """
@ -230,8 +227,7 @@ class DynamicCatalog(object):
def last_overriding(self): def last_overriding(self):
"""Read-only reference to the last overriding catalog, if any. """Read-only reference to the last overriding catalog, if any.
:type: :py:class:`dependency_injector.catalogs.DeclarativeCatalog` | :type: :py:class:`DeclarativeCatalog` | :py:class:`DynamicCatalog`
:py:class:`dependency_injector.catalogs.DynamicCatalog`
""" """
try: try:
return self.overridden_by[-1] return self.overridden_by[-1]
@ -242,9 +238,8 @@ class DynamicCatalog(object):
"""Override current catalog providers by overriding catalog providers. """Override current catalog providers by overriding catalog providers.
:param overriding: Overriding catalog :param overriding: Overriding catalog
:type overriding: :type overriding: :py:class:`DeclarativeCatalog` |
:py:class:`dependency_injector.catalogs.DeclarativeCatalog` | :py:class:`DynamicCatalog`
:py:class:`dependency_injector.catalogs.DynamicCatalog`
:rtype: None :rtype: None
""" """
@ -457,8 +452,8 @@ class DeclarativeCatalogMetaClass(type):
"""Tuple of overriding catalogs. """Tuple of overriding catalogs.
:type: tuple[ :type: tuple[
:py:class:`dependency_injector.catalogs.DeclarativeCatalog` | :py:class:`DeclarativeCatalog` |
:py:class:`dependency_injector.catalogs.DynamicCatalog`] :py:class:`DynamicCatalog`]
""" """
return cls._catalog.overridden_by return cls._catalog.overridden_by
@ -474,8 +469,7 @@ class DeclarativeCatalogMetaClass(type):
def last_overriding(cls): def last_overriding(cls):
"""Read-only reference to the last overriding catalog, if any. """Read-only reference to the last overriding catalog, if any.
:type: :py:class:`dependency_injector.catalogs.DeclarativeCatalog` | :type: :py:class:`DeclarativeCatalog` | :py:class:`DynamicCatalog`
:py:class:`dependency_injector.catalogs.DynamicCatalog`
""" """
return cls._catalog.last_overriding return cls._catalog.last_overriding
@ -548,7 +542,7 @@ class DeclarativeCatalog(object):
Bundle = CatalogBundle Bundle = CatalogBundle
"""Catalog's bundle class. """Catalog's bundle class.
:type: :py:class:`dependency_injector.catalogs.CatalogBundle` :type: :py:class:`CatalogBundle`
""" """
name = str() name = str()
@ -580,8 +574,8 @@ class DeclarativeCatalog(object):
overridden_by = tuple() overridden_by = tuple()
"""Tuple of overriding catalogs. """Tuple of overriding catalogs.
:type: tuple[:py:class:`dependency_injector.catalogs.DeclarativeCatalog` | :type: tuple[:py:class:`DeclarativeCatalog` |
:py:class:`dependency_injector.catalogs.DynamicCatalog`] :py:class:`DynamicCatalog`]
""" """
is_overridden = bool is_overridden = bool
@ -593,8 +587,7 @@ class DeclarativeCatalog(object):
last_overriding = None last_overriding = None
"""Read-only reference to the last overriding catalog, if any. """Read-only reference to the last overriding catalog, if any.
:type: :py:class:`dependency_injector.catalogs.DeclarativeCatalog` | :type: :py:class:`DeclarativeCatalog` | :py:class:`DynamicCatalog`
:py:class:`dependency_injector.catalogs.DynamicCatalog`
""" """
_catalog = DynamicCatalog _catalog = DynamicCatalog
@ -606,7 +599,7 @@ class DeclarativeCatalog(object):
"""Check if catalog is bundle owner. """Check if catalog is bundle owner.
:param bundle: Catalog's bundle instance :param bundle: Catalog's bundle instance
:type bundle: :py:class:`dependency_injector.catalogs.CatalogBundle` :type bundle: :py:class:`CatalogBundle`
:rtype: bool :rtype: bool
""" """
@ -653,9 +646,8 @@ class DeclarativeCatalog(object):
"""Override current catalog providers by overriding catalog providers. """Override current catalog providers by overriding catalog providers.
:param overriding: Overriding catalog :param overriding: Overriding catalog
:type overriding: :type overriding: :py:class:`DeclarativeCatalog` |
:py:class:`dependency_injector.catalogs.DeclarativeCatalog` | :py:class:`DynamicCatalog`
:py:class:`dependency_injector.catalogs.DynamicCatalog`
:rtype: None :rtype: None
""" """
@ -801,11 +793,10 @@ def override(catalog):
""":py:class:`DeclarativeCatalog` overriding decorator. """:py:class:`DeclarativeCatalog` overriding decorator.
:param catalog: Catalog that should be overridden by decorated catalog. :param catalog: Catalog that should be overridden by decorated catalog.
:type catalog: :py:class:`dependency_injector.catalogs.DeclarativeCatalog` :type catalog: :py:class:`DeclarativeCatalog` | :py:class:`DynamicCatalog`
:return: Declarative catalog's overriding decorator :return: Declarative catalog's overriding decorator
:rtype: callable( :rtype: callable(:py:class:`DeclarativeCatalog`)
:py:class:`dependency_injector.catalogs.DeclarativeCatalog`)
""" """
def decorator(overriding_catalog): def decorator(overriding_catalog):
"""Overriding decorator.""" """Overriding decorator."""