refactor: introduce naming conventions#1028
Merged
lkstrp merged 13 commits intoPyPSA:masterfrom Sep 26, 2024
Merged
Conversation
Contributor
|
love it ❤️ I always have the feeling that |
Member
|
Yes, please! Agree with @FabianHofmann about “varying” |
lkstrp
changed the title
network -> n
Member
Author
|
@fneum @FabianHofmann
|
FabianHofmann
approved these changes
Sep 25, 2024
cpschau
pushed a commit
to cpschau/PyPSA
that referenced
this pull request
Sep 27, 2024
* refactor: naming convention `network` -> `n` * refactor: naming `sub_network` and `sub-network` * refactor: naming `df` -> `static` * refactor: naming `dataframe` -> `df` * refactor: naming `pnl` -> `dynamic` * ignore linopy in type checking * docs: add release notes * fix: pre-commit * make dataclasses more robust * fix: missed pnl * fix docs * add some more deprecation decorators * fix type ignore
lkstrp
added a commit
that referenced
this pull request
Oct 1, 2024
* draft generator constraint * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * extension by p_sum_min and p_sum_max * refactor: introduce naming conventions (#1028) * refactor: naming convention `network` -> `n` * refactor: naming `sub_network` and `sub-network` * refactor: naming `df` -> `static` * refactor: naming `dataframe` -> `df` * refactor: naming `pnl` -> `dynamic` * ignore linopy in type checking * docs: add release notes * fix: pre-commit * make dataclasses more robust * fix: missed pnl * fix docs * add some more deprecation decorators * fix type ignore * add 4 kA high-temperature low-sag (HTLS) line type (#1046) * add 4 kA high-temperature low-sag (HTLS) line type Based on data from JAO Static Grid Model. * Updated description in the user-guide: components.rst. --------- Co-authored-by: bobbyxng <[email protected]> * changed attribute name from p_sum to e_sum; added consistency check; added docstrings * rename constraint function; add tests * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Apply suggestions from code review Co-authored-by: Lukas Trippe <[email protected]> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add test with snapshots * docstring and indexing * resolve comments --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Lukas Trippe <[email protected]> Co-authored-by: Tom Brown <[email protected]> Co-authored-by: bobbyxng <[email protected]>
17 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Start to introduce common naming convention. This one changes all
network(and related, like_parent) ton.Since most of it is network object internal anyway, the API changes are pretty minor. But if the decorator is used, it's also backwards compatible with a
DeprecationWarning.If you agree and this is what you have in mind for a common naming conventions, next up is:
network->nsub_n,sn,sub->sub_networksubnetwork(docs) ->sub-networksnapshots->sns&snapshotsin apiComponent(class) ->ccls_name,class_name->c_namelist_name->c_list_namep,q,p_nom->attrdataframe->dfdf->staticpnl,varying,seriesetc ->dynamicFeel free to add more