ets-labs/python-dependency-injector
1
1
Fork 0
mirror of https://github.com/ets-labs/python-dependency-injector.git synced 2025-02-07 15:10:47 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add API docs for declarative catalog meta class

Browse Source
This commit is contained in:
Roman Mogilatov 2015-11-16 15:58:44 +02:00
parent 9a5e8f4a5a
commit 9e4138da96
1 changed files with 42 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
dependency_injector/catalogs.py
View File

@ -250,27 +250,47 @@ class DeclarativeCatalogMetaClass(type):
@property @property
def name(cls): def name(cls):
"""Return catalog's name.""" """Read-only property that represents catalog's name.
Catalog's name is catalog's module + catalog's class name.
:type: str
"""
return cls._catalog.name return cls._catalog.name
@property @property
def providers(cls): def providers(cls):
"""Return dict of catalog's providers.""" """Read-only dictionary of all providers.
:type: dict[str, :py:class:`dependency_injector.providers.Provider`]
"""
return cls._catalog.providers return cls._catalog.providers
@property @property
def overridden_by(cls): def overridden_by(cls):
"""Return tuple of overriding catalogs.""" """Tuple of overriding catalogs.
:type: tuple[
:py:class:`dependency_injector.catalogs.DeclarativeCatalog` |
:py:class:`dependency_injector.catalogs.DynamicCatalog`]
"""
return cls._catalog.overridden_by return cls._catalog.overridden_by
@property @property
def is_overridden(cls): def is_overridden(cls):
"""Check if catalog is overridden by another catalog.""" """Check if catalog is overridden by another catalog.
:rtype: bool
"""
return cls._catalog.is_overridden return cls._catalog.is_overridden
@property @property
def last_overriding(cls): def last_overriding(cls):
"""Return last overriding catalog.""" """Read-only reference to the last overriding catalog, if any.
:type: :py:class:`dependency_injector.catalogs.DeclarativeCatalog` |
:py:class:`dependency_injector.catalogs.DynamicCatalog`
"""
return cls._catalog.last_overriding return cls._catalog.last_overriding
def __getattr__(cls, name): def __getattr__(cls, name):
@ -279,7 +299,7 @@ class DeclarativeCatalogMetaClass(type):
:param name: Attribute's name :param name: Attribute's name
:type name: str :type name: str
:raise: dependency_injector.UndefinedProviderError :raise: :py:class:`dependency_injector.errors.UndefinedProviderError`
""" """
raise UndefinedProviderError('There is no provider "{0}" in ' raise UndefinedProviderError('There is no provider "{0}" in '
'catalog {1}'.format(name, cls)) 'catalog {1}'.format(name, cls))
@ -288,13 +308,14 @@ class DeclarativeCatalogMetaClass(type):
"""Handle setting of catalog attributes. """Handle setting of catalog attributes.
Setting of attributes works as usual, but if value of attribute is Setting of attributes works as usual, but if value of attribute is
provider, this provider will be bound to catalog correctly. provider, this provider will be bound to catalog.
:param name: Attribute's name :param name: Attribute's name
:type name: str :type name: str
:param value: Attribute's value :param value: Attribute's value
:type value: dependency_injector.Provider | object :type value: :py:class:`dependency_injector.providers.Provider` |
object
:rtype: None :rtype: None
""" """
@ -306,7 +327,7 @@ class DeclarativeCatalogMetaClass(type):
"""Handle deleting of catalog attibute. """Handle deleting of catalog attibute.
Deleting of attributes works as usual, but if value of attribute is Deleting of attributes works as usual, but if value of attribute is
provider, this provider will be unbound from catalog correctly. provider, this provider will be unbound from catalog.
:param name: Attribute's name :param name: Attribute's name
:type name: str :type name: str
@ -345,9 +366,9 @@ class DeclarativeCatalog(object):
""" """
name = str() name = str()
"""Catalog's name. """Read-only property that represents catalog's name.
By default it is catalog's module + class names. Catalog's name is catalog's module + catalog's class name.
:type: str :type: str
""" """
@ -387,7 +408,7 @@ class DeclarativeCatalog(object):
"""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:`dependency_injector.catalogs.DeclarativeCatalog` |
:py:class:`dependency_injector.catalogs.DynamicCatalog` | None :py:class:`dependency_injector.catalogs.DynamicCatalog`
""" """
_catalog = DynamicCatalog _catalog = DynamicCatalog
@ -589,7 +610,15 @@ AbstractCatalog = DeclarativeCatalog
def override(catalog): def override(catalog):
"""Catalog overriding decorator.""" """Catalog overriding decorator.
:param catalog: Catalog that should be overridden by decorated catalog.
:type catalog: :py:class:`dependency_injector.catalogs.DeclarativeCatalog`
:return: Declarative catalog's overriding decorator
:rtype: callable(
:py:class:`dependency_injector.catalogs.DeclarativeCatalog`)
"""
def decorator(overriding_catalog): def decorator(overriding_catalog):
"""Overriding decorator.""" """Overriding decorator."""
catalog.override(overriding_catalog) catalog.override(overriding_catalog)