openadr3-client-gac-compliance 0.0.2__py3-none-any.whl → 1.1.0__py3-none-any.whl

openadr3_client_gac_compliance/__init__.py

@@ -1,5 +1,6 @@
 from openadr3_client_gac_compliance.config import GAC_VERSION
 
-if GAC_VERSION == "3.0":
-    import openadr3_client_gac_compliance.gac30.program_gac_compliant  # noqa: F401
-    import openadr3_client_gac_compliance.gac30.event_gac_compliant  # noqa: F401
+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.ven_gac_compliant  # noqa: F401

openadr3_client_gac_compliance/config.py

@@ -2,7 +2,7 @@
 
 from decouple import config
 
-VALID_GAC_VERSIONS: list[str] = ["3.0"]
+VALID_GAC_VERSIONS: list[str] = ["2.0"]
 
 
 def _gac_version_cast(value: str) -> str:
@@ -23,4 +23,4 @@ def _gac_version_cast(value: str) -> str:
 
 
 # The GAC version to use for the compliance validators.
-GAC_VERSION = config("GAC_VERSION", default="3.0", cast=_gac_version_cast)
+GAC_VERSION = config("GAC_VERSION", default="2.0", cast=_gac_version_cast)

openadr3_client_gac_compliance/gac20/__init__.py

@@ -0,0 +1,4 @@
+# This module imports all the GAC 3.0 compliance validators.
+
+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/{gac30 → gac20}/event_gac_compliant.py

@@ -182,16 +182,12 @@ def event_gac_compliant(self: Event) -> Event:
 
     GAC enforces the following constraints for events:
 
-    - The event must have a priority set.
-    - The priority must be greater than or equal to 0 and less than or equal to 999.
+    - The event must not have a priority set.
     - The event must have either a continuous or seperated interval definition.
     """
-    if self.priority is None:
-        raise ValueError("The event must have a priority set.")
-
-    if self.priority > 999:
+    if self.priority is not None:
         raise ValueError(
-            "The priority must be greater than or equal to 0 and less than or equal to 999."
+            "The event must not have a priority set for GAC 2.0 compliance"
         )
 
     interval_periods_validated = _continuous_or_seperated(self)

openadr3_client_gac_compliance/{gac30 → gac20}/program_gac_compliant.py

@@ -12,7 +12,7 @@ def program_gac_compliant(self: Program) -> Program:
 
     GAC enforces the following constraints for programs:
     - The program must have a retailer name
-    - The retailer name must be an EAN13 identifier.
+    - The retailer name must be between 2 and 128 characters long.
     - The program MUST have a programType.
     - 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.
@@ -22,8 +22,9 @@ def program_gac_compliant(self: Program) -> Program:
 
     if self.retailer_name is None:
         raise ValueError("The program must have a retailer name.")
-    if not re.fullmatch(r"\d{13}", self.retailer_name):
-        raise ValueError("The retailer name must be an EAN13 identifier.")
+
+    if len(self.retailer_name) < 2 or len(self.retailer_name) > 128:
+        raise ValueError("The retailer name must be between 2 and 128 characters long.")
 
     if self.program_type is None:
         raise ValueError("The program must have a program type.")

openadr3_client_gac_compliance/gac20/ven_gac_compliant.py

@@ -0,0 +1,27 @@
+import re
+from openadr3_client.models.model import ValidatorRegistry, Model as ValidatorModel
+from openadr3_client.models.ven.ven import Ven
+import pycountry
+
+
+@ValidatorRegistry.register(Ven, ValidatorModel())
+def ven_gac_compliant(self: Ven) -> Ven:
+    """Enforces that the ven is GAC compliant.
+
+    GAC enforces the following constraints for vens:
+    - The ven must have a ven name
+    - The ven name must be an eMI3 identifier.
+    """
+    emi3_identifier_regex = r"^[A-Z]{2}-?[A-Z0-9]{3}$"
+
+    if not re.fullmatch(emi3_identifier_regex, self.ven_name):
+        raise ValueError("The ven name must be formatted as an eMI3 identifier.")
+
+    alpha_2_country = pycountry.countries.get(alpha_2=self.ven_name[:2])
+
+    if alpha_2_country is None:
+        raise ValueError(
+            "The first two characters of the ven name must be a valid ISO 3166-1 alpha-2 country code."
+        )
+
+    return self

{openadr3_client_gac_compliance-0.0.2.dist-info → openadr3_client_gac_compliance-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: openadr3-client-gac-compliance
-Version: 0.0.2
+Version: 1.1.0
 Summary: 
 Author: Nick van der Burgt
 Author-email: nick.van.der.burgt@elaad.nl
@@ -9,6 +9,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: openadr3-client (>=0.0.1,<0.0.2)
+Requires-Dist: pycountry (>=24.6.1,<25.0.0)
 Requires-Dist: pydantic (>=2.11.2,<3.0.0)
 Description-Content-Type: text/markdown
 

openadr3_client_gac_compliance-1.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+openadr3_client_gac_compliance/__init__.py,sha256=dzf9YdOlssEb9GSIoThaMzEJ956G-hpLi7HIXRC3TR8,334
+openadr3_client_gac_compliance/config.py,sha256=X_KEl99bUm05rH0IOKLyeR4Zn2utdC8U3vLkdG8MYXU,675
+openadr3_client_gac_compliance/gac20/__init__.py,sha256=YPjRHMl-uR6ZwrDGjY_EboScHe_VhTrovso_zDOSd6o,220
+openadr3_client_gac_compliance/gac20/event_gac_compliant.py,sha256=KPcUyazlroFv0c3IovvtMW4a4LD2lBOyct4ptjngixk,7970
+openadr3_client_gac_compliance/gac20/program_gac_compliant.py,sha256=qJeyvAdu0f6F0I3iXXl64dOVRZwPfRHQyGqc3ECuzjw,1725
+openadr3_client_gac_compliance/gac20/ven_gac_compliant.py,sha256=YAzM2Q9ggh_O-p1xD5GlN7-lTGg2MjqUG26KBSy3-d8,908
+openadr3_client_gac_compliance/gac21/__init__.py,sha256=GTu1EyBj2T72zT3MKPettcvP-DNCJ0p6oAMj3Z-08N0,61
+openadr3_client_gac_compliance-1.1.0.dist-info/LICENSE.md,sha256=NNNxKzhSK6afX-UaN8WZIVtMi5Tu8dVr6q3ciTSnH-g,10250
+openadr3_client_gac_compliance-1.1.0.dist-info/METADATA,sha256=tuuieVH5mgB1rE9ijxwSyt3zSFzvB4zqEwsw98WLA-s,1096
+openadr3_client_gac_compliance-1.1.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+openadr3_client_gac_compliance-1.1.0.dist-info/RECORD,,

openadr3_client_gac_compliance/gac30/__init__.py

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

openadr3_client_gac_compliance-0.0.2.dist-info/RECORD

@@ -1,10 +0,0 @@
-openadr3_client_gac_compliance/__init__.py,sha256=Kla5pd6kvbbCqZdSaqlZbNfmZZe2BUWax19EHqGrHeE,254
-openadr3_client_gac_compliance/config.py,sha256=e8UfHlvSbNKziFN572lbxDJ8vCfh-Jv_5eDLi00lYog,675
-openadr3_client_gac_compliance/gac30/__init__.py,sha256=UOgLJqVCWTiiHB6rXiDFWndUlF3hZQ8IDy6qb69bPkc,220
-openadr3_client_gac_compliance/gac30/event_gac_compliant.py,sha256=s-pxU0lKm7MD0W0jAgKDAhnakuK1DuZhx83mtLID3zs,8157
-openadr3_client_gac_compliance/gac30/program_gac_compliant.py,sha256=fAmMaRumpMppvxaNonTAYTXQIWryUnuJjnsS-cCkYjE,1683
-openadr3_client_gac_compliance/gac31/__init__.py,sha256=GTu1EyBj2T72zT3MKPettcvP-DNCJ0p6oAMj3Z-08N0,61
-openadr3_client_gac_compliance-0.0.2.dist-info/LICENSE.md,sha256=NNNxKzhSK6afX-UaN8WZIVtMi5Tu8dVr6q3ciTSnH-g,10250
-openadr3_client_gac_compliance-0.0.2.dist-info/METADATA,sha256=EuXZG4d0TiX_Ig4ustohso02q8u61T31DhD0Yjiwp3k,1052
-openadr3_client_gac_compliance-0.0.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-openadr3_client_gac_compliance-0.0.2.dist-info/RECORD,,