pypowsybl.network.Network.add_aliases

Network.add_aliases(df=None, **kwargs)

Adds aliases to network elements.

An alias is a reference to a network element. For example, to get or to update an element, his alias may be used instead of his id. An alias may be associated with a type, to distinguish it from other aliases.

Parameters:

• df (DataFrame | None) – Attributes as a dataframe.

• kwargs (_SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]) – Attributes as keyword arguments.

Return type:

None

Notes

Data may be provided as a dataframe or as keyword arguments. In the latter case, all arguments must have the same length.

Valid attributes are:

• id: the identifier of the network element associated to the alias

• alias: name of the alias

• alias_type: type of the alias (optional)

Examples

network.add_aliases(id='element_id', alias='alias_id')
network.add_aliases(id='element_id', alias='alias_id', alias_type='alias_type')