-
-
Notifications
You must be signed in to change notification settings - Fork 312
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update decoupled-example with abstraction layer #770
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR needs some addition work.
from ..user.repositories import UserRepositoryMeta | ||
|
||
|
||
class AggregationServiceMeta(metaclass=abc.ABCMeta): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
class AggregationServiceMeta(metaclass=abc.ABCMeta): | |
class AggregationService(metaclass=abc.ABCMeta): |
Meta
suffix might give it a wrong impression that this is a metaclass. Let's avoid ambiguous naming.
self.user_repository = user_repository | ||
self.photo_repository = photo_repository | ||
|
||
class AggregationService(AggregationServiceMeta): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
class AggregationService(AggregationServiceMeta): | |
class AggregationServiceImpl(AggregationService): |
or
class AggregationService(AggregationServiceMeta): | |
class MemoryAggregationService(AggregationService): |
See comment above. This way it would be much more clear about implementation specifics of the AggregationService
interface.
def __init__(self, user_repository: UserRepositoryMeta, photo_repository: PhotoRepositoryMeta): | ||
self.user_repository: UserRepositoryMeta = user_repository | ||
self.photo_repository: PhotoRepositoryMeta = photo_repository |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interfaces generally has no __init__
, it's an implementation detail.
def __init__(self, user_repository: UserRepositoryMeta, photo_repository: PhotoRepositoryMeta): | |
self.user_repository: UserRepositoryMeta = user_repository | |
self.photo_repository: PhotoRepositoryMeta = photo_repository |
│ ├── abstraction | ||
│ │ ├── __init__.py | ||
│ │ ├── analytics | ||
│ │ │ ├── __init__.py | ||
│ │ │ └── services.py | ||
│ │ ├── photo | ||
│ │ │ ├── __init__.py | ||
│ │ │ └── repositories.py | ||
│ │ └── user | ||
│ │ ├── __init__.py | ||
│ │ └── repositories.py |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For such simple app example, I'd move everything into interfaces.py
to keep app structure from bloating.
@abc.abstractmethod | ||
def get_photos(self, user_id): | ||
"""Must be implemented in order to instantiate.""" | ||
pass |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pass |
Coverage report treats pass
as a code. Which never executes for abstractmethod
s.
Hi
The decoupled-example code is good, but it lack one important component of DIP rule (https://www.cs.utexas.edu/users/downing/papers/DIP-1996.pdf)
I mean the "Abstraction" layer which can help make "user" and "photo" compliant to abstract classes of their own and "analytics" depends on these abstract classes, and even for "analytics" can be extracted one abstract class, then for main.py (the top-level service aggregation) can only depend on these three abstract class, finally "ApplicationContainer" is for connecting the embodied containers("user", "photo", "analytics") to main.py.
The update code is better to demostrate DIP rule for developer.
I also update docs part.
Please check.
Thanks.