PySimultan 0.5.4__tar.gz → 0.5.6__tar.gz

pysimultan-0.5.6/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.3
+Name: PySimultan
+Version: 0.5.6
+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
+Author-email: Bühler Maximilian <maximilian.buehler@tuwien.ac.at>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Requires-Dist: colorlog
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pyarrow
+Requires-Dist: pythonnet
+Requires-Dist: ruamel-yaml
+Requires-Dist: six
+Requires-Dist: tqdm
+Description-Content-Type: text/markdown
+
+# pysimultan
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pysimultan.svg)](https://pypi.org/project/pysimultan)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pysimultan.svg)](https://pypi.org/project/pysimultan)
+
+PySimultan is a Python library designed to facilitate the creation, manipulation, and management of SIMULTAN data models, taxonomies, and templates. It provides a structured way to define and interact with complex data structures, making it particularly useful for applications that require detailed data organization and templating.  
+Key Features:
+- Data Models: Create and manage data SIMULTAN models with ease.
+- Taxonomies: Define and use taxonomies to categorize and structure data.
+- File and Directory Management: Handle files and directories within the data models.
+- Mapping of Python objects to SIMULTAN data models: Map Python objects to SIMULTAN data models for easy data creation and manipulation.
+- Simple integration in existing Python projects: Easily integrate PySimultan into existing Python projects to enhance data management capabilities.
+
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+- [Usage](#usage)
+- [Change Log](#change-log)
+
+## Installation
+
+```console
+pip install PySimultan
+```
+
+## License
+
+`PySimultan` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+
+
+# Usage
+
+### Data Models
+
+Create a new data model:
+```python
+from PySimultan2 import DataModel
+
+# Create a new data model
+data_model = DataModel.create_new_project(project_path='my_project.simultan',
+                                          user_name='admin',
+                                          password='admin')
+```
+
+Load an existing data model:
+```python
+from PySimultan2 import DataModel
+
+# Load an existing data model
+data_model = DataModel(project_path='my_project.simultan',
+                       user_name='admin',
+                       password='admin')
+```
+
+save the data model:
+```python
+data_model.save()
+```
+
+close and cleanup the data model:
+```python
+data_model.cleanup()
+```
+
+
+### Mapping python to SIMULTAN
+
+#### Create a mapped class:
+```python
+from PySimultan2 import DataModel, TaxonomyMap, Content, PythonMapper
+
+mapper = PythonMapper()
+
+class TestComponent(object):
+    def __init__(self, *args, **kwargs):
+        self.param_1 = kwargs.get('param_1')
+        self.param_2 = kwargs.get('param_2')
+
+content0 = Content(text_or_key='param_1',  # text or key of the content/parameter/property
+                   property_name='param_1',  # name of the generated property
+                   type=None,  # type of the content/parameter/property
+                   unit=None,  # unit of the content/parameter/property
+                   documentation='param_1 to test')
+
+content1 = Content(text_or_key='param_2',  # text or key of the content/parameter/property
+                   property_name='param_2',  # name of the generated property
+                   type=None,  # type of the content/parameter/property
+                   unit=None,  # unit of the content/parameter/property
+                   documentation='param_2 to test')
+
+test_component_map = TaxonomyMap(taxonomy_name='PySimultan',
+                                 taxonomy_key='Test',
+                                 taxonomy_entry_name='test_component',
+                                 taxonomy_entry_key='test_component',
+                                 content=[content0, content1],
+                                 )
+
+mapper.register(test_component_map.taxonomy_entry_key, TestComponent, taxonomy_map=test_component_map)
+```
+
+#### Create an instance of the mapped class:
+```python
+# get the mapped class
+mapped_test_component_cls = mapper.get_mapped_class('test_component')
+
+# create an instance of the mapped class
+mapped_test_component = mapped_test_component_cls(param_1='value1', 
+                                                  param_2='value2',
+                                                  data_model=data_model)
+
+# save the data_model
+data_model.save()
+
+# cleanup the data_model
+data_model.cleanup()
+```
+
+#### Load an instance of the mapped class:
+```python
+# load the data_model
+data_model = DataModel(project_path='my_project.simultan',
+                       user_name='admin',
+                       password='admin')
+                       
+# get the mapped class
+mapped_test_component_cls = mapper.get_mapped_class('test_component')
+
+# get the instances of the mapped class
+instances = mapped_test_component_cls.cls_instaces
+
+print(instances[0].param_1)
+```
+
+
+# Change Log
+
+## [0.4.20] - 2024-07-01
+- Fixed Bug in nested dictionary creation
+
+## [0.4.19] - 2024-07-01
+- Refactored dictionaries 

pysimultan-0.5.6/README.md

@@ -0,0 +1,145 @@
+# pysimultan
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pysimultan.svg)](https://pypi.org/project/pysimultan)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pysimultan.svg)](https://pypi.org/project/pysimultan)
+
+PySimultan is a Python library designed to facilitate the creation, manipulation, and management of SIMULTAN data models, taxonomies, and templates. It provides a structured way to define and interact with complex data structures, making it particularly useful for applications that require detailed data organization and templating.  
+Key Features:
+- Data Models: Create and manage data SIMULTAN models with ease.
+- Taxonomies: Define and use taxonomies to categorize and structure data.
+- File and Directory Management: Handle files and directories within the data models.
+- Mapping of Python objects to SIMULTAN data models: Map Python objects to SIMULTAN data models for easy data creation and manipulation.
+- Simple integration in existing Python projects: Easily integrate PySimultan into existing Python projects to enhance data management capabilities.
+
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+- [Usage](#usage)
+- [Change Log](#change-log)
+
+## Installation
+
+```console
+pip install PySimultan
+```
+
+## License
+
+`PySimultan` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+
+
+# Usage
+
+### Data Models
+
+Create a new data model:
+```python
+from PySimultan2 import DataModel
+
+# Create a new data model
+data_model = DataModel.create_new_project(project_path='my_project.simultan',
+                                          user_name='admin',
+                                          password='admin')
+```
+
+Load an existing data model:
+```python
+from PySimultan2 import DataModel
+
+# Load an existing data model
+data_model = DataModel(project_path='my_project.simultan',
+                       user_name='admin',
+                       password='admin')
+```
+
+save the data model:
+```python
+data_model.save()
+```
+
+close and cleanup the data model:
+```python
+data_model.cleanup()
+```
+
+
+### Mapping python to SIMULTAN
+
+#### Create a mapped class:
+```python
+from PySimultan2 import DataModel, TaxonomyMap, Content, PythonMapper
+
+mapper = PythonMapper()
+
+class TestComponent(object):
+    def __init__(self, *args, **kwargs):
+        self.param_1 = kwargs.get('param_1')
+        self.param_2 = kwargs.get('param_2')
+
+content0 = Content(text_or_key='param_1',  # text or key of the content/parameter/property
+                   property_name='param_1',  # name of the generated property
+                   type=None,  # type of the content/parameter/property
+                   unit=None,  # unit of the content/parameter/property
+                   documentation='param_1 to test')
+
+content1 = Content(text_or_key='param_2',  # text or key of the content/parameter/property
+                   property_name='param_2',  # name of the generated property
+                   type=None,  # type of the content/parameter/property
+                   unit=None,  # unit of the content/parameter/property
+                   documentation='param_2 to test')
+
+test_component_map = TaxonomyMap(taxonomy_name='PySimultan',
+                                 taxonomy_key='Test',
+                                 taxonomy_entry_name='test_component',
+                                 taxonomy_entry_key='test_component',
+                                 content=[content0, content1],
+                                 )
+
+mapper.register(test_component_map.taxonomy_entry_key, TestComponent, taxonomy_map=test_component_map)
+```
+
+#### Create an instance of the mapped class:
+```python
+# get the mapped class
+mapped_test_component_cls = mapper.get_mapped_class('test_component')
+
+# create an instance of the mapped class
+mapped_test_component = mapped_test_component_cls(param_1='value1', 
+                                                  param_2='value2',
+                                                  data_model=data_model)
+
+# save the data_model
+data_model.save()
+
+# cleanup the data_model
+data_model.cleanup()
+```
+
+#### Load an instance of the mapped class:
+```python
+# load the data_model
+data_model = DataModel(project_path='my_project.simultan',
+                       user_name='admin',
+                       password='admin')
+                       
+# get the mapped class
+mapped_test_component_cls = mapper.get_mapped_class('test_component')
+
+# get the instances of the mapped class
+instances = mapped_test_component_cls.cls_instaces
+
+print(instances[0].param_1)
+```
+
+
+# Change Log
+
+## [0.4.20] - 2024-07-01
+- Fixed Bug in nested dictionary creation
+
+## [0.4.19] - 2024-07-01
+- Refactored dictionaries 

pysimultan-0.5.6/src/PySimultan2/__about__.py

@@ -0,0 +1 @@
+version = '0.5.6'

{pysimultan-0.5.4 → pysimultan-0.5.6}/src/PySimultan2/files.py

@@ -129,7 +129,7 @@ def create_asset_from_string(filename: str,
 
         if target_dir is not None:
             if isinstance(target_dir, DirectoryInfo):
-                target_dir = target_dir.current_full_path
+                target_dir = target_dir.full_path
 
             resource = data_model.add_resource(filepath,
                                                target_dir=target_dir)
@@ -324,6 +324,11 @@ class FileInfo(object, metaclass=MetaMock):
         except Exception as e:
             return None
 
+    @property
+    def directory(self) -> DirectoryInfo:
+        return DirectoryInfo(resource_entry=self.resource_entry.Parent,
+                             data_model=self.data_model)
+
     @property
     def resource_entry(self) -> Union[ResourceFileEntry, ContainedResourceFileEntry, None]:
         if self._resource_entry is None:
@@ -505,14 +510,18 @@ class DirectoryInfo(object, metaclass=DirectoryInfoMetaMock):
 
     def __init__(self,
                  path: Optional[str] = None,
+                 helper_file: Optional[FileInfo] = None,
+                 resource_entry: Optional[ResourceDirectoryEntry] = None,
                  *args,
                  **kwargs):
 
         self._resource_entry: Optional[ResourceDirectoryEntry] = None
+        self._helper_file: Optional[FileInfo] = None
         self.data_model: Optional[DataModel] = kwargs.get('data_model', None)
         self.path: str = path
 
-        self.resource_entry = kwargs.get('resource_entry', None)
+        self.resource_entry = resource_entry
+        self.helper_file = helper_file
 
     @property
     def tags(self) -> List[SimTaxonomyEntry]:
@@ -526,6 +535,17 @@ class DirectoryInfo(object, metaclass=DirectoryInfoMetaMock):
     def relative_path(self) -> str:
         return self.resource_entry.CurrentRelativePath
 
+    @property
+    def helper_file(self) -> Optional[FileInfo]:
+        if self._helper_file is None:
+            self._helper_file = self.add_file('__dir_helper_file__')
+
+        return self._helper_file
+
+    @helper_file.setter
+    def helper_file(self, value):
+        self._helper_file = value
+
     @property
     def resource_entry(self) -> Optional[ResourceDirectoryEntry]:
         if self._resource_entry is None:
@@ -578,7 +598,7 @@ class DirectoryInfo(object, metaclass=DirectoryInfoMetaMock):
                                                                                                              (
                                                                                                              ResourceFileEntry,
                                                                                                              ContainedResourceFileEntry)
-                                                                                                             )
+                                                                                                             ) and entry.Name != '__dir_helper_file__'
                 ]
 
     @property
@@ -610,4 +630,4 @@ class DirectoryInfo(object, metaclass=DirectoryInfoMetaMock):
         add_tag_to_resource(self.resource_entry, tag)
 
     def __repr__(self):
-        return f'DirectoryInfo(key:{self.key}, hash: {hash(self)}; {self.full_path};)'
+        return f'DirectoryInfo(key:{self.key}, hash: {hash(self)}; {self.full_path})'

{pysimultan-0.5.4 → pysimultan-0.5.6}/src/PySimultan2/utils.py

@@ -770,6 +770,13 @@ def get_resource_entry_value(obj: ResourceEntry,
                              data_model: DataModel = None,
                              object_mapper: PythonMapper = None) -> Union[FileInfo, DirectoryInfo]:
     if isinstance(obj, (ResourceFileEntry, ContainedResourceFileEntry, LinkedResourceFileEntry)):
+
+        if obj.Name == '__dir_helper_file__':
+            return DirectoryInfo(file_path=obj.Parent.CurrentFullPath,
+                                 resource_entry=obj.Parent,
+                                 helper_file=obj,
+                                 data_model=data_model)
+
         return FileInfo(file_path=obj.File.FullPath,
                         resource_entry=obj,
                         data_model=data_model)
@@ -1203,7 +1210,7 @@ def set_property_to_directory_info(value: DirectoryInfo,
         ref_asset_idx = None
 
     add_asset_to_component(component._wrapped_obj,
-                           value.resource_entry,
+                           value.helper_file.resource_entry,
                            '0',
                            tag=taxonomy_entry)
 

pysimultan-0.5.6/tests/test_directory_and_files.py

@@ -0,0 +1,154 @@
+import os
+from PySimultan2.src.PySimultan2 import DataModel, TaxonomyMap, Content, PythonMapper
+from PySimultan2.src.PySimultan2.files import FileInfo, DirectoryInfo
+
+
+project_dir = os.environ.get('PROJECT_DIR', '/simultan_projects')
+if not os.path.exists(project_dir):
+    os.makedirs(project_dir)
+
+
+def test_files_and_directory_creation():
+    new_data_model = DataModel.create_new_project(project_path=os.path.join(project_dir, 'test_dir_files.simultan'),
+                                                  user_name='admin',
+                                                  password='admin')
+
+    print(new_data_model.file_directories)
+
+
+    new_directory_info = DirectoryInfo(path='directory_info_dir',
+                                       data_model=new_data_model)
+
+    print(new_data_model.file_directories)
+
+    print(new_directory_info.resource_entry)
+    print(new_directory_info.parent)
+
+    new_file1 = new_directory_info.add_file('test_add_file.txt', 'This is a test file')
+    new_file2 = new_directory_info.add_file('test_add_file2.txt')
+
+    sub_directory_info = new_directory_info.add_sub_directory('sub_dir')
+    print(sub_directory_info.parent)
+
+    print(new_directory_info.sub_directories)
+
+
+    new_directory = new_data_model.create_resource_directory('test_dir')
+    new_directory2 = new_data_model.create_resource_directory('test_dir2')
+    new_directory4 = new_data_model.create_resource_directory('test_dir3')
+
+    new_data_model.add_empty_resource(filename=os.path.join(new_directory.CurrentFullPath, 'test_empty_file.txt'))
+
+    new_data_model.add_empty_resource(filename='test_empty_file2.txt',
+                                      target_dir=new_directory)
+
+    new_file_info0 = FileInfo.from_string(filename='test_file.txt',
+                                          content='This is a test file',
+                                          data_model=new_data_model)
+
+    new_file_info = FileInfo.from_string(filename='test_file.txt',
+                                         content='This is a test file',
+                                         target_dir=new_directory,
+                                         data_model=new_data_model)
+
+    new_file_info2 = FileInfo.from_string(filename='test_file2.txt',
+                                         content='This is a test file 2',
+                                         target_dir=new_directory2.current_full_path,
+                                         data_model=new_data_model)
+
+    # create just a file in the directory
+    with open(os.path.join(new_directory2.current_full_path, 'not_contained_test_file3.txt'), 'w') as f:
+        f.write('This is a test file 3')
+
+
+    new_data_model.save()
+    new_data_model.cleanup()
+
+
+def create_mapper():
+    mapper = PythonMapper()
+
+    class TestComponent(object):
+        def __init__(self, *args, **kwargs):
+            self.file = kwargs.get('file')
+            self.directory = kwargs.get('directory')
+            self.param_1 = kwargs.get('param_1')
+            self.param_2 = kwargs.get('param_2')
+
+    content0 = Content(text_or_key='file',  # text or key of the content/parameter/property
+                       property_name='file',  # name of the generated property
+                       type='file',  # type of the content/parameter/property
+                       unit=None,  # unit of the content/parameter/property
+                       documentation='file_value to test')
+
+    content1 = Content(text_or_key='directory',  # text or key of the content/parameter/property
+                       property_name='directory',  # name of the generated property
+                       type='file',  # type of the content/parameter/property
+                       unit=None,  # unit of the content/parameter/property
+                       documentation='file_value_2 to test')
+
+    content2 = Content(text_or_key='param_1',  # text or key of the content/parameter/property
+                       property_name='param_1',  # name of the generated property
+                       type=None,  # type of the content/parameter/property
+                       unit=None,  # unit of the content/parameter/property
+                       documentation='param_1 to test')
+
+    content3 = Content(text_or_key='param_2',  # text or key of the content/parameter/property
+                       property_name='param_2',  # name of the generated property
+                       type=None,  # type of the content/parameter/property
+                       unit=None,  # unit of the content/parameter/property
+                       documentation='param_2 to test')
+
+    test_component_map = TaxonomyMap(taxonomy_name='PySimultan',
+                                     taxonomy_key='Test',
+                                     taxonomy_entry_name='test_component',
+                                     taxonomy_entry_key='test_component',
+                                     content=[content0, content1, content2, content3],
+                                     )
+
+    mapper.register(test_component_map.taxonomy_entry_key, TestComponent, taxonomy_map=test_component_map)
+
+    return mapper
+
+
+def test_component_with_directory():
+
+    new_data_model = DataModel.create_new_project(project_path=os.path.join(project_dir, 'test_dir_component.simultan'),
+                                                  user_name='admin',
+                                                  password='admin')
+
+    mapper = create_mapper()
+    mapped_test_component_cls = mapper.get_mapped_class('test_component')
+
+    new_component = mapped_test_component_cls(file=FileInfo.from_string(filename='test_file.txt',
+                                                                                    content='This is a test file',
+                                                                                    data_model=new_data_model),
+                                                directory=DirectoryInfo(path='test_dir',
+                                                                        data_model=new_data_model),
+                                                param_1='param_1_value',
+                                                param_2=2)
+
+    print(new_component.directory)
+
+    new_data_model.save()
+    new_data_model.cleanup()
+    mapper.clear()
+
+
+def test_load_component_with_directory():
+    new_data_model = DataModel(project_path=os.path.join(project_dir, 'test_dir_component.simultan'))
+
+    mapper = create_mapper()
+    typed_data = new_data_model.get_typed_data(mapper=mapper)
+    mapped_test_component_cls = mapper.get_mapped_class('test_component')
+
+    assert isinstance(mapped_test_component_cls.cls_instances[0].directory,  DirectoryInfo)
+
+    new_data_model.cleanup()
+    mapper.clear()
+
+
+if __name__ == '__main__':
+    # test_files_and_directory_creation()
+    test_component_with_directory()
+    test_load_component_with_directory()

pysimultan-0.5.4/PKG-INFO

@@ -1,91 +0,0 @@
-Metadata-Version: 2.3
-Name: PySimultan
-Version: 0.5.4
-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
-Author-email: Bühler Maximilian <maximilian.buehler@tuwien.ac.at>
-License: MIT
-Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.8
-Requires-Dist: colorlog
-Requires-Dist: numpy
-Requires-Dist: pandas
-Requires-Dist: pyarrow
-Requires-Dist: pythonnet
-Requires-Dist: ruamel-yaml
-Requires-Dist: six
-Requires-Dist: tqdm
-Description-Content-Type: text/markdown
-
-# pysimultan_api
-
-[![PyPI - Version](https://img.shields.io/pypi/v/pysimultan-api.svg)](https://pypi.org/project/pysimultan-api)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pysimultan-api.svg)](https://pypi.org/project/pysimultan-api)
-
------
-
-## Table of Contents
-
-- [Installation](#installation)
-- [License](#license)
-- [Usage](#usage)
-- [FreeCAD support](#freecad-support)
-- [Change Log](#change-log)
-
-## Installation
-
-```console
-pip install PySimultan
-```
-
-## License
-
-`pysimultan-api` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
-
-
-### Usage
-
-```python
-from PySimultan2 import DataModel, Content, TaxonomyMap, PythonMapper
-```
-
-
-## FreeCAD support
-
-PySimultanUI looks for a FreeCAD version in C:\Program Files\FreeCAD. If you don't have FreeCAD installed, you can 
-download it from the FreeCAD website or use the FreeCAD version provided in the FreeCAD-Bundle repository.
-Go to https://github.com/FreeCAD/FreeCAD-Bundle/releases/tag/weekly-builds and download the latest version 
-of FreeCAD for your OS. The version must be compiled with the same python version you are using (e.g. py311). 
-
-Extract the zip file to C:\Program Files\FreeCAD
-
-The directory structure should look like this:
-
-```
-C:\Program Files\FreeCAD
-│   ...
-│   FreeCAD_weekly-builds-37730-conda-Windows-x86_64-py311
-│       │   bin
-│       │   lib
-│       │   ...
-│
-
-```
-
-
-# Change Log
-
-## [0.4.20] - 2024-07-01
-- Fixed Bug in nested dictionary creation
-
-## [0.4.19] - 2024-07-01
-- Refactored dictionaries