Typing stubs (ets-labs#286)

* Add basic setup

* Add more tests for factory

* Add mypy checks to CI

* Add mypy checks to makefile command

* Add typing for the factories

* Add stub for Callable providers

* Add typing module and object provider stubs

* Fix typing test issue

* Remove typing module

* Add Delegate stub

* Add stub for Dependency provider

* Add stub for ExternalDependency

* Add stubs for providers module functions

* Add stubs for the DependenciesContainer provider

* Add stub for the CallableDelegate provider

* Add stubs for Coroutine providers

* Add stubs for the configuration options

* Add stub for the FactoryDelegate

* Add stub for the FactoryAggregate provider

* Add singleton stubs

* Add stubs for singletons

* Add stub for the List provider

* Add stub for the Container provider

* Add stub for the Selector provider

* Add stubs for the dynamic container

* Add stub for the declarative container

* Add stubs for the extensions

* Add types module for explicit provider typing

* Set absolute import mode for the providers module and add types module test

* Skip typing test for Python 3.5

* Remove coroutine test from py35

* Fix py35 tests

* Add \n to the tox.ini

Author: rmk135

.travis.yml

@@ -22,6 +22,10 @@ jobs:
     env: TOXENV=pydocstyle
     install: pip install tox
     script: tox
+  - python: 3.6
+    env: TOXENV=mypy
+    install: pip install tox
+    script: tox
   - python: 2.7
     env: TOXENV=py27
     install: pip install tox

MANIFEST.in

@@ -1,8 +1,9 @@
-recursive-include src/dependency_injector *.py *.pyx *.pxd *.c
+recursive-include src/dependency_injector *.py* *.c
 recursive-include tests *.py
 include README.rst
 include CONTRIBUTORS.rst
 include LICENSE.rst
 include requirements.txt
 include setup.py
 include tox.ini
+include py.typed

Makefile

@@ -60,13 +60,14 @@ test-py3: build
 	coverage html --rcfile=./.coveragerc
 
 check:
-	# Static analysis
 	flake8 src/dependency_injector/
 	flake8 examples/
-	# Code style analysis
+
 	pydocstyle src/dependency_injector/
 	pydocstyle examples/
 
+	mypy tests/typing
+
 test-publish: cythonize
 	# Create distributions
 	python setup.py sdist

requirements-dev.txt

@@ -6,5 +6,6 @@ flake8
 pydocstyle
 sphinx_autobuild
 pip
+mypy
 
 -r requirements-ext.txt

setup.cfg

@@ -1,3 +1,7 @@
 [flake8]
-max_line_length = 99
+max_line_length = 100
 max_complexity = 10
+exclude = types.py
+
+[pydocstyle]
+ignore = D100,D101,D102,D105,D106,D107,D203,D213

setup.py

@@ -47,7 +47,7 @@
           '': 'src',
       },
       package_data={
-          'dependency_injector': ['*.pxd'],
+          'dependency_injector': ['*.pxd', '*.pyi', 'py.typed'],
       },
       ext_modules=[
           Extension('dependency_injector.containers',

src/dependency_injector/__init__.pyi

@@ -0,0 +1,34 @@
+from typing import Type, Dict, Tuple, Optional, Any, Union, ClassVar, Callable as _Callable
+
+from .providers import Provider
+
+
+class Container:
+    provider_type: Type[Provider] = Provider
+    providers: Dict[str, Provider]
+    overridden: Tuple[Provider]
+    def __init__(self) -> None: ...
+    def __deepcopy__(self, memo: Optional[Dict[str, Any]]) -> Provider: ...
+    def __setattr__(self, name: str, value: Union[Provider, Any]) -> None: ...
+    def __delattr__(self, name: str) -> None: ...
+    def set_providers(self, **providers: Provider): ...
+    def override(self, overriding: DynamicContainer) -> None: ...
+    def override_providers(self, **overriding_providers: Provider) -> None: ...
+    def reset_last_overriding(self) -> None: ...
+    def reset_override(self) -> None: ...
+
+
+class DynamicContainer(Container): ...
+
+
+class DeclarativeContainer(Container):
+    cls_providers: ClassVar[Dict[str, Provider]]
+    inherited_providers: ClassVar[Dict[str, Provider]]
+
+
+def override(container: Container) -> _Callable[[Container], Container]: ...
+
+
+def copy(container: Container) -> _Callable[[Container], Container]: ...
+
+def is_container(instance: Any) -> bool: ...

src/dependency_injector/containers.pyi

@@ -0,0 +1,23 @@
+from typing import Awaitable as _Awaitable
+
+from dependency_injector import providers
+
+
+class Application(providers.Singleton): ...
+
+
+class Extension(providers.Singleton): ...
+
+
+class Middleware(providers.DelegatedCallable): ...
+
+
+class MiddlewareFactory(providers.Factory): ...
+
+
+class View(providers.Callable):
+    def as_view(self) -> _Awaitable: ...
+
+
+class ClassBasedView(providers.Factory):
+    def as_view(self) -> _Awaitable: ...