refactor: upgrade CA-SK with event classes #6013
Merged
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
VIKTORVAV99
reviewed
Oct 15, 2023
parsers/CA_SK.py
Outdated
| target_datetime: datetime | None, | ||
| url: str, | ||
| zone_key: ZoneKey, | ||
| ) -> typing.Any: |
There was a problem hiding this comment.
Since we are returning json the type should be list | dict | None, which makes the type checking a little bit better.
It's possible we can even omit None.
There was a problem hiding this comment.
I didn't want to restrict the return types because a JSON payload could feasibly be a bool, float, int, or str as well. In fact, while the production URL returns a dict, judging from the existing parser, the consumption source seems to return a str (it's hard to be sure while it's down). How about this?
Suggested change
| ) -> typing.Any: | |
| ) -> dict | str: |
kruschk
commented
Oct 16, 2023
kruschk
commented
Oct 16, 2023
96 tasks
kruschk
force-pushed
the
kruschk/6011-ca-sk
branch
from
130948b
to
c20e9c1
Compare
VIKTORVAV99
reviewed
Oct 19, 2023
kruschk
force-pushed
the
kruschk/6011-ca-sk
branch
from
1f2394a
to
37bc7d6
Compare
Upgrade the parser to use the ProductionBreakdown, ProductionMix, TotalConsumption, and ZoneKey classes. This should yield no functional change. Note that this does not resolve the current issue with the fetch_consumption function. Additionally: - Comply with Black's 88-column default line length limit. - Factor out duplicate code. Refs: electricitymaps#5986, electricitymaps#6011, electricitymaps#6013
- Be more specific about the return type of the _request function. - Import the Any type directly. - Swap out pytz in exchange for zoneinfo. - Use the ProductionMix.add_value method instead of a dictionary comprehension. Refs: electricitymaps#5986, electricitymaps#6011, electricitymaps#6013
Swap out TotalConsumption for TotalConsumptionList, as the former is considered an implementation detail while the latter is part of the public API. Refs: electricitymaps#5986, electricitymaps#6011, electricitymaps#6013
kruschk
force-pushed
the
kruschk/6011-ca-sk
branch
from
37bc7d6
to
4a60f16
Compare
VIKTORVAV99
approved these changes
Oct 25, 2023
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.
Issue
#5986, #6011
Description
Upgrade the parser to use the
ProductionBreakdown,ProductionMix,TotalConsumption, andZoneKeyclasses. This should yield no functional change. Note that this does not resolve the current issue with thefetch_consumptionfunction. Additionally:Double check
poetry run test_parser "zone_key"pnpx prettier --write .andpoetry run formatto format my changes.