Revision/explicit network kwargs #1032

p-snft · 2023-12-15T19:59:19Z

Adapt to explicitly named arguments in oemof.network. Will need to be merged before the next release of network due to oemof/oemof-network#40.

The changes also reveals some undiscovered bugs (mostly ignored parameters). This commit does not address these. So, it is expected that tests fail.

These labels were just ignored. With explicit kwargs, they cause errors.

At least in the latest versions, the keyword was just ignored. With explicitly named arguments only, it causes errors.

This parameter was unused and will cause errors with explicit keyword arguments.

The warnings need the network.Node to be initialised already.

pep8speaks · 2023-12-15T19:59:33Z

Hello @p-snft! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2023-12-22 12:57:10 UTC

To access e.g. .label, warn_ helpers need oemof.network.Entity to be initialised first.

p-snft · 2023-12-19T08:48:26Z

When using the branch aimed to be merged in oemof/oemof-network#40, I locally observe an issues I do not understand, yet:

tests/test_scripts/test_solph/test_lopf/test_lopf.py:112: in test_lopf
    om = Model(es)
src/oemof/solph/_models.py:386: in __init__
    super().__init__(energysystem, **kwargs)
src/oemof/solph/_models.py:151: in __init__
    self.flows = self.es.flows()
../network/src/oemof/network/energy_system.py:205: in flows
    return {
../network/src/oemof/network/energy_system.py:208: in <dictcomp>
    for target in source.outputs
E   AttributeError: 'ElectricalLine' object has no attribute 'outputs'

I do not see why this should be an error. ElectricalLine is a special Flow, and as such should not have outputs.

The label seems to be set to allow calling workaround before Node is initialised.

ElectricalLine seems to be added to the EnergySystem as if it was a Node. This, however, is no longer possible as Flows do not have 'inputs'.

p-snft · 2023-12-19T10:23:04Z

I do not see why this should be an error. ElectricalLine is a special Flow, and as such should not have outputs.

This is because the ElectricalLine is added to the EnergySystem. I changed this but also deactivated the test as the constraints are not built if it's not added as a Node. It's marked experimental, anyway.

p-snft · 2023-12-19T13:01:15Z

Coverage decreases because experimental ElectricalLine is no longer tested. (It is broken.)

nailend · 2024-03-01T16:05:39Z

src/oemof/solph/components/_converter.py

@@ -117,8 +113,12 @@ def __init__(
            label=label,
            inputs=inputs,
            outputs=outputs,
-            **custom_attributes,
+            custom_properties=custom_attributes,


@p-snft why aren't these parameter-names aligned? I guess it started here. Wouldn't it be best to change in oemof.network to custom_attributes as well, especially as custom-attributes are frequently used in the oemof-tabular API?!

In Python, an attribute is a fixed term referring to a variable defined by the class in the scope of an object. The implementation that some though we had (but never had) in network added attributes

my_node = Node("name", some_feature= 5) # API was never implemented my_node.some_feature # "some_feature" is an attribute, API was never implemented # 5

However, the API now is

my_node = Node("name", custom_properties={"some_feature": 5}) my_node.custom_properties["some_feature"] # "some feature" is not an attribute # 5

well custom_properties is an attribute though 😆

p-snft added 9 commits December 15, 2023 20:11

Adapt to explicit kwargs in oemof.network

89c0755

The changes also reveals some undiscovered bugs (mostly ignored parameters). This commit does not address these. So, it is expected that tests fail.

Remove label from EnergySystem

53fb744

These labels were just ignored. With explicit kwargs, they cause errors.

Delete timemode="explicit" from EnergySystem tests

c2017d9

At least in the latest versions, the keyword was just ignored. With explicitly named arguments only, it causes errors.

Move to explicit kwargs for GenericCAES

0546667

Remove out_breakpoints from PiecewiseLinearConverter test

64558a0

This parameter was unused and will cause errors with explicit keyword arguments.

Switch to explicit named arguments for ElectricalBus

725ea78

Fix handing Converter's custom_attributes to network.Node

8332e93

Fix initialisation of Link

8cb2cf1

The warnings need the network.Node to be initialised already.

Fix handing custom_properties of GenericStorage to network.Node

8ead2b3

p-snft mentioned this pull request Dec 15, 2023

Make kwargs explicit oemof/oemof-network#40

Merged

p-snft and others added 3 commits December 15, 2023 21:07

Adhere to Black

213b164

Maintain compatibility with network v0.5.0a5

523654a

Fix inialisation of link class

b403712

To access e.g. .label, warn_ helpers need oemof.network.Entity to be initialised first.

p-snft added 2 commits December 19, 2023 10:21

Do not double-set label in Converter

84693dd

The label seems to be set to allow calling workaround before Node is initialised.

Dactivate ElectricalLine test

3196ef7

ElectricalLine seems to be added to the EnergySystem as if it was a Node. This, however, is no longer possible as Flows do not have 'inputs'.

Adhere to Black

f8131da

p-snft force-pushed the revision/explicit_network_kwargs branch from 646fb82 to f8131da Compare December 19, 2023 10:24

p-snft marked this pull request as ready for review December 19, 2023 13:00

Merge branch 'dev' into revision/explicit_network_kwargs

7afda8d

p-snft requested a review from a team December 22, 2023 13:01

p-snft merged commit 3ad2fe2 into dev Jan 12, 2024
12 checks passed

p-snft deleted the revision/explicit_network_kwargs branch January 12, 2024 09:23

henhuy mentioned this pull request Jan 18, 2024

Breaking changes due to oemof.network v.0.5.0 oemof/oemof-tabular#150

Open

richartkeil mentioned this pull request Mar 1, 2024

Using custom_attributes of Source and Sink classes fails #1059

Closed

nailend reviewed Mar 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revision/explicit network kwargs #1032

Revision/explicit network kwargs #1032

p-snft commented Dec 15, 2023 •

edited

Loading

pep8speaks commented Dec 15, 2023 •

edited

Loading

p-snft commented Dec 19, 2023

p-snft commented Dec 19, 2023

p-snft commented Dec 19, 2023 •

edited

Loading

nailend Mar 1, 2024 •

edited

Loading

p-snft Mar 6, 2024

nailend Mar 6, 2024

Revision/explicit network kwargs #1032

Revision/explicit network kwargs #1032

Conversation

p-snft commented Dec 15, 2023 • edited Loading

pep8speaks commented Dec 15, 2023 • edited Loading

Comment last updated at 2023-12-22 12:57:10 UTC

p-snft commented Dec 19, 2023

p-snft commented Dec 19, 2023

p-snft commented Dec 19, 2023 • edited Loading

nailend Mar 1, 2024 • edited Loading

Choose a reason for hiding this comment

p-snft Mar 6, 2024

Choose a reason for hiding this comment

nailend Mar 6, 2024

Choose a reason for hiding this comment

p-snft commented Dec 15, 2023 •

edited

Loading

pep8speaks commented Dec 15, 2023 •

edited

Loading

p-snft commented Dec 19, 2023 •

edited

Loading

nailend Mar 1, 2024 •

edited

Loading