Add Metadata to every Maintenance, addresses issue #246 #249
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
Co-authored-by: Glenn Matthews <[email protected]>
Co-authored-by: Glenn Matthews <[email protected]>
chadell
requested review from
glennmatthews,
pke11y,
scetron and
jvanderaa
as code owners
nice, I have updated the readme to explain it. |
glennmatthews
previously approved these changes
Nov 20, 2023
Co-authored-by: Glenn Matthews <[email protected]>
csessh
reviewed
Jan 30, 2024
|
|
||
| # Non mandatory attributes | ||
| uid: StrictStr = "0" | ||
| sequence: StrictInt = 1 | ||
| summary: StrictStr = "" | ||
|
|
||
| def __init__(self, **data): | ||
| """Initialize the Maintenance object.""" | ||
| self._metadata = data.pop("_metadata") |
There was a problem hiding this comment.
This throws KeyError if _metadata key isn't present, thus this change becomes a breaking change.
Some of my existing tests used in my projects start to throw KeyError exception. For example:
self = Maintenance()
data = {'account': '12623', 'circuits': [{'circuit_id': '297487', 'impact': 'NO-IMPACT'}], 'end': 1649073600, 'maintenance_id': 'GIN-CHG0042605', ...}
def __init__(self, **data):
"""Initialize the Maintenance object."""
> self._metadata = data.pop("_metadata")
E KeyError: '_metadata'
../../dev/MNA/lib/python3.10/site-packages/circuit_maintenance_parser/output.py:166: KeyError
There was a problem hiding this comment.
It seems like Maintenance dataclass is now expecting _metadata to be supplied by users. can't it default to None?
There was a problem hiding this comment.
thanks @csessh for reporting. I'm going to check and fix.
There was a problem hiding this comment.
checking the code, I see that the _metadata is injected by the Processors automatically, so I don't get why don't you get it in your tests.
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.
The idea is to provide some basic information about how the Maintenance has been generated to allow consumers to take decisions
TODO
Example of the information retrieved via CLI: