PySimultan 0.5.9.6__py3-none-any.whl → 0.5.9.7__py3-none-any.whl

PySimultan2/CHANGELOG.md

@@ -1,3 +1,8 @@
+Version 0.5.9.7 (09.01.2024)
+- Added default component support to Mapper: if a default component is not present in the datamodel, it is automatically added
+- Fixed content naming bug: Content.name is now used for the name of the TaxonomyEntry in SIMULTAN
+- Added typing for better code completion
+
 Version 0.5.9.4 (31.12.2024)
 - Fixed bug in DirectoryInfo where __dir__helper_file__ was not found if already existing
 

PySimultan2/__about__.py

@@ -1 +1 @@
-version = '0.5.9.6'
+version = '0.5.9.7'

PySimultan2/data_model.py

@@ -791,7 +791,10 @@ class DataModel:
                                            None)
         return model_to_work_with, resource_file
 
-    def get_or_create_taxonomy(self, taxonomy_key: str, taxonomy_name: str = None, description='', create=True):
+    def get_or_create_taxonomy(self, taxonomy_key: str,
+                               taxonomy_name: str = None,
+                               description='',
+                               create=True) -> SimTaxonomy:
         taxonomy = next((x for x in self.taxonomies if x.Key == taxonomy_key), None)
         if taxonomy is None:
             if create:
@@ -799,7 +802,11 @@ class DataModel:
             else:
                 raise ValueError(f'Taxonomy {taxonomy_key} not found in project {self.project_path}')
 
-        return next((x for x in self.taxonomies if x.Key == taxonomy_key), None)
+        taxonomy = next((x for x in self.taxonomies if x.Key == taxonomy_key), None)
+
+        if create and taxonomy is None:
+            raise ValueError(f'Could not create taxonomy {taxonomy_key} in project {self.project_path}')
+        return taxonomy
 
     def get_or_create_taxonomy_entry(self,
                                      name: str,

PySimultan2/object_mapper.py

@@ -1,4 +1,4 @@
-from typing import Optional, Type, TYPE_CHECKING, Union, Any
+from typing import Optional, Type, TYPE_CHECKING, Union, Any, Dict, List
 from copy import copy
 from collections import UserList
 from colorlog import getLogger
@@ -74,6 +74,8 @@ class PythonMapper(object):
         self.re_register = False
         self.load_undefined = False
 
+        self.default_components: List[Any] = []
+
     @property
     def module(self):
         return self._module
@@ -147,7 +149,9 @@ class PythonMapper(object):
             self.taxonomy_maps.update(submodule.taxonomy_maps)
             self.registered_geometry_classes.update(submodule.registered_geometry_classes)
 
-    def create_mapped_class(self, taxonomy, cls):
+    def create_mapped_class(self,
+                            taxonomy: str,
+                            cls: Any):
 
         if any([issubclass(cls, x) for x in (SimultanObject, UserList)]):
             bases = (cls,)
@@ -179,7 +183,10 @@ class PythonMapper(object):
 
         return self.mapped_classes.get(taxonomy, None)
 
-    def get_typed_data(self, data_model=None, component_list=None, create_all=False):
+    def get_typed_data(self,
+                       data_model: 'DataModel' = None,
+                       component_list: List[SimComponent] = None,
+                       create_all: bool = False):
 
         typed_data = []
 
@@ -229,8 +236,27 @@ class PythonMapper(object):
             typed_object = self.create_python_object(component, data_model=data_model)
             if typed_object is not None:
                 typed_data.append(typed_object)
+
+        if create_all:
+            self.create_default_components(data_model)
+
         return typed_data
 
+    def create_default_components(self, data_model: 'DataModel'):
+        for instance in self.default_components:
+            key = list(filter(lambda x: self.registered_classes[x] == type(instance),
+                              self.registered_classes)
+                       )[0]
+            cls = self.get_mapped_class(key)
+            if not cls.cls_instances:
+                self.create_mapped_python_object(obj=instance,
+                                                 data_model=data_model)
+            else:
+                # check if default instance is already in data model
+                if not any([x.name == instance.name for x in cls.cls_instances]):
+                    self.create_mapped_python_object(obj=instance,
+                                                     data_model=data_model)
+
     def create_python_geometry_object(self,
                                       component: Union[Layer, Vertex, Edge, PEdge, Face, Volume, EdgeLoop],
                                       data_model: 'DataModel' = None,

PySimultan2/taxonomy_maps.py

@@ -3,12 +3,12 @@ from functools import cache
 from ruamel.yaml import YAML, yaml_object, add_representer
 from . import yaml
 
-from typing import TYPE_CHECKING, Optional, Union, Literal
+from typing import TYPE_CHECKING, Optional, Union, Literal, Any, Dict
 
 if TYPE_CHECKING:
     from .data_model import DataModel
 
-from SIMULTAN.Data.Taxonomy import SimTaxonomyEntryReference
+from SIMULTAN.Data.Taxonomy import SimTaxonomyEntryReference, SimTaxonomyEntry, SimTaxonomyEntryReference, SimTaxonomy
 
 
 @yaml_object(yaml)
@@ -17,6 +17,14 @@ class Content(object):
     yaml_tag = u'!Content'
 
     def __init__(self,
+                 text_or_key: str,
+                 name: Optional[str] = None,
+                 property_name: Optional[str] = None,
+                 slot_extension: Optional[str] = None,
+                 type: Optional[Any] = None,
+                 unit: Optional[str] = None,
+                 documentation: Optional[str] = None,
+                 component_policy: Optional[Literal['reference', 'subcomponent']] = 'subcomponent',
                  *args,
                  **kwargs):
         """
@@ -24,6 +32,7 @@ class Content(object):
 
         :param args:
         :Keyword Arguments
+            * *name* (``str``) -- name of the Taxonomy Entry in SIMULTAN
             * *text_or_key* (``str``) -- text or key of the content/parameter/property
             * *property_name* (``str``) -- name of the generated property
             * *slot_extension* (``str``) -- slot extension of the content/parameter/property
@@ -33,20 +42,20 @@ class Content(object):
             * *component_policy* (``str``) -- component add policy of the content/parameter/property, 'reference' or 'subcomponent'
         """
 
-        self.name: str = kwargs.get('name', kwargs.get('text_or_key'))
-        self.text_or_key: str = kwargs.get('text_or_key')          # text or key of the content/parameter/property
-        self.property_name: str = kwargs.get('property_name')      # name of the generated property
-        self.slot_extension: str = kwargs.get('slot_extension')    # slot extension of the content/parameter/property
-        self.type = kwargs.get('type', None)                        # type of the content/parameter/property
-        self.unit: Optional[str] = kwargs.get('unit', None)                        # unit of the content/parameter/property
-        self.documentation: Optional[str] = kwargs.get('documentation', None)      # documentation of the content/parameter/property
-        self.component_policy: Literal['reference', 'subcomponent'] = kwargs.get('component_policy', 'reference')  # component add policy of the content/parameter/property, 'reference' or 'subcomponent'
+        self.name: str = name if name is not None else text_or_key # name of the Taxonomy Entry in SIMULTAN
+        self.text_or_key: str = text_or_key          # text or key of the content/parameter/property
+        self.property_name: str = property_name if property_name is not None else text_or_key  # name of the generated property in the python class
+        self.slot_extension: str = slot_extension    # slot extension of the content/parameter/property
+        self.type: Optional[Any] = type                        # type of the content/parameter/property
+        self.unit: Optional[str] = unit                       # unit of the content/parameter/property
+        self.documentation: Optional[str] = documentation       # documentation of the content/parameter/property
+        self.component_policy: Literal['reference', 'subcomponent'] = component_policy  # component add policy of the content/parameter/property, 'reference' or 'subcomponent'
 
         self._taxonomies = {}
         self._taxonomy_entries = {}
-        self._taxonomy_map = kwargs.get('taxonomy_map', None)
+        self._taxonomy_map: Optional['TaxonomyMap'] = kwargs.get('taxonomy_map', None)
 
-        self.taxonomy_key = kwargs.get('taxonomy_key')
+        self.taxonomy_key: Optional[SimTaxonomy] = kwargs.get('taxonomy_key')
 
         add_kwargs = kwargs.copy()
         _ = [add_kwargs.pop(key, None) for key in ['taxonomy_name', 'taxonomy_key', 'taxonomy_entry_name',
@@ -54,10 +63,10 @@ class Content(object):
                                                    'mapped_class', 'unit', 'type', 'component_policy',
                                                    'text_or_key', 'property_name', 'slot_extension']]
 
-        self.additional_attributes = add_kwargs
+        self.additional_attributes: dict[Any, Any] = add_kwargs
 
-        self.taxonomy_key = kwargs.get('taxonomy_key')
-        self.taxonomy_name = kwargs.get('taxonomy_name')
+        self.taxonomy_key: Optional[SimTaxonomy]  = kwargs.get('taxonomy_key')
+        self.taxonomy_name: str = kwargs.get('taxonomy_name')
 
 
     def get_taxonomie_entry(self, data_model: 'DataModel'):
@@ -70,7 +79,7 @@ class Content(object):
                                                              taxonomy_key=self.taxonomy_key,
                                                              create=True)
 
-            self._taxonomy_entries[data_model] = data_model.get_or_create_taxonomy_entry(name=self.text_or_key,
+            self._taxonomy_entries[data_model] = data_model.get_or_create_taxonomy_entry(name=self.name,
                                                                                          key=self.text_or_key,
                                                                                          description=self.documentation,
                                                                                          sim_taxonomy=taxonomy)
@@ -97,29 +106,38 @@ class TaxonomyMap(object):
             taxonomie_map = yaml.load(f)
         return taxonomie_map[0]
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self,
+                 taxonomy_key: str,
+                 taxonomy_entry_key: str,
+                 taxonomy_name: Optional[str] = None,
+                 taxonomy_entry_name: Optional[str] = None,
+                 content: Optional[list[Content]] = None,
+                 documentation: Optional[str] = None,
+                 *args,
+                 **kwargs):
 
         self._content = []
         self._content_dict = {}
         self._parameter_taxonomy_entry_dict = {}
 
-        self.taxonomy_name = kwargs.get('taxonomy_name', kwargs.get('taxonomy_key'))
-        self.taxonomy_key = kwargs.get('taxonomy_key')
+        self.taxonomy_key = taxonomy_key
+        self.taxonomy_name = taxonomy_name if taxonomy_name is not None else taxonomy_key
 
-        if self.taxonomy_key == kwargs.get('taxonomy_entry_key'):
+
+        if self.taxonomy_key == taxonomy_entry_key:
             raise ValueError('taxonomy_key and taxonomy_entry_key must be different')
 
-        self.taxonomy_entry_name = kwargs.get('taxonomy_entry_name', kwargs.get('taxonomy_entry_key'))
-        self.taxonomy_entry_key = kwargs.get('taxonomy_entry_key')
+        self.taxonomy_entry_key = taxonomy_entry_key
+        self.taxonomy_entry_name = taxonomy_entry_name if taxonomy_entry_name is not None else taxonomy_entry_key
 
-        self.content = kwargs.get('content', [])
-        self.documentation = kwargs.get('documentation', '')
+        self.content = content if content is not None else []
+        self.documentation = documentation
 
         self.python_mapper = kwargs.get('python_mapper', None)
         self.mapped_class = kwargs.get('mapped_class', None)
 
-        self._taxonomies = {}
-        self._taxonomy_entries = {}
+        self._taxonomies: Dict[DataModel, SimTaxonomy] = {}
+        self._taxonomy_entries: Dict[DataModel, SimTaxonomyEntry] = {}
 
     @property
     def content(self):
@@ -187,7 +205,7 @@ class TaxonomyMap(object):
 
     def get_or_create_simultan_taxonomy(self,
                                         data_model: 'DataModel',
-                                        create=True):
+                                        create=True) -> SimTaxonomy:
         if self._taxonomies.get(data_model, None) is None:
             self._taxonomies[data_model] = data_model.get_or_create_taxonomy(
                 taxonomy_name=self.taxonomy_name,

PySimultan2/utils.py

@@ -151,7 +151,7 @@ def create_taxonomy(name, key, description='', data_model=None) -> SimTaxonomy:
     :param data_model: data model; if not None, the taxonomy will be added to the data model
     :return: SimTaxonomy
     """
-    new_taxonomy = SimTaxonomy(key, name, description)
+    new_taxonomy = SimTaxonomy(key, name, description, None)
     if data_model is not None:
         data_model.taxonomies.Add(new_taxonomy)
     return new_taxonomy

{pysimultan-0.5.9.6.dist-info → pysimultan-0.5.9.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PySimultan
-Version: 0.5.9.6
+Version: 0.5.9.7
 Project-URL: Documentation, https://github.com/Bühler Maximilian/PySimultan2#readme
 Project-URL: Issues, https://github.com/Bühler Maximilian/PySimultan2/issues
 Project-URL: Source, https://github.com/Bühler Maximilian/PySimultan2
@@ -166,6 +166,10 @@ print(instances[0].param_1)
 
 
 # Change Log
+## [0.5.9.7] - 2025-01-09
+- Added default component support to Mapper: if a default component is not present in the datamodel, it is automatically added
+- Fixed content naming bug: Content.name is now used for the name of the TaxonomyEntry in SIMULTAN
+- Added typing for better code completion
 
 ## [0.5.9.4] - 2024-12-31
 - Fixed bug in DirectoryInfo where \_\_dir_helper_file__ was not found if already existing

{pysimultan-0.5.9.6.dist-info → pysimultan-0.5.9.7.dist-info}/RECORD

@@ -1,15 +1,15 @@
-PySimultan2/CHANGELOG.md,sha256=oibgN_OC1p98_zVtpae5CtPZNLLnpQYd3XGIN0ztniU,484
-PySimultan2/__about__.py,sha256=ptvmvpFwZ_clKafeUlFFn3VFq_2wL5rI09ZmrrGMku8,21
+PySimultan2/CHANGELOG.md,sha256=bRHCRr8oAxy4wd1ZUSztPYmx7_F40KkO3Qm9_H5jCGg,787
+PySimultan2/__about__.py,sha256=AzMoyWtva5vCDZ8GestG4ORgLbm33B3AaD-c_QZaxCI,21
 PySimultan2/__init__.py,sha256=PGVR1uhY01dF5tHyad-znURUZ_LVB95vsjId2BT0aJM,3245
-PySimultan2/data_model.py,sha256=QbxlCb5g2j1Ai-ZFhvstbahLPE5Ll3zaMCLgJC8uolk,37589
+PySimultan2/data_model.py,sha256=3PJdz-coAa69Zct9PmGEB_CeMp-r-s4DQFFdTCwsn6o,37878
 PySimultan2/default_types.py,sha256=P43xVs8ItrxONRwq902-InUmCVXiTYerD0i-PME3KeM,27542
 PySimultan2/files.py,sha256=4wuTfjgOMz6BEEwUDgNmUjfHZj0PYvcuE5-LWz2UEb0,28763
 PySimultan2/multi_values.py,sha256=ZFXlTLuZo32x7_7diYAp2XEjp5uwgHLgNOzN7v74-5I,13650
-PySimultan2/object_mapper.py,sha256=_SQye38NmIr4m_-X9CuvUJnVDBmjmUDdPH2bnaxpzKY,18546
+PySimultan2/object_mapper.py,sha256=BJ4GZvRSZz0KU3ibjBQWnQbgiAzVWsf1b8tLaYrYtpQ,19708
 PySimultan2/simultan_object.py,sha256=akaSUZZWIVfwx1wT5EdOgRR2UeShUthX-LE2Uk6w8CQ,19058
-PySimultan2/taxonomy_maps.py,sha256=K8lwiBkEnQkx40YZxqSJAHdqwuo6ssvkXLL_GBxVYO0,9271
+PySimultan2/taxonomy_maps.py,sha256=hhgXhRXIPTD2briG_yYZssJ9musOnzs0LC4e8e78e40,10323
 PySimultan2/type_setter_lookup.py,sha256=PGa5_EtV7SM15w3uxy0fA3LiQ0TaS4Ys0LYR5zs8aNk,3748
-PySimultan2/utils.py,sha256=0c49o3p4kTpL70ouI31Rjn1Lzu6XPK_YaX2ZHA8cqMg,66829
+PySimultan2/utils.py,sha256=5IPhrmbh72gWa9YxCCJkdaU_vtpA5QNogDYDnduj2uM,66835
 PySimultan2/geometry/__init__.py,sha256=nJolTD1i5J8qUkOQa-r3D20aq3Co3sN31Xc0n4wJpJo,248
 PySimultan2/geometry/geometry_base.py,sha256=TwABfQEsqxAIGLqwvqVXEV-GA5sYGBJSJm7e58QmNzM,24015
 PySimultan2/geometry/utils.py,sha256=J25YsK8sso_UL7xRusItQZvyjtvxdOsSPelBQYFABhY,8519
@@ -75,7 +75,7 @@ PySimultan2/resources/assimp.dll,sha256=HwfDwXqoPDTFRyoQpA3qmgZoUdFtziJkV5fNtktE
 PySimultan2/resources/componentmanager.user,sha256=hrzr1US4pqkFnLHXcvPkvrgGd7QvlxaV8mhS6fuikEs,760
 PySimultan2/resources/defaultsettings.xml,sha256=s6Tk1tubLz5UYqXZWpD42EDHzedemRY1nEneoIVcUfg,392
 PySimultan2/resources/setup.bat,sha256=fjvvYfVM6TalS-QTSiKAbAId5nTsk8kGGo06ba-wWaY,32
-pysimultan-0.5.9.6.dist-info/METADATA,sha256=Y4NHrFi0t1XhhoTLncaHgMnwmFZj9FW02HrXjh7R_hI,6256
-pysimultan-0.5.9.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pysimultan-0.5.9.6.dist-info/licenses/LICENSE.txt,sha256=pmSr98k6N005KMojnZxzLGRuRlDjDx3PUrK1lFj53HA,1126
-pysimultan-0.5.9.6.dist-info/RECORD,,
+pysimultan-0.5.9.7.dist-info/METADATA,sha256=5K3Hf8oJBzmjVOorHvWa4r7lyD-RNT_tfA0_DQ6m9Fo,6550
+pysimultan-0.5.9.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pysimultan-0.5.9.7.dist-info/licenses/LICENSE.txt,sha256=pmSr98k6N005KMojnZxzLGRuRlDjDx3PUrK1lFj53HA,1126
+pysimultan-0.5.9.7.dist-info/RECORD,,