openadr3-client-gac-compliance 1.4.0__tar.gz → 2.0.0__tar.gz

{openadr3_client_gac_compliance-1.4.0 → openadr3_client_gac_compliance-2.0.0}/PKG-INFO

@@ -1,16 +1,19 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: openadr3-client-gac-compliance
-Version: 1.4.0
+Version: 2.0.0
 Summary: 
+License-File: LICENSE.md
 Author: Nick van der Burgt
 Author-email: nick.van.der.burgt@elaad.nl
 Requires-Python: >=3.12, <4
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: openadr3-client (>=0.0.7,<1.0.0)
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: openadr3-client (>=0.0.11,<1.0.0)
 Requires-Dist: pycountry (>=24.6.1,<25.0.0)
 Requires-Dist: pydantic (>=2.11.2,<3.0.0)
+Requires-Dist: python-decouple (>=3.8,<4.0)
 Description-Content-Type: text/markdown
 
 # OpenADR3 client

{openadr3_client_gac_compliance-1.4.0 → openadr3_client_gac_compliance-2.0.0}/openadr3_client_gac_compliance/__init__.py

@@ -1,6 +1,6 @@
 from openadr3_client_gac_compliance.config import GAC_VERSION
 
 if GAC_VERSION == "2.0":
-    import openadr3_client_gac_compliance.gac20.program_gac_compliant  # noqa: F401
-    import openadr3_client_gac_compliance.gac20.event_gac_compliant  # noqa: F401
+    import openadr3_client_gac_compliance.gac20.event_gac_compliant
+    import openadr3_client_gac_compliance.gac20.program_gac_compliant
     import openadr3_client_gac_compliance.gac20.ven_gac_compliant  # noqa: F401

{openadr3_client_gac_compliance-1.4.0 → openadr3_client_gac_compliance-2.0.0}/openadr3_client_gac_compliance/config.py

@@ -6,7 +6,8 @@ VALID_GAC_VERSIONS: list[str] = ["2.0"]
 
 
 def _gac_version_cast(value: str) -> str:
-    """Cast the GAC version to a string.
+    """
+    Cast the GAC version to a string.
 
     Args:
         value (str): The GAC version to cast.
@@ -16,9 +17,11 @@ def _gac_version_cast(value: str) -> str:
 
     Returns:
         str: The GAC version.
+
     """
     if value not in VALID_GAC_VERSIONS:
-        raise ValueError(f"Invalid GAC version: {value}")
+        msg = f"Invalid GAC version: {value}"
+        raise ValueError(msg)
     return value
 
 

{openadr3_client_gac_compliance-1.4.0 → openadr3_client_gac_compliance-2.0.0}/openadr3_client_gac_compliance/gac20/__init__.py

@@ -1,4 +1,4 @@
 # This module imports all the GAC 3.0 compliance validators.
 
+import openadr3_client_gac_compliance.gac20.event_gac_compliant
 import openadr3_client_gac_compliance.gac20.program_gac_compliant  # noqa: F401
-import openadr3_client_gac_compliance.gac20.event_gac_compliant  # noqa: F401

{openadr3_client_gac_compliance-1.4.0 → openadr3_client_gac_compliance-2.0.0}/openadr3_client_gac_compliance/gac20/event_gac_compliant.py

@@ -1,4 +1,5 @@
-"""Module which implements GAC compliance validators for the event OpenADR3 types.
+"""
+Module which implements GAC compliance validators for the event OpenADR3 types.
 
 This module validates all the object constraints and requirements on the OpenADR3 events resource
 as specified in the Grid aware charging (GAC) specification.
@@ -11,34 +12,35 @@ that a safe mode event is present in a program. And it cannot be validated on th
 as the program object does not contain the events, these are stored seperately in the VTN.
 """
 
-from itertools import pairwise
 import re
-from typing import Tuple
-from openadr3_client.models.model import ValidatorRegistry, Model as ValidatorModel
+from itertools import pairwise
+
 from openadr3_client.models.event.event import Event
 from openadr3_client.models.event.event_payload import EventPayloadType
-
+from openadr3_client.models.model import Model as ValidatorModel
+from openadr3_client.models.model import ValidatorRegistry
 from pydantic import ValidationError
 from pydantic_core import InitErrorDetails, PydanticCustomError
 
 
-def _continuous_or_seperated(self: Event) -> Tuple[Event, list[InitErrorDetails]]:
-    """Enforces that events either have consistent interval definitions compliant with GAC.
+def _continuous_or_seperated(self: Event) -> tuple[Event, list[InitErrorDetails]]:
+    """
+    Enforces that events either have consistent interval definitions compliant with GAC.
 
     the Grid aware charging (GAC) specification allows for two types of (mutually exclusive)
     interval definitions:
 
     1. Continuous
-    2. Seperated
+    2. Separated
 
-    The continious implementation can be used when all intervals have the same duration.
+    The continuous implementation can be used when all intervals have the same duration.
     In this case, only the top-level intervalPeriod of the event can be used, and the intervalPeriods
     of the individual intervals must be None.
 
-    In the seperated intervalDefinition approach, the intervalPeriods must be set on each individual intervals,
-    and the top-level intervalPeriod of the event must be None. This seperated approach is used when events have differing
+    In the separated intervalDefinition approach, the intervalPeriods must be set on each individual intervals,
+    and the top-level intervalPeriod of the event must be None. This separated approach is used when events have differing
     durations.
-    """
+    """  # noqa: E501
     validation_errors: list[InitErrorDetails] = []
 
     intervals = self.intervals or ()
@@ -52,7 +54,7 @@ def _continuous_or_seperated(self: Event) -> Tuple[Event, list[InitErrorDetails]
                 InitErrorDetails(
                     type=PydanticCustomError(
                         "value_error",
-                        "Either 'interval_period' must be set on the event once, or every interval must have its own 'interval_period'.",
+                        "Either 'interval_period' must be set on the event once, or every interval must have its own 'interval_period'.",  # noqa: E501
                     ),
                     loc=("intervals",),
                     input=self.intervals,
@@ -62,15 +64,13 @@ def _continuous_or_seperated(self: Event) -> Tuple[Event, list[InitErrorDetails]
     else:
         # interval period set at top level of the event.
         # Ensure that all intervals do not have the interval_period defined, to comply with the GAC specification.
-        duplicate_interval_period = [
-            i for i in intervals if i.interval_period is not None
-        ]
+        duplicate_interval_period = [i for i in intervals if i.interval_period is not None]
         if duplicate_interval_period:
             validation_errors.append(
                 InitErrorDetails(
                     type=PydanticCustomError(
                         "value_error",
-                        "Either 'interval_period' must be set on the event once, or every interval must have its own 'interval_period'.",
+                        "Either 'interval_period' must be set on the event once, or every interval must have its own 'interval_period'.",  # noqa: E501
                     ),
                     loc=("intervals",),
                     input=self.intervals,
@@ -81,8 +81,9 @@ def _continuous_or_seperated(self: Event) -> Tuple[Event, list[InitErrorDetails]
     return self, validation_errors
 
 
-def _targets_compliant(self: Event) -> Tuple[Event, list[InitErrorDetails]]:
-    """Enforces that the targets of the event are compliant with GAC.
+def _targets_compliant(self: Event) -> tuple[Event, list[InitErrorDetails]]:
+    """
+    Enforces that the targets of the event are compliant with GAC.
 
     GAC enforces the following constraints for targets:
 
@@ -149,12 +150,7 @@ def _targets_compliant(self: Event) -> Tuple[Event, list[InitErrorDetails]]:
             )
         )
 
-    if (
-        power_service_locations
-        and ven_names
-        and len(power_service_locations) == 1
-        and len(ven_names) == 1
-    ):
+    if power_service_locations and ven_names and len(power_service_locations) == 1 and len(ven_names) == 1:
         power_service_location = power_service_locations[0]
         ven_name = ven_names[0]
 
@@ -171,9 +167,7 @@ def _targets_compliant(self: Event) -> Tuple[Event, list[InitErrorDetails]]:
                 )
             )
 
-        if not all(
-            re.fullmatch(r"^EAN\d{15}$", v) for v in power_service_location.values
-        ):
+        if not all(re.fullmatch(r"^\d{18}$", v) for v in power_service_location.values):
             validation_errors.append(
                 InitErrorDetails(
                     type=PydanticCustomError(
@@ -199,12 +193,12 @@ def _targets_compliant(self: Event) -> Tuple[Event, list[InitErrorDetails]]:
                 )
             )
 
-        if not all(1 <= len(v) <= 128 for v in ven_name.values):
+        if not all(1 <= len(v) <= 128 for v in ven_name.values):  # noqa: PLR2004
             validation_errors.append(
                 InitErrorDetails(
                     type=PydanticCustomError(
                         "value_error",
-                        "The VEN_NAME target value must be a list of 'ven object name' values (between 1 and 128 characters).",
+                        "The VEN_NAME target value must be a list of 'ven object name' values (between 1 and 128 characters).",  # noqa: E501
                     ),
                     loc=("targets",),
                     input=self.targets,
@@ -215,10 +209,11 @@ def _targets_compliant(self: Event) -> Tuple[Event, list[InitErrorDetails]]:
     return self, validation_errors
 
 
-def _payload_descriptor_gac_compliant(
+def _payload_descriptors_gac_compliant(
     self: Event,
-) -> Tuple[Event, list[InitErrorDetails]]:
-    """Enforces that the payload descriptor is GAC compliant.
+) -> tuple[Event, list[InitErrorDetails]]:
+    """
+    Enforces that the payload descriptor is GAC compliant.
 
     GAC enforces the following constraints for payload descriptors:
 
@@ -255,9 +250,9 @@ def _payload_descriptor_gac_compliant(
                 )
             )
 
-        payload_descriptor = self.payload_descriptors[0]
+        payload_descriptors = self.payload_descriptors[0]
 
-        if payload_descriptor.payload_type != EventPayloadType.IMPORT_CAPACITY_LIMIT:
+        if payload_descriptors.payload_type != EventPayloadType.IMPORT_CAPACITY_LIMIT:
             validation_errors.append(
                 InitErrorDetails(
                     type=PydanticCustomError(
@@ -270,7 +265,7 @@ def _payload_descriptor_gac_compliant(
                 )
             )
 
-        if payload_descriptor.units != "KW":
+        if payload_descriptors.units != "KW":
             validation_errors.append(
                 InitErrorDetails(
                     type=PydanticCustomError(
@@ -286,8 +281,9 @@ def _payload_descriptor_gac_compliant(
     return self, validation_errors
 
 
-def _event_interval_gac_compliant(self: Event) -> Tuple[Event, list[InitErrorDetails]]:
-    """Enforces that the event interval is GAC compliant.
+def _event_interval_gac_compliant(self: Event) -> tuple[Event, list[InitErrorDetails]]:
+    """
+    Enforces that the event interval is GAC compliant.
 
     GAC enforces the following constraints for event intervals:
 
@@ -370,7 +366,8 @@ def _event_interval_gac_compliant(self: Event) -> Tuple[Event, list[InitErrorDet
 
 @ValidatorRegistry.register(Event, ValidatorModel())
 def event_gac_compliant(self: Event) -> Event:
-    """Enforces that events are GAC compliant.
+    """
+    Enforces that events are GAC compliant.
 
     GAC enforces the following constraints for events:
 
@@ -398,19 +395,13 @@ def event_gac_compliant(self: Event) -> Event:
     targets_validated, errors = _targets_compliant(interval_periods_validated)
     validation_errors.extend(errors)
 
-    payload_descriptor_validated, errors = _payload_descriptor_gac_compliant(
-        targets_validated
-    )
+    payload_descriptor_validated, errors = _payload_descriptors_gac_compliant(targets_validated)
     validation_errors.extend(errors)
 
-    event_interval_validated, errors = _event_interval_gac_compliant(
-        payload_descriptor_validated
-    )
+    event_interval_validated, errors = _event_interval_gac_compliant(payload_descriptor_validated)
     validation_errors.extend(errors)
 
     if validation_errors:
-        raise ValidationError.from_exception_data(
-            title=self.__class__.__name__, line_errors=validation_errors
-        )
+        raise ValidationError.from_exception_data(title=self.__class__.__name__, line_errors=validation_errors)
 
     return event_interval_validated

{openadr3_client_gac_compliance-1.4.0 → openadr3_client_gac_compliance-2.0.0}/openadr3_client_gac_compliance/gac20/program_gac_compliant.py

@@ -1,17 +1,18 @@
 """Module which implements GAC compliance validators for the program OpenADR3 types."""
 
-from openadr3_client.models.program.program import Program
-from openadr3_client.models.model import ValidatorRegistry, Model as ValidatorModel
-
 import re
 
+from openadr3_client.models.model import Model as ValidatorModel
+from openadr3_client.models.model import ValidatorRegistry
+from openadr3_client.models.program.program import Program
 from pydantic import ValidationError
 from pydantic_core import InitErrorDetails, PydanticCustomError
 
 
 @ValidatorRegistry.register(Program, ValidatorModel())
 def program_gac_compliant(self: Program) -> Program:
-    """Enforces that the program is GAC compliant.
+    """
+    Enforces that the program is GAC compliant.
 
     GAC enforces the following constraints for programs:
     - The program must have a retailer name
@@ -20,10 +21,19 @@ def program_gac_compliant(self: Program) -> Program:
     - The programType MUST equal "DSO_CPO_INTERFACE-x.x.x, where x.x.x is the version as defined in the GAC specification.
     - The program MUST have bindingEvents set to True.
     are allowed there.
-    """
+    """  # noqa: E501
     validation_errors: list[InitErrorDetails] = []
 
-    program_type_regex = r"^DSO_CPO_INTERFACE-(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
+    program_type_regex = (
+        r"^DSO_CPO_INTERFACE-"
+        r"(0|[1-9]\d*)\."
+        r"(0|[1-9]\d*)\."
+        r"(0|[1-9]\d*)"
+        r"(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)"
+        r"(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))"
+        r"?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?"
+        r"$"
+    )
 
     if self.retailer_name is None:
         validation_errors.append(
@@ -39,7 +49,7 @@ def program_gac_compliant(self: Program) -> Program:
         )
 
     if self.retailer_name is not None and (
-        len(self.retailer_name) < 2 or len(self.retailer_name) > 128
+        len(self.retailer_name) < 2 or len(self.retailer_name) > 128  # noqa: PLR2004
     ):
         validation_errors.append(
             InitErrorDetails(
@@ -65,9 +75,7 @@ def program_gac_compliant(self: Program) -> Program:
                 ctx={},
             )
         )
-    if self.program_type is not None and not re.fullmatch(
-        program_type_regex, self.program_type
-    ):
+    if self.program_type is not None and not re.fullmatch(program_type_regex, self.program_type):
         validation_errors.append(
             InitErrorDetails(
                 type=PydanticCustomError(
@@ -94,8 +102,6 @@ def program_gac_compliant(self: Program) -> Program:
         )
 
     if validation_errors:
-        raise ValidationError.from_exception_data(
-            title=self.__class__.__name__, line_errors=validation_errors
-        )
+        raise ValidationError.from_exception_data(title=self.__class__.__name__, line_errors=validation_errors)
 
     return self

{openadr3_client_gac_compliance-1.4.0 → openadr3_client_gac_compliance-2.0.0}/openadr3_client_gac_compliance/gac20/ven_gac_compliant.py

@@ -1,15 +1,17 @@
 import re
-from openadr3_client.models.model import ValidatorRegistry, Model as ValidatorModel
-from openadr3_client.models.ven.ven import Ven
-import pycountry
 
+import pycountry
+from openadr3_client.models.model import Model as ValidatorModel
+from openadr3_client.models.model import ValidatorRegistry
+from openadr3_client.models.ven.ven import Ven
 from pydantic import ValidationError
 from pydantic_core import InitErrorDetails, PydanticCustomError
 
 
 @ValidatorRegistry.register(Ven, ValidatorModel())
 def ven_gac_compliant(self: Ven) -> Ven:
-    """Enforces that the ven is GAC compliant.
+    """
+    Enforces that the ven is GAC compliant.
 
     GAC enforces the following constraints for vens:
     - The ven must have a ven name
@@ -48,8 +50,6 @@ def ven_gac_compliant(self: Ven) -> Ven:
         )
 
     if validation_errors:
-        raise ValidationError.from_exception_data(
-            title=self.__class__.__name__, line_errors=validation_errors
-        )
+        raise ValidationError.from_exception_data(title=self.__class__.__name__, line_errors=validation_errors)
 
     return self

openadr3_client_gac_compliance-2.0.0/pyproject.toml

@@ -0,0 +1,80 @@
+[project]
+name = "openadr3-client-gac-compliance"
+version = "2.0.0"
+description = ""
+authors = [
+    {name = "Nick van der Burgt", email = "nick.van.der.burgt@elaad.nl"}
+]
+readme = "README.md"
+requires-python = ">=3.12, <4"
+dependencies = [
+    "pydantic (>=2.11.2,<3.0.0)",
+    "openadr3-client (>=0.0.11,<1.0.0)",
+    "pycountry (>=24.6.1,<25.0.0)",
+    "python-decouple (>=3.8,<4.0)",
+]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "^1.15.0"
+ruff = "^0.11.4"
+pytest = "^8.3.5"
+pytest-cov = "^6.1.1"
+taskipy = "^1.14.1"
+
+[[tool.mypy.overrides]]
+module = ["openadr3_client", "decouple"]
+ignore_missing_imports = true
+
+[tool.taskipy.tasks]
+local-ci = "task check && task format && task mypy && task test"
+fix = "task check-fix && task format-fix && task mypy"
+check = "ruff check ."
+check-fix = "ruff check --fix ."
+check-ci = "ruff check --output-format=github --no-cache ."
+mypy = "mypy . --check-untyped-defs"
+format = "ruff format . --diff"
+format-fix = "ruff format ."
+format-ci = "ruff format --diff --no-cache ."
+test = "pytest --cov"
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = ["ALL"]
+
+# Do not require docstrings for functions, methods and classes
+ignore = [
+    # From:https://github.com/wemake-services/wemake-django-template/blob/master/pyproject.toml
+    "A005",   # allow to shadow stdlib and builtin module names
+    "COM812", # trailing comma, conflicts with `ruff format`
+    # Different doc rules that we don't really care about:
+    "D100",
+    "D104",
+    "D106",
+    "D203",
+    "D212",
+    "D401",
+    "D404",
+    "D405",
+    "ISC001",  # implicit string concat conflicts with `ruff format`
+    "ISC003",  # prefer explicit string concat over implicit concat
+    "PLR09",   # we have our own complexity rules
+    # "PLR2004", # do not report magic numbers -> I do want to report magic numbers
+    "PLR6301", # do not require classmethod / staticmethod when self not used
+    "TRY003",  # long exception messages from `tryceratops`
+    # Start of own error codes
+    "ANN002", # Ignore unused *args
+    "ANN003", # Ignore unused **kwargs
+    "D107", # Allow undocumented __init__
+    "TC001", # Move to type checking block (does not play nice with pydantic models)
+    "TC002", # Move to type checking block (does not play nice with pydantic models)
+]
+
+# Ignores S101 ("Use of 'assert' detected") for the tests.
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["S101", "ANN201", "SLF001", "S106", "S105", "S311", "PLR2004", "PT018"]

openadr3_client_gac_compliance-1.4.0/pyproject.toml

@@ -1,28 +0,0 @@
-[project]
-name = "openadr3-client-gac-compliance"
-version = "1.4.0"
-description = ""
-authors = [
-    {name = "Nick van der Burgt", email = "nick.van.der.burgt@elaad.nl"}
-]
-readme = "README.md"
-requires-python = ">=3.12, <4"
-dependencies = [
-    "pydantic (>=2.11.2,<3.0.0)",
-    "openadr3-client (>=0.0.7,<1.0.0)",
-    "pycountry (>=24.6.1,<25.0.0)",
-]
-
-[build-system]
-requires = ["poetry-core>=2.0.0,<3.0.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.poetry.group.dev.dependencies]
-mypy = "^1.15.0"
-ruff = "^0.11.4"
-pytest = "^8.3.5"
-pytest-cov = "^6.1.1"
-
-[[tool.mypy.overrides]]
-module = ["openadr3_client", "decouple"]
-ignore_missing_imports = true