ADR on import structure #8500
Open
ADR on import structure #8500
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| - from that responsibility can be derived its knowledge about the world around it, | ||
| - which in turn drives which other modules it "sees" | ||
| - keep __init__ light, as it is always imported when a submodule is imported. | ||
| - a package can offer an interface module (called now something like `model`/`types`/`__init__`)..... |
There was a problem hiding this comment.
Do we want to add naming guidelines for such interface modules ?
There was a problem hiding this comment.
If you have suggestions?
There was a problem hiding this comment.
What about <package_name>_interface or <package_name>_api?
And do we want to encourage using the __init__.py file more for this or does it contradict with the rule keep __init__ light ?
Is this more a case by case thing where the interface can live in the __init__ if it's not too heavy but it should live in its own file as it grows ?
docs/adr/0004-import-structure.md
Outdated
Comment on lines
60
to
65
| e.g. consider executor and deploy packages and the new_agent | ||
| - executor.executor is the interface package | ||
| - deploy imports executor.executor | ||
| - new_agent import both the interface and concrete implementations of both executor and deploy (top level) | ||
| - deploy doesn't import the non-interface parts of executor because it never constructs executors (it is constructed with a reference to a executor manager, which serves as a factory) | ||
| - executor doesn't know about deploy at all |
There was a problem hiding this comment.
I think some names in this example are outdated which makes it hard to follow
There was a problem hiding this comment.
I also had a hard time following this
Co-authored-by: Hugo-Inmanta <[email protected]>
arnaudsjs
approved these changes
Feb 24, 2025
Hugo-Inmanta
approved these changes
Feb 25, 2025
| - from that responsibility can be derived its knowledge about the world around it, | ||
| - which in turn drives which other modules it "sees" | ||
| - keep __init__ light, as it is always imported when a submodule is imported. | ||
| - a package can offer an interface module (called now something like `model`/`types`/`__init__`)..... |
There was a problem hiding this comment.
What about <package_name>_interface or <package_name>_api?
And do we want to encourage using the __init__.py file more for this or does it contradict with the rule keep __init__ light ?
Is this more a case by case thing where the interface can live in the __init__ if it's not too heavy but it should live in its own file as it grows ?
Comment on lines
+60
to
+66
| e.g. consider `inmanta.agent.executor.executor` and `inmanta.deploy` packages and the new_agent | ||
| - `inmanta.agent.executor.executor` is the interface package for the executor framework | ||
| - `inmanta.deploy` is the package containing the scheduler (it has no external interface package) | ||
| - `inmanta.deploy` imports `inmanta.agent.executor.executor` | ||
| - `inmanta.agent.agent_new` imports both the interface and concrete implementations of both executor and deploy (top level) | ||
| - `inmanta.deploy` doesn't import the non-interface parts of `inmanta.agent.executor.executor` because it never constructs executors (it is constructed with a reference to a executor manager, which serves as a factory) | ||
| - `inmanta.agent.executor.executor` doesn't know about deploy at all |
There was a problem hiding this comment.
Suggested change
| e.g. consider `inmanta.agent.executor.executor` and `inmanta.deploy` packages and the new_agent | |
| - `inmanta.agent.executor.executor` is the interface package for the executor framework | |
| - `inmanta.deploy` is the package containing the scheduler (it has no external interface package) | |
| - `inmanta.deploy` imports `inmanta.agent.executor.executor` | |
| - `inmanta.agent.agent_new` imports both the interface and concrete implementations of both executor and deploy (top level) | |
| - `inmanta.deploy` doesn't import the non-interface parts of `inmanta.agent.executor.executor` because it never constructs executors (it is constructed with a reference to a executor manager, which serves as a factory) | |
| - `inmanta.agent.executor.executor` doesn't know about deploy at all | |
| e.g. consider `inmanta.agent.executor` and `inmanta.deploy` packages and the new_agent | |
| - `inmanta.agent.executor` is the interface package for the executor framework | |
| - `inmanta.deploy` is the package containing the scheduler (it has no external interface package) | |
| - `inmanta.deploy.scheduler` imports `inmanta.agent.executor` | |
| - `inmanta.agent.agent_new` imports both the interface and concrete implementations of both executor and deploy (top level) | |
| - `inmanta.deploy.scheduler` doesn't import the non-interface parts of `inmanta.agent.executor` because it never constructs executors (They are constructed with a reference to a executor manager, which serves as a factory) | |
| - `inmanta.agent.executor` doesn't know about deploy at all |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Self Check:
Strike through any lines that are not applicable (
~~line~~) then check the box