Release v0.5.0 #48
Merged
Release v0.5.0 #48
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
The class Edge does not inherit from Node anymore, instead the former class Node is renamed to Entity. (This name was present before but deleted by now.) To keep the graph structure, a new class Node also inherits from Entity - without adding further functionality. This way, everything works as before but clean graph theoretic language is preserved.
Entity is the mother class of Node and Edge, but instances of Node shoukd not be used. Thus, it should be in the sence of comprehensability to name Bus, Component, and Edge directly.
Asserts are meant for debugging. If a check should be there for end users an if/raise statement is the way to go.
The import aliases where rarely used and thus more confusing than helpful.
The import aliases where rarely used and thus more confusing than helpful.
It makes sense to be precise if objects are Nodes, Edges, or Entities. As the documentation mixes them (Edges were Nodes before), I tried to figure or by reverse engeneering using solph.
According to https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html, there needs to be exactly one '%s' in every string in the config.
Fix/docs
As Entity.registry is deprecated anyway, this decorator should also go.
Automatic registration of `Node`s was deprecated, so I removed it. There still was a ToDo note how to improve it. I also deleted that one.
Adhere to graph language
The setter is problably unused, and I do not see a test for it. As I do not see a use case, I propose to delete it.
Make energy_system.nodes a dict
Remove __slots__ and corresponding test
The error was not tested for because an error was risen before.
Make kwargs explicit
network.Bus is deprecated. Using it causes a warning.
Require label of Node to be given
The version we use until now (v2) is deprecated and depends on old Javascript, as far as I understand. Support will be dropped soon.
Move to setup-python@v5
Double use of the name es also caused an error being hard to detect.
Improve warnings, e.g. add warning for experimental node access API and fix other warnings that are not meaningful for the user.
Release v0.5 * Improved code quality * Add Entity.custom_properties * Simplify node access (experimental: energy_system.node[label]) * Make keyword arguments explicit
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.
Release v0.5