Support pydantic code generation

.github/workflows/ci.yml

@@ -28,6 +28,7 @@ jobs:
           - cpp
           - java
           - javascript
+          - pydantic
 
     steps:
     - uses: actions/checkout@v3

.gitignore

@@ -6,3 +6,4 @@ cimpy/*
 *.py[cod]
 __pycache__/
 .vscode/launch.json
+CGMES_2.4.15_27JAN2020_pydantic/

CIMgen.py

@@ -687,6 +687,16 @@ def addSubClassesOfSubClasses(class_dict):
         )
 
 
+def addSubClassesOfSubClassesClean(class_dict, source):
+    temp = {}
+    for className in class_dict:
+        for name in class_dict[className].subClasses():
+            if name not in class_dict:
+                temp[name] = source[name]
+                addSubClassesOfSubClassesClean(temp, source)
+    class_dict.update(temp)
+
+
 def cim_generate(directory, outputPath, version, langPack):
     """Generates cgmes python classes from cgmes ontology
 
@@ -729,6 +739,8 @@ def cim_generate(directory, outputPath, version, langPack):
     # merge classes from different profiles into one class and track origin of the classes and their attributes
     class_dict_with_origins = _merge_classes(profiles_dict)
 
+    clean_class_dict = {}
+
     # work out the subclasses for each class by noting the reverse relationship
     for className in class_dict_with_origins:
         superClassName = class_dict_with_origins[className].superClass()
@@ -742,7 +754,25 @@ def cim_generate(directory, outputPath, version, langPack):
     # recursively add the subclasses of subclasses
     addSubClassesOfSubClasses(class_dict_with_origins)
 
+    for className in class_dict_with_origins:
+        superClassName = class_dict_with_origins[className].superClass()
+        if (
+            superClassName == None
+            and class_dict_with_origins[className].has_instances()
+        ):
+            clean_class_dict[className] = class_dict_with_origins[className]
+
+    for className in class_dict_with_origins:
+        superClassName = class_dict_with_origins[className].superClass()
+        if (
+            superClassName == None
+            and not class_dict_with_origins[className].has_instances()
+        ):
+            clean_class_dict[className] = class_dict_with_origins[className]
+
+    addSubClassesOfSubClassesClean(clean_class_dict, class_dict_with_origins)
+
     # get information for writing python files and write python files
-    _write_python_files(class_dict_with_origins, langPack, outputPath, version)
+    _write_python_files(clean_class_dict, langPack, outputPath, version)
 
     logger.info("Elapsed Time: {}s\n\n".format(time() - t0))

Dockerfile

@@ -8,7 +8,9 @@ COPY cpp/               /CIMgen/cpp/
 COPY java/              /CIMgen/java/
 COPY javascript/        /CIMgen/javascript/
 COPY python/            /CIMgen/python/
+COPY pydantic/            /CIMgen/pydantic/
 COPY CIMgen.py build.py /CIMgen/
+COPY cgmes_schema/ /cgmes_schema
 WORKDIR /CIMgen
 ENTRYPOINT [ "/usr/bin/python3", "build.py", "--outdir=/cgmes_output", "--schemadir=/cgmes_schema" ]
 CMD [ "--langdir=cpp" ]

RELEASE_NOTES.md

@@ -1,6 +1,10 @@
 # cimgen Release Notes
 
-## 0.0.1-dev - 2023-07-28
+## 0.0.1-dev - 2023-09-13
+
+### Features
+
+- Support pydantic code generation (PR #5 by @chicco785)
 
 ### Continuous Integration
 

pydantic/Base.py

@@ -0,0 +1,21 @@
+from pydantic import BaseModel
+
+
+class Base(BaseModel):
+    """
+    Base Class for CIM
+    """
+
+    """
+    not valid for pydantic 2.0
+    class Config:
+        @staticmethod
+        def schema_extra(schema: dict, _):
+            props = {}
+            for k, v in schema.get("properties", {}).items():
+                if not v.get("hidden", False):
+                    props[k] = v
+            schema["properties"] = props """
+
+    def printxml(self, dict={}):
+        return dict

pydantic/__init__.py

@@ -0,0 +1 @@
+import pydantic.langPack

pydantic/enum_header.py

@@ -0,0 +1,13 @@
+from enum import Enum, IntEnum
+
+
+class CgmesProfileEnum(IntEnum):
+    EQ = 0
+    SSH = 1
+    TP = 2
+    SV = 3
+    DY = 4
+    GL = 5
+    DL = 5
+    TP_BD = 7
+    EQ_BD = 8