diff --git a/docs/main/changelog.rst b/docs/main/changelog.rst index 294a4722..b9f80c35 100644 --- a/docs/main/changelog.rst +++ b/docs/main/changelog.rst @@ -14,7 +14,10 @@ Development version - Add support of six 1.14.0. - Add support of six 1.13.0. - Regenerate C sources using Cython 0.29.14. -- Fix PEP257 doc block errors in example modules. +- Remove Python 2-ish inheritance from ``object`` in example modules. +- Replace Python 2-ish ``super(class, self).__init__()`` calls with Python 3-ish + ``super().__init__()`` in example modules. +- Fix doc block errors in example modules, including related to PEP257-compliance. - Clean up tox.ini file. 3.14.12 diff --git a/examples/di_demo/example.py b/examples/di_demo/example.py index 545b3e86..4aaa9590 100644 --- a/examples/di_demo/example.py +++ b/examples/di_demo/example.py @@ -1,11 +1,11 @@ """The Code.""" -class Service(object): +class Service: """Some "Service".""" -class Client(object): +class Client: """Some "Client" that uses "Service".""" def __init__(self): diff --git a/examples/di_demo/example_di.py b/examples/di_demo/example_di.py index 0cb704c9..cd19c591 100644 --- a/examples/di_demo/example_di.py +++ b/examples/di_demo/example_di.py @@ -1,11 +1,11 @@ """The Code, that demonstrates dependency injection pattern.""" -class Service(object): +class Service: """Some "Service".""" -class Client(object): +class Client: """Some "Client" that uses "Service".""" def __init__(self, service): # Service instance is injected into Client diff --git a/examples/miniapps/api_client/api.py b/examples/miniapps/api_client/api.py index e7b0d6ae..b876a470 100644 --- a/examples/miniapps/api_client/api.py +++ b/examples/miniapps/api_client/api.py @@ -1,7 +1,7 @@ -"""TBD.""" +"""API client module.""" -class ApiClient(object): +class ApiClient: """Some API client.""" def __init__(self, host, api_key): diff --git a/examples/miniapps/api_client/main.py b/examples/miniapps/api_client/main.py index 9755e055..d99979d8 100644 --- a/examples/miniapps/api_client/main.py +++ b/examples/miniapps/api_client/main.py @@ -1,4 +1,4 @@ -"""TBD.""" +"""Main module.""" from dependency_injector import providers diff --git a/examples/miniapps/api_client/models.py b/examples/miniapps/api_client/models.py index 376bb51e..f8145c02 100644 --- a/examples/miniapps/api_client/models.py +++ b/examples/miniapps/api_client/models.py @@ -1,7 +1,7 @@ -"""TBD.""" +"""Models module.""" -class User(object): +class User: """User model.""" def __init__(self, id, api_client): diff --git a/examples/miniapps/api_client/tests.py b/examples/miniapps/api_client/tests.py index 4619679d..c304e6b0 100644 --- a/examples/miniapps/api_client/tests.py +++ b/examples/miniapps/api_client/tests.py @@ -1,6 +1,6 @@ -"""TBD.""" +"""Tests module.""" -from mock import Mock +from unittest.mock import Mock import main import api diff --git a/examples/miniapps/bundles/bundles/photos/entities.py b/examples/miniapps/bundles/bundles/photos/entities.py index 173ace39..f93b9f22 100644 --- a/examples/miniapps/bundles/bundles/photos/entities.py +++ b/examples/miniapps/bundles/bundles/photos/entities.py @@ -1,5 +1,5 @@ """Photos bundle entities module.""" -class Photo(object): +class Photo: """Photo entity.""" diff --git a/examples/miniapps/bundles/bundles/photos/repositories.py b/examples/miniapps/bundles/bundles/photos/repositories.py index b8ec453f..229b907e 100644 --- a/examples/miniapps/bundles/bundles/photos/repositories.py +++ b/examples/miniapps/bundles/bundles/photos/repositories.py @@ -1,7 +1,7 @@ """Photos bundle entity repositories module.""" -class PhotoRepository(object): +class PhotoRepository: """Photo entity repository.""" def __init__(self, object_factory, fs, db): diff --git a/examples/miniapps/bundles/bundles/users/entities.py b/examples/miniapps/bundles/bundles/users/entities.py index 258bec0a..399b3164 100644 --- a/examples/miniapps/bundles/bundles/users/entities.py +++ b/examples/miniapps/bundles/bundles/users/entities.py @@ -1,7 +1,7 @@ """Users bundle entities module.""" -class User(object): +class User: """User entity.""" def __init__(self, id): diff --git a/examples/miniapps/bundles/bundles/users/repositories.py b/examples/miniapps/bundles/bundles/users/repositories.py index 8d561c85..cf4ad06b 100644 --- a/examples/miniapps/bundles/bundles/users/repositories.py +++ b/examples/miniapps/bundles/bundles/users/repositories.py @@ -1,7 +1,7 @@ """Users bundle entity repositories module.""" -class UserRepository(object): +class UserRepository: """User entity repository.""" def __init__(self, object_factory, db): diff --git a/examples/miniapps/engines_cars/example/cars.py b/examples/miniapps/engines_cars/example/cars.py index 0f6265cb..c82361f1 100644 --- a/examples/miniapps/engines_cars/example/cars.py +++ b/examples/miniapps/engines_cars/example/cars.py @@ -1,7 +1,7 @@ """Dependency injection example, cars module.""" -class Car(object): +class Car: """Example car.""" def __init__(self, engine): diff --git a/examples/miniapps/engines_cars/example/engines.py b/examples/miniapps/engines_cars/example/engines.py index 8e42ec1d..9cdfd357 100644 --- a/examples/miniapps/engines_cars/example/engines.py +++ b/examples/miniapps/engines_cars/example/engines.py @@ -1,7 +1,7 @@ """Dependency injection example, engines module.""" -class Engine(object): +class Engine: """Example engine base class. Engine is a heart of every car. Engine is a very common term and could be @@ -17,5 +17,5 @@ class DieselEngine(Engine): """Diesel engine.""" -class ElectroEngine(Engine): - """Electro engine.""" +class ElectricEngine(Engine): + """Electric engine.""" diff --git a/examples/miniapps/engines_cars/example_di.py b/examples/miniapps/engines_cars/example_di.py index 317d7d8f..fe5912d8 100644 --- a/examples/miniapps/engines_cars/example_di.py +++ b/examples/miniapps/engines_cars/example_di.py @@ -7,4 +7,4 @@ import example.engines if __name__ == '__main__': gasoline_car = example.cars.Car(example.engines.GasolineEngine()) diesel_car = example.cars.Car(example.engines.DieselEngine()) - electro_car = example.cars.Car(example.engines.ElectroEngine()) + electric_car = example.cars.Car(example.engines.ElectricEngine()) diff --git a/examples/miniapps/engines_cars/example_ioc_containers.py b/examples/miniapps/engines_cars/example_ioc_containers.py index b97ab121..7edda6d2 100644 --- a/examples/miniapps/engines_cars/example_ioc_containers.py +++ b/examples/miniapps/engines_cars/example_ioc_containers.py @@ -14,7 +14,7 @@ class Engines(containers.DeclarativeContainer): diesel = providers.Factory(example.engines.DieselEngine) - electro = providers.Factory(example.engines.ElectroEngine) + electric = providers.Factory(example.engines.ElectricEngine) class Cars(containers.DeclarativeContainer): @@ -26,11 +26,11 @@ class Cars(containers.DeclarativeContainer): diesel = providers.Factory(example.cars.Car, engine=Engines.diesel) - electro = providers.Factory(example.cars.Car, - engine=Engines.electro) + electric = providers.Factory(example.cars.Car, + engine=Engines.electric) if __name__ == '__main__': gasoline_car = Cars.gasoline() diesel_car = Cars.diesel() - electro_car = Cars.electro() + electric_car = Cars.electric() diff --git a/examples/miniapps/mail_service/example.py b/examples/miniapps/mail_service/example.py index 08f1eb8a..0703e476 100644 --- a/examples/miniapps/mail_service/example.py +++ b/examples/miniapps/mail_service/example.py @@ -1,7 +1,7 @@ """Mail service and user registration example.""" -class AbstractMailService(object): +class AbstractMailService: """Abstract mail service.""" def send(self, email, body): diff --git a/examples/miniapps/movie_lister/movies/finders.py b/examples/miniapps/movie_lister/movies/finders.py index f09e106c..557dcbdb 100644 --- a/examples/miniapps/movie_lister/movies/finders.py +++ b/examples/miniapps/movie_lister/movies/finders.py @@ -6,11 +6,11 @@ This module contains all finder implementations. import csv -class MovieFinder(object): +class MovieFinder: """Movie finder component. Movie finder component is responsible for fetching movies data from - different storages. + various storage. """ def __init__(self, movie_model): @@ -47,7 +47,7 @@ class CsvMovieFinder(MovieFinder): """ self._csv_file_path = csv_file_path self._delimiter = delimiter - super(CsvMovieFinder, self).__init__(movie_model) + super().__init__(movie_model) def find_all(self): """Return all found movies. @@ -73,7 +73,7 @@ class SqliteMovieFinder(MovieFinder): :type database: sqlite3.Connection """ self._database = database - super(SqliteMovieFinder, self).__init__(movie_model) + super().__init__(movie_model) def find_all(self): """Return all found movies. diff --git a/examples/miniapps/movie_lister/movies/listers.py b/examples/miniapps/movie_lister/movies/listers.py index 5d4d88fb..f00b22ba 100644 --- a/examples/miniapps/movie_lister/movies/listers.py +++ b/examples/miniapps/movie_lister/movies/listers.py @@ -4,7 +4,7 @@ This module contains all lister implementations. """ -class MovieLister(object): +class MovieLister: """Movie lister component. Movie lister component provides several methods for filtering movies by diff --git a/examples/miniapps/movie_lister/movies/models.py b/examples/miniapps/movie_lister/movies/models.py index e0371d5d..c42d6903 100644 --- a/examples/miniapps/movie_lister/movies/models.py +++ b/examples/miniapps/movie_lister/movies/models.py @@ -4,7 +4,7 @@ This module contains all model implementations. """ -class Movie(object): +class Movie: """Base movie model.""" def __init__(self, name, year, director): diff --git a/examples/miniapps/password_hashing/example.py b/examples/miniapps/password_hashing/example.py index 1f9cd957..ac481c1f 100644 --- a/examples/miniapps/password_hashing/example.py +++ b/examples/miniapps/password_hashing/example.py @@ -6,7 +6,7 @@ import dependency_injector.containers as containers import dependency_injector.providers as providers -class UsersService(object): +class UsersService: """Users service.""" def __init__(self, password_hasher): diff --git a/examples/miniapps/services_v1/example/services.py b/examples/miniapps/services_v1/example/services.py index 60f7a5cc..04206916 100644 --- a/examples/miniapps/services_v1/example/services.py +++ b/examples/miniapps/services_v1/example/services.py @@ -1,7 +1,7 @@ """Example business services module.""" -class BaseService(object): +class BaseService: """Service base class.""" diff --git a/examples/miniapps/services_v2/example/services.py b/examples/miniapps/services_v2/example/services.py index 60f7a5cc..04206916 100644 --- a/examples/miniapps/services_v2/example/services.py +++ b/examples/miniapps/services_v2/example/services.py @@ -1,7 +1,7 @@ """Example business services module.""" -class BaseService(object): +class BaseService: """Service base class.""" diff --git a/examples/miniapps/use_cases/example/adapters.py b/examples/miniapps/use_cases/example/adapters.py index 8b9312c9..d940cf0a 100644 --- a/examples/miniapps/use_cases/example/adapters.py +++ b/examples/miniapps/use_cases/example/adapters.py @@ -1,7 +1,7 @@ """Example adapters package.""" -class EmailSender(object): +class EmailSender: """Abstract email sender.""" def send(self, to, body): @@ -9,7 +9,7 @@ class EmailSender(object): raise NotImplementedError() -class SmtpEmailSender(object): +class SmtpEmailSender: """SMTP email sender uses SMTP protocol for sending emails.""" def send(self, to, body): @@ -17,7 +17,7 @@ class SmtpEmailSender(object): # Send email via SMTP -class EchoEmailSender(object): +class EchoEmailSender: """Echo email sender prints emails to stdout.""" def send(self, to, body): diff --git a/examples/miniapps/use_cases/example/use_cases.py b/examples/miniapps/use_cases/example/use_cases.py index 1cd8f144..4946ae46 100644 --- a/examples/miniapps/use_cases/example/use_cases.py +++ b/examples/miniapps/use_cases/example/use_cases.py @@ -1,7 +1,7 @@ """Example use cases package.""" -class UseCase(object): +class UseCase: """Abstract use case.""" def execute(self): @@ -9,7 +9,7 @@ class UseCase(object): raise NotImplementedError() -class SignupUseCase(object): +class SignupUseCase: """Sign up use cases registers users.""" def __init__(self, email_sender): diff --git a/examples/providers/abstract_factory/cache.py b/examples/providers/abstract_factory/cache.py index 751e03af..51cdc3c2 100644 --- a/examples/providers/abstract_factory/cache.py +++ b/examples/providers/abstract_factory/cache.py @@ -1,7 +1,7 @@ """Example hierarchy of cache clients with abstract base class.""" -class AbstractCacheClient(object): +class AbstractCacheClient: """Abstract cache client.""" diff --git a/examples/providers/custom_factory.py b/examples/providers/custom_factory.py index f890a585..01c17425 100644 --- a/examples/providers/custom_factory.py +++ b/examples/providers/custom_factory.py @@ -3,7 +3,7 @@ import dependency_injector.providers as providers -class User(object): +class User: """Example class User.""" @@ -15,7 +15,7 @@ class UsersFactory(providers.Provider): def __init__(self): """Initialize instance.""" self._factory = providers.Factory(User) - super(UsersFactory, self).__init__() + super().__init__() def __call__(self, *args, **kwargs): """Return provided object. diff --git a/examples/providers/dependency.py b/examples/providers/dependency.py index 987e39d9..a96aa58d 100644 --- a/examples/providers/dependency.py +++ b/examples/providers/dependency.py @@ -6,7 +6,7 @@ import contextlib import dependency_injector.providers as providers -class UsersService(object): +class UsersService: """Example class UsersService. UsersService has dependency on DBAPI 2.0 database connection. diff --git a/examples/providers/factory_aggregate/games.py b/examples/providers/factory_aggregate/games.py index 3900ac9d..aa9e7a8a 100644 --- a/examples/providers/factory_aggregate/games.py +++ b/examples/providers/factory_aggregate/games.py @@ -1,7 +1,7 @@ """Example games module.""" -class Game(object): +class Game: """Base game class.""" def __init__(self, player1, player2): diff --git a/examples/providers/factory_aggregate/prototype.py b/examples/providers/factory_aggregate/prototype.py index 799d1905..930a3159 100644 --- a/examples/providers/factory_aggregate/prototype.py +++ b/examples/providers/factory_aggregate/prototype.py @@ -1,7 +1,7 @@ """FactoryAggregate provider prototype.""" -class FactoryAggregate(object): +class FactoryAggregate: """FactoryAggregate provider prototype.""" def __init__(self, **factories): diff --git a/examples/providers/factory_delegation.py b/examples/providers/factory_delegation.py index fd19a119..64ce36ce 100644 --- a/examples/providers/factory_delegation.py +++ b/examples/providers/factory_delegation.py @@ -8,7 +8,7 @@ import dependency_injector.providers as providers Photo = collections.namedtuple('Photo', []) -class User(object): +class User: """Example user model.""" def __init__(self, photos_factory): diff --git a/examples/providers/factory_provided_type.py b/examples/providers/factory_provided_type.py index 4e4d645c..8009300f 100644 --- a/examples/providers/factory_provided_type.py +++ b/examples/providers/factory_provided_type.py @@ -4,7 +4,7 @@ import dependency_injector.providers as providers import dependency_injector.errors as errors -class BaseService(object): +class BaseService: """Base service class.""" diff --git a/examples/providers/overriding_simple.py b/examples/providers/overriding_simple.py index 77a5a6d0..96533d2c 100644 --- a/examples/providers/overriding_simple.py +++ b/examples/providers/overriding_simple.py @@ -3,7 +3,7 @@ import dependency_injector.providers as providers -class User(object): +class User: """Example class User.""" diff --git a/examples/providers/overriding_users_model.py b/examples/providers/overriding_users_model.py index ca415a4c..7af62069 100644 --- a/examples/providers/overriding_users_model.py +++ b/examples/providers/overriding_users_model.py @@ -3,23 +3,23 @@ import dependency_injector.providers as providers -class User(object): +class User: """Example class User.""" def __init__(self, id, password): """Initialize instance.""" self.id = id self.password = password - super(User, self).__init__() + super().__init__() -class UsersService(object): +class UsersService: """Example class UsersService.""" def __init__(self, user_cls): """Initialize instance.""" self.user_cls = user_cls - super(UsersService, self).__init__() + super().__init__() def get_by_id(self, id): """Find user by his id and return user model.""" @@ -56,7 +56,7 @@ class ExtendedUser(User): self.first_name = first_name self.last_name = last_name self.gender = gender - super(ExtendedUser, self).__init__(id, password) + super().__init__(id, password) class ExtendedUsersService(UsersService): diff --git a/examples/providers/singleton_provided_type.py b/examples/providers/singleton_provided_type.py index 517744ca..1402fd5c 100644 --- a/examples/providers/singleton_provided_type.py +++ b/examples/providers/singleton_provided_type.py @@ -4,7 +4,7 @@ import dependency_injector.providers as providers import dependency_injector.errors as errors -class BaseService(object): +class BaseService: """Base service class."""