From 0a6e05657eae92cb59ccb30fc6802d100e43f837 Mon Sep 17 00:00:00 2001 From: Roman Mogilatov Date: Tue, 24 Nov 2015 10:33:29 +0200 Subject: [PATCH] Update catalogs API docs --- dependency_injector/catalogs.py | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/dependency_injector/catalogs.py b/dependency_injector/catalogs.py index 4e84f5df..46ba57a3 100644 --- a/dependency_injector/catalogs.py +++ b/dependency_injector/catalogs.py @@ -121,7 +121,15 @@ class CatalogBundle(object): @six.python_2_unicode_compatible class DynamicCatalog(object): - """Dynamic catalog of providers.""" + """Dynamic catalog of providers. + + .. code-block:: python + + services = DynamicCatalog(auth=providers.Factory(AuthService), + users=providers.Factory(UsersService)) + + users_service = services.users() + """ __IS_CATALOG__ = True __slots__ = ('name', 'providers', 'provider_names', 'overridden_by', @@ -537,6 +545,16 @@ class DeclarativeCatalog(object): defined in declarative manner. It should cover most of the cases when list of providers that would be included in catalog is deterministic (catalog will not change its structure in runtime). + + .. code-block:: python + + class Services(DeclarativeCatalog): + + auth = providers.Factory(AuthService) + + users = providers.Factory(UsersService) + + users_service = Services.users() """ Bundle = CatalogBundle