Primitives, enum and CIM_datatype

[HUG0-D]

Enum classes

Correctly defining classes with defined values, using Enum. (Issue: #38 )
Examples: UnitSymbol or UnitMultiplier

Primitives classes

The current model generates classes for primitives, which are then rarely used to define the other classes.
Instead of creating individual classes for each primitives, a generic Primitive class is created.
Examples:
Float = Primitive(name="Float", type=float, profiles=[Profile.EQBD, Profile.OP, Profile.SSH, Profile.EQ, Profile.DY, Profile.DL, Profile.SV, Profile.SC, ])

Common CIMDatatype class

The current model generates datatypes that are then never used in the cim classes (example: CurrentFlow).
Instead of creating multiple unused classes with the same attributes (multiplier, unit, value), this pr creates a generic CIMDatatype class. (Issue: #38 )
Examples:
CurrentFlow = CIMDatatype(name="CurrentFlow", type=float, symbol=UnitSymbol.A, multiplier=UnitMultiplier.none, profiles=[Profile.SSH,Profile.EQ,Profile.SV,Profile.SC,])

Annotation of the data type

As said above, the newly created datatypes are added as annotation (data_type) when creating the other classes.

@dataclass
class CurrentLimit(OperationalLimit):
    """
    Operational limit on current.

    normalValue: The normal value for limit on current flow. The attribute shall be a positive value or zero.
    value: Limit on current flow. The attribute shall be a positive value or zero.
    """

    normalValue : float = Field(default=0.0, data_type = CurrentFlow, json_schema_extra={"in_profiles":[Profile.EQ, ]}) 

    value : float = Field(default=0.0, data_type = CurrentFlow, json_schema_extra={"in_profiles":[Profile.SSH, ]}) 



    @cached_property
    def possible_profiles(self)->set[BaseProfile]:
        """
        A resource can be used by multiple profiles. This is the set of profiles
        where this element can be found.
        """
        return { Profile.EQ, Profile.SSH,  }

[m-mirz]

This is fine apart from the failing formatting check. Thanks!

[chicco785]

@HUG0-D not necessarily linked to this PR, but it seems we have lot of annotations that may be redundant in attributes:

"""
Generated from the CGMES files via cimgen: https://github.com/sogno-platform/cimgen
"""

from functools import cached_property
from typing import Optional

from pydantic import Field
from pydantic.dataclasses import dataclass

from ..utils.profile import BaseProfile, Profile
from .Conductor import Conductor
from .Conductance import Conductance
from .Susceptance import Susceptance
from .Resistance import Resistance
from .Reactance import Reactance
from .Temperature import Temperature


@dataclass
class ACLineSegment(Conductor):
    """
    A wire or combination of wires, with consistent electrical characteristics, building a single electrical system,
      used to carry alternating current between points in the power system. For symmetrical, transposed 3ph lines,
      it is sufficient to use  attributes of the line segment, which describe impedances and admittances for the
      entire length of the segment.  Additionally impedances can be computed by using length and associated per
      length impedances. The BaseVoltage at the two ends of ACLineSegments in a Line shall have the same
      BaseVoltage.nominalVoltage. However, boundary lines  may have slightly different BaseVoltage.nominalVoltages
      and  variation is allowed. Larger voltage difference in general requires use of an equivalent branch.

    b0ch: Zero sequence shunt (charging) susceptance, uniformly distributed, of the entire line section.
    bch: Positive sequence shunt (charging) susceptance, uniformly distributed, of the entire line section.  This value
      represents the full charging over the full length of the line.
    g0ch: Zero sequence shunt (charging) conductance, uniformly distributed, of the entire line section.
    gch: Positive sequence shunt (charging) conductance, uniformly distributed, of the entire line section.
    r: Positive sequence series resistance of the entire line section.
    r0: Zero sequence series resistance of the entire line section.
    shortCircuitEndTemperature: Maximum permitted temperature at the end of SC for the calculation of minimum short-
      circuit currents. Used for short circuit data exchange according to IEC 60909
    x: Positive sequence series reactance of the entire line section.
    x0: Zero sequence series reactance of the entire line section.
    """

    b0ch: float = Field(
        default=0.0,
        json_schema_extra={
            "in_profiles": [
                Profile.EQ,
            ],
            "is_used": True,
            "is_class_attribute": False,
            "is_enum_attribute": False,
            "is_list_attribute": False,
            "is_primitive_attribute": False,
            "is_cim_datatype": True,
            "cim_data_type": Susceptance,
		},
    )

    bch: float = Field(
        default=0.0,
        json_schema_extra={
            "in_profiles": [
                Profile.EQ,
            ],
            "is_used": True,
            "is_class_attribute": False,
            "is_enum_attribute": False,
            "is_list_attribute": False,
            "is_primitive_attribute": False,
            "is_cim_datatype": True,
            "cim_data_type": Susceptance,
		},
    )

    g0ch: float = Field(
        default=0.0,
        json_schema_extra={
            "in_profiles": [
                Profile.EQ,
            ],
            "is_used": True,
            "is_class_attribute": False,
            "is_enum_attribute": False,
            "is_list_attribute": False,
            "is_primitive_attribute": False,
            "is_cim_datatype": True,
            "cim_data_type": Conductance,
		},
    )

    gch: float = Field(
        default=0.0,
        json_schema_extra={
            "in_profiles": [
                Profile.EQ,
            ],
            "is_used": True,
            "is_class_attribute": False,
            "is_enum_attribute": False,
            "is_list_attribute": False,
            "is_primitive_attribute": False,
            "is_cim_datatype": True,
            "cim_data_type": Conductance,
		},
    )

    r: float = Field(
        default=0.0,
        json_schema_extra={
            "in_profiles": [
                Profile.EQ,
            ],
            "is_used": True,
            "is_class_attribute": False,
            "is_enum_attribute": False,
            "is_list_attribute": False,
            "is_primitive_attribute": False,
            "is_cim_datatype": True,
            "cim_data_type": Resistance,
		},
    )

    r0: float = Field(
        default=0.0,
        json_schema_extra={
            "in_profiles": [
                Profile.EQ,
            ],
            "is_used": True,
            "is_class_attribute": False,
            "is_enum_attribute": False,
            "is_list_attribute": False,
            "is_primitive_attribute": False,
            "is_cim_datatype": True,
            "cim_data_type": Resistance,
		},
    )

    shortCircuitEndTemperature: float = Field(
        default=0.0,
        json_schema_extra={
            "in_profiles": [
                Profile.EQ,
            ],
            "is_used": True,
            "is_class_attribute": False,
            "is_enum_attribute": False,
            "is_list_attribute": False,
            "is_primitive_attribute": False,
            "is_cim_datatype": True,
            "cim_data_type": Temperature,
		},
    )

    x: float = Field(
        default=0.0,
        json_schema_extra={
            "in_profiles": [
                Profile.EQ,
            ],
            "is_used": True,
            "is_class_attribute": False,
            "is_enum_attribute": False,
            "is_list_attribute": False,
            "is_primitive_attribute": False,
            "is_cim_datatype": True,
            "cim_data_type": Reactance,
		},
    )

    x0: float = Field(
        default=0.0,
        json_schema_extra={
            "in_profiles": [
                Profile.EQ,
            ],
            "is_used": True,
            "is_class_attribute": False,
            "is_enum_attribute": False,
            "is_list_attribute": False,
            "is_primitive_attribute": False,
            "is_cim_datatype": True,
            "cim_data_type": Reactance,
		},
    )

    @cached_property
    def possible_profiles(self) -> set[BaseProfile]:
        """
        A resource can be used by multiple profiles. This is the set of profiles
        where this element can be found.
        """
        return {
            Profile.EQ,
        }

    @cached_property
    def recommended_profile(self) -> BaseProfile:
        """
        This is the profile with most of the attributes.
        It should be used to write the data to as few as possible files.
        """
        return Profile.EQ

• "is_enum_attribute": False could be defined clearly by the linked type;
• "is_primitive_attribute": False, "is_cim_datatype": True, "cim_data_type": Reactance,: seems overlapping.
• When "is_list_attribute": True, we have anyhow pydantic annotations stating that:

  Cut: list = Field(
        default_factory=list,

[m-mirz]

@HUG0-D I have noticed that you have two "rebase branch" commits in this PR. Why do these commits exist? Usually there should not be a new commit introduced by the rebase process. I am referring to 01729ef and bdd09b4

[HUG0-D]

@m-mirz thank you for pointing that out! This was my first time using rebase, and I realize now that I might not have followed the correct process, which led to those extra “rebase branch” commits. I tried to handle some merge conflicts manually, and doing so, I think I mistakenly created those additional commits.

[HUG0-D]

@m-mirz During the rebase process, I encountered several issues that resulted in a messy commit history. To ensure the PR is clean and easy to review, I created a new branch from main and reapplied my changes with a clean commit structure.

The functionality and content of the PR remain the same as before, but now the history is more streamlined. Please let me know if you have any questions or concerns.

Thanks for your understanding!

[tom-hg57]

it seems we have lot of annotations that may be redundant in attributes:

Most of these annotations comes from my PR #36 to provide information about the disjoint attribute types. Now, including "datatype" there are 5 disjoint attribute types:

1. is_class_attribute
2. is_enum_attribute
3. is_datatype_attribute
4. is_list_attribute
5. is_primitive_attribute

Maybe a single "attribute_type" (class, enum, ...) would be less noisy. But these booleans could easily used in chevron templates.

[tom-hg57]

I know it's not caused by your changes, but I think this import in base.py is wrong:
from pycgmes.utils.constants import NAMESPACES

This should be:
from .utils.constants import NAMESPACES

In the same way "pycgmes" should be removed from chevron_writer.py.

And the comment in cimpy_cgmesProfile_template.mustache should be changed to:
All CGMES objects requiring a Profile are actually asking for a BaseProfile.

[guillaume-alliander]

Just some python comments.

[sonarqubecloud]

Quality Gate passed

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