fix: add name constraints to yaml classes (#358)

Adds pattern to json-schema so users get early feedback if name contains invalid characters
equinor · Jan 29, 2024 · f586181 · f586181
1 parent f6a58a2
commit f586181
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 5 deletions.
diff --git a/src/libecalc/presentation/yaml/yaml_types/components/yaml_base.py b/src/libecalc/presentation/yaml/yaml_types/components/yaml_base.py
@@ -2,12 +2,13 @@
 
 from pydantic import Field
 
+from libecalc.dto.utils.validators import ComponentNameStr
 from libecalc.expression.expression import ExpressionType
 from libecalc.presentation.yaml.yaml_types import YamlBase
 
 
 class YamlConsumerBase(YamlBase):
-    name: str = Field(
+    name: ComponentNameStr = Field(
         ...,
         title="NAME",
         description="Consumer name",

diff --git a/src/libecalc/presentation/yaml/yaml_types/components/yaml_generator_set.py b/src/libecalc/presentation/yaml/yaml_types/components/yaml_generator_set.py
@@ -3,6 +3,7 @@
 from pydantic import ConfigDict, Field
 
 from libecalc.dto.base import ConsumerUserDefinedCategoryType
+from libecalc.dto.utils.validators import ComponentNameStr
 from libecalc.presentation.yaml.yaml_types import YamlBase
 from libecalc.presentation.yaml.yaml_types.components.legacy.yaml_electricity_consumer import (
     YamlElectricityConsumer,
@@ -24,7 +25,7 @@
 class YamlGeneratorSet(YamlBase):
     model_config = ConfigDict(title="GeneratorSet")
 
-    name: str = Field(
+    name: ComponentNameStr = Field(
         ...,
         title="NAME",
         description="Name of the generator set.\n\n$ECALC_DOCS_KEYWORDS_URL/NAME",

diff --git a/src/libecalc/presentation/yaml/yaml_types/components/yaml_installation.py b/src/libecalc/presentation/yaml/yaml_types/components/yaml_installation.py
@@ -3,6 +3,7 @@
 from pydantic import ConfigDict, Field
 
 from libecalc.dto.base import InstallationUserDefinedCategoryType
+from libecalc.dto.utils.validators import ComponentNameStr
 from libecalc.expression import Expression
 from libecalc.presentation.yaml.yaml_types import YamlBase
 from libecalc.presentation.yaml.yaml_types.components.legacy.yaml_fuel_consumer import (
@@ -31,7 +32,7 @@
 class YamlInstallation(YamlBase):  # TODO: conditional required, either fuelconsumers or gensets
     model_config = ConfigDict(title="Installation")
 
-    name: str = Field(
+    name: ComponentNameStr = Field(
         ...,
         title="NAME",
         description="Name of the installation.\n\n$ECALC_DOCS_KEYWORDS_URL/NAME",

diff --git a/src/libecalc/presentation/yaml/yaml_types/emitters/yaml_venting_emitter.py b/src/libecalc/presentation/yaml/yaml_types/emitters/yaml_venting_emitter.py
@@ -13,6 +13,7 @@
     TimeSeriesStreamDayRate,
 )
 from libecalc.dto.base import ComponentType, ConsumerUserDefinedCategoryType
+from libecalc.dto.utils.validators import ComponentNameStr
 from libecalc.dto.variables import VariablesMap
 from libecalc.expression import Expression
 from libecalc.presentation.yaml.yaml_types import YamlBase
@@ -39,7 +40,7 @@ class YamlVentingEmitter(YamlBase):
     def component_type(self):
         return ComponentType.VENTING_EMITTER
 
-    name: str = Field(
+    name: ComponentNameStr = Field(
         ...,
         title="NAME",
         description="Name of venting emitter",

diff --git a/src/libecalc/presentation/yaml/yaml_types/fuel_type/yaml_emission.py b/src/libecalc/presentation/yaml/yaml_types/fuel_type/yaml_emission.py
@@ -1,13 +1,14 @@
 from pydantic import ConfigDict, Field
 
+from libecalc.dto.utils.validators import EmissionNameStr
 from libecalc.expression.expression import ExpressionType
 from libecalc.presentation.yaml.yaml_types import YamlBase
 
 
 class YamlEmission(YamlBase):
     model_config = ConfigDict(title="Emission")
 
-    name: str = Field(
+    name: EmissionNameStr = Field(
         ...,
         title="NAME",
         description="Name of the emission.\n\n$ECALC_DOCS_KEYWORDS_URL/NAME",

diff --git a/...t/validation/snapshots/test_validation_json_schemas/test_json_schema_changed/schemas.json b/...t/validation/snapshots/test_validation_json_schemas/test_json_schema_changed/schemas.json
@@ -252,6 +252,7 @@
                         },
                         "NAME": {
                             "description": "Consumer name",
+                            "pattern": "^[A-Z\u00c6\u00d8\u00c5a-z\u00e6\u00f8\u00e5\\d_/\\- ]*$",
                             "title": "NAME",
                             "type": "string"
                         },
@@ -659,6 +660,7 @@
                         },
                         "NAME": {
                             "description": "Consumer name",
+                            "pattern": "^[A-Z\u00c6\u00d8\u00c5a-z\u00e6\u00f8\u00e5\\d_/\\- ]*$",
                             "title": "NAME",
                             "type": "string"
                         },
@@ -726,6 +728,7 @@
                         },
                         "NAME": {
                             "description": "Consumer name",
+                            "pattern": "^[A-Z\u00c6\u00d8\u00c5a-z\u00e6\u00f8\u00e5\\d_/\\- ]*$",
                             "title": "NAME",
                             "type": "string"
                         },
@@ -793,6 +796,7 @@
                         },
                         "NAME": {
                             "description": "Consumer name",
+                            "pattern": "^[A-Z\u00c6\u00d8\u00c5a-z\u00e6\u00f8\u00e5\\d_/\\- ]*$",
                             "title": "NAME",
                             "type": "string"
                         },
@@ -1094,6 +1098,7 @@
                         },
                         "NAME": {
                             "description": "Name of the emission.\n\nhttps://test.ecalc.equinor.com/docs/docs/modelling/keywords/NAME",
+                            "pattern": "^\\w*$",
                             "title": "NAME",
                             "type": "string"
                         }
@@ -2011,6 +2016,7 @@
                         },
                         "NAME": {
                             "description": "Name of the generator set.\n\nhttps://test.ecalc.equinor.com/docs/docs/modelling/keywords/NAME",
+                            "pattern": "^[A-Z\u00c6\u00d8\u00c5a-z\u00e6\u00f8\u00e5\\d_/\\- ]*$",
                             "title": "NAME",
                             "type": "string"
                         }
@@ -2252,6 +2258,7 @@
                         },
                         "NAME": {
                             "description": "Name of the installation.\n\nhttps://test.ecalc.equinor.com/docs/docs/modelling/keywords/NAME",
+                            "pattern": "^[A-Z\u00c6\u00d8\u00c5a-z\u00e6\u00f8\u00e5\\d_/\\- ]*$",
                             "title": "NAME",
                             "type": "string"
                         },
@@ -2538,6 +2545,7 @@
                         },
                         "NAME": {
                             "description": "Consumer name",
+                            "pattern": "^[A-Z\u00c6\u00d8\u00c5a-z\u00e6\u00f8\u00e5\\d_/\\- ]*$",
                             "title": "NAME",
                             "type": "string"
                         },
@@ -3376,6 +3384,7 @@
                         },
                         "NAME": {
                             "description": "Consumer name",
+                            "pattern": "^[A-Z\u00c6\u00d8\u00c5a-z\u00e6\u00f8\u00e5\\d_/\\- ]*$",
                             "title": "NAME",
                             "type": "string"
                         },
@@ -3854,6 +3863,7 @@
                         },
                         "NAME": {
                             "description": "Name of venting emitter",
+                            "pattern": "^[A-Z\u00c6\u00d8\u00c5a-z\u00e6\u00f8\u00e5\\d_/\\- ]*$",
                             "title": "NAME",
                             "type": "string"
                         }