Get network elements properties as data frame

[jeandemanged]

Please check if the PR fulfills these requirements

• The commit message follows our guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem?

Related to #894, in part only, please do not close the issue when merging this PR.

What kind of change does this PR introduce?

Feature

What is the current behavior?

• We can get network elements properties only if:
  • we know exactly the properties we are looking for (we know their keys),
  • or, we systematically use all_attributes=True in the get_<element_type> methods, in which case properties are added as columns.
• Also, we cannot get properties of Network objects. (root network and subnetworks)

What is the new behavior (if this is a feature change)?

• new method Network.get_elements_properties, returning a data frame of properties "row-oriented" - to be compared with the get_<element_type> methods returning properties in columns.
  We can also get properties of the network objects with this method

>>> import pypowsybl as pp
>>> network = pp.network.create_eurostag_tutorial_example1_network()
>>> network.get_elements_properties()
Empty DataFrame
Columns: [key, value]
Index: []
>>> network.add_elements_properties(id='sim1', key1='value1', key2='value2')
>>> network.add_elements_properties(id='GEN', key3='value3')
>>> network.get_elements_properties()
           type   key   value
id
sim1    NETWORK  key1  value1
sim1    NETWORK  key2  value2
GEN   GENERATOR  key3  value3

Does this PR introduce a breaking change or deprecate an API?

• No

Other information:

[geofjamg]

@jeandemanged maybe we should add an "element_type" column to the datadrame to make it easy to use/associate with other dataframes ?

[sonarqubecloud]

Quality Gate passed for 'pypowsybl'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[jeandemanged]

@jeandemanged maybe we should add an "element_type" column to the datadrame to make it easy to use/associate with other dataframes ?

Hi @geofjamg,
Indeed
I named the column type for consistency with e.g. get_injections(), get_identificables(), get_branches() - although I am not really comfortable having a python reserved keyword as a column name...
Also added a type column to get_aliases().

[sonarqubecloud]

Quality Gate passed for 'pypowsybl'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud