fix: rework ops.main type hints to allow different flavours (protocol) #1340
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
Contributor
dimaqq
commented
Aug 26, 2024
•
dimaqq
commented
- our project tests
- super-tox
- deprecation docs
dimaqq
force-pushed
the
fix-main-with-deprecation
branch
from
22374b1 to
0e54cf6
Compare
dimaqq
changed the title
dimaqq
force-pushed
the
fix-main-with-deprecation
branch
from
bdcffde to
6cb0d60
Compare
|
Doc build fails with I think it's because there's ops/main and ops/_main both with a docstring. Should we hide the legacy bit doc string? Or is there a way to rename it for docs only? |
|
|
||
| def type_test_dummy(_arg: Callable[[Type[ops.CharmBase], bool], None]): | ||
| """ | ||
| Helper to verify that |
There was a problem hiding this comment.
More words expected?
Comment on lines
+42
to
+44
| class IdleCharm(ops.CharmBase): | ||
| def __init__(self, framework: ops.Framework): | ||
| super().__init__(framework) |
There was a problem hiding this comment.
Why not just use CharmBase?
| from ops.jujucontext import _JujuContext | ||
| from ops.log import setup_root_logging | ||
|
|
||
| CHARM_STATE_FILE = '.unit-state.db' |
There was a problem hiding this comment.
Probably not importable any more?
Comment on lines
-35
to
-37
| from ops.charm import CharmMeta | ||
| from ops.jujucontext import _JujuContext | ||
| from ops.log import setup_root_logging |
There was a problem hiding this comment.
Probably should still be able to import CharmMeta and setup_root_logging.
|
|
||
| """Main entry point to the framework. | ||
|
|
||
| Note that this module is callable, and calls the :func:`ops.main.main` function. |
|
Closing in favour of #1345 |
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.