dlubal.api 2.9.2rc3__tar.gz → 2.9.4__tar.gz

dlubal_api-2.9.4/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.2
+Name: dlubal.api
+Version: 2.9.4
+Summary: Python Client Library for Dlubal Software APIs powered by gRPC
+Author: Dlubal Software
+Author-email: api@dlubal.com
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+Requires-Dist: grpcio==1.68.0
+Requires-Dist: grpcio-tools==1.68.0
+Requires-Dist: pandas==2.2.3
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+# Dlubal API 2.0
+
+![PyPI](https://img.shields.io/pypi/v/dlubal.api)
+![Python](https://img.shields.io/badge/Python-3.7%2B-blue)
+![License](https://img.shields.io/badge/License-Proprietary-red)
+
+## Overview
+The `dlubal.api` package is the next-generation Python client library for interacting with Dlubal Software APIs, leveraging modern **gRPC technology** to deliver high-speed communication, scalability, and improved performance. This API enables **seamless automation** and **remote access** to Dlubal software like **RFEM 6**, with near future support for **RSTAB 9** and **RSECTION 1**.
+
+## Key Features
+- **Unified API**: Works across all Dlubal applications, starting with **RFEM**.
+- **Performance Boost**: 5-10x faster execution than previous implementations.
+- **Seamless Model Export**: Generate Python scripts directly from RFEM models.
+- **Blocks & Components**: Define reusable components for efficient model parametrization.
+- **AI-Driven Tools**: Leverage AI-based features (e.g., **MIA** powered by structured data).
+- **Flexible Licensing**: Supports **on-premises** and **cloud-based** workflows.
+- **Secure & Scalable**: API authentication via API keys, with **fine-grained access control**.
+
+---
+
+## Installation
+
+Ensure you have **Python 3.10+** installed. Then, install the package via **pip**:
+
+```sh
+pip install dlubal.api
+```
+
+For additional installation options, refer to the **official documentation**.
+
+---
+
+## Quick Start
+
+### Authentication & Authorization
+To access the API, you need:
+- **Authentication**: API Keys which can be generated in your Extranet user account under the API & Cloud Dashboard.
+- **Authorization**: Active API Service subscription (license-based).
+
+Be aware, certain API methods are monetized by **API Credits**!.
+
+---
+
+### Example Usage
+```python
+import dlubal.api.rfem
+
+with rfem.Application(api_key="your_api_key") as rfem_app:
+    # Example API call
+    rfem_app.create_model("MyModel")
+    rfem_app.create_object(
+        rfem.structure_core.Node(coordinate_1=2)
+    )
+```
+
+## Documentation & Support
+- 📖 **API Documentation**: [API Docs](https://www.dlubal.com/en/solutions/dlubal-api/api-documentation/index)
+- 💬 **Support**: Contact [Dlubal Support](https://www.dlubal.com/en/support-and-learning)
+- 🔑 **Extranet**: [API & Cloud Dashboard](https://extranet.dlubal.com)
+
+---
+
+## License
+This package is proprietary software and requires an **active API Service subscription**. Unauthorized use is prohibited.
+

dlubal_api-2.9.4/README.md

@@ -0,0 +1,65 @@
+# Dlubal API 2.0
+
+![PyPI](https://img.shields.io/pypi/v/dlubal.api)
+![Python](https://img.shields.io/badge/Python-3.7%2B-blue)
+![License](https://img.shields.io/badge/License-Proprietary-red)
+
+## Overview
+The `dlubal.api` package is the next-generation Python client library for interacting with Dlubal Software APIs, leveraging modern **gRPC technology** to deliver high-speed communication, scalability, and improved performance. This API enables **seamless automation** and **remote access** to Dlubal software like **RFEM 6**, with near future support for **RSTAB 9** and **RSECTION 1**.
+
+## Key Features
+- **Unified API**: Works across all Dlubal applications, starting with **RFEM**.
+- **Performance Boost**: 5-10x faster execution than previous implementations.
+- **Seamless Model Export**: Generate Python scripts directly from RFEM models.
+- **Blocks & Components**: Define reusable components for efficient model parametrization.
+- **AI-Driven Tools**: Leverage AI-based features (e.g., **MIA** powered by structured data).
+- **Flexible Licensing**: Supports **on-premises** and **cloud-based** workflows.
+- **Secure & Scalable**: API authentication via API keys, with **fine-grained access control**.
+
+---
+
+## Installation
+
+Ensure you have **Python 3.10+** installed. Then, install the package via **pip**:
+
+```sh
+pip install dlubal.api
+```
+
+For additional installation options, refer to the **official documentation**.
+
+---
+
+## Quick Start
+
+### Authentication & Authorization
+To access the API, you need:
+- **Authentication**: API Keys which can be generated in your Extranet user account under the API & Cloud Dashboard.
+- **Authorization**: Active API Service subscription (license-based).
+
+Be aware, certain API methods are monetized by **API Credits**!.
+
+---
+
+### Example Usage
+```python
+import dlubal.api.rfem
+
+with rfem.Application(api_key="your_api_key") as rfem_app:
+    # Example API call
+    rfem_app.create_model("MyModel")
+    rfem_app.create_object(
+        rfem.structure_core.Node(coordinate_1=2)
+    )
+```
+
+## Documentation & Support
+- 📖 **API Documentation**: [API Docs](https://www.dlubal.com/en/solutions/dlubal-api/api-documentation/index)
+- 💬 **Support**: Contact [Dlubal Support](https://www.dlubal.com/en/support-and-learning)
+- 🔑 **Extranet**: [API & Cloud Dashboard](https://extranet.dlubal.com)
+
+---
+
+## License
+This package is proprietary software and requires an **active API Service subscription**. Unauthorized use is prohibited.
+

{dlubal_api-2.9.2rc3 → dlubal_api-2.9.4}/dlubal/api/common/connection.py

@@ -90,11 +90,6 @@ class _ApiKey():
     '''
     def __init__(self, key=None , value=None):
 
-        # Value sanity check
-        if value and not value.startswith(('AK','ak')):
-            print("ERROR: Invalid API key. Please check the API key format.")
-            exit()
-
         self.key = key
         self.value = value
         self.config = _config()
@@ -119,16 +114,6 @@ class _ApiKey():
                 if default_key:
                     # Print only if key is found
                     print(f'API key: {self.config.get_name_of_default()}')
-            # If there is no default key, envoke prompt
-            elif self.value is None and prompt:
-                # If there is no default key, raise an error
-                self.value = input('API key was not found. Please, enter your API key value:\n')
-                store_api = input('Would you like to store your API key for future use? y/n\n')
-                if store_api.lower() == 'y':
-                    key_input = input('Please, enter API key identificator (e.g.RFEM_API_KEY).\n')
-                    if isinstance(key_input, str):
-                        self.key = key_input
-                        self.config.set_value(self.key, self.value)
 
     def get(self, key=None):
         '''
@@ -182,7 +167,7 @@ def check_ssl(_ssl, _ssl_file):
         _ssl_file (str):Path to .crt/.pem certificate.
     '''
     if _ssl is False:
-        print('SSL not used.')
+        pass
     elif _ssl is True:
         if isinstance(_ssl_file, str) and os.path.isfile(_ssl_file) and _ssl_file.endswith(('.crt', '.pem')):
             # Use provided file
@@ -192,7 +177,6 @@ def check_ssl(_ssl, _ssl_file):
             pass
         else:
             # Provided path is not correct
-            print("ERROR: Invalid SSL path. Please check path to SSL certificate.")
             exit()
 
     return True
@@ -205,17 +189,12 @@ def _get_ssl_credentials(_ssl_file) -> grpc.ChannelCredentials:
     path (str): Path to the SSL (.crt) certificate filepath
     '''
     if _ssl_file == '':
-        '''
-        Credit: https://github.com/grpc/grpc/issues/25533#issuecomment-1830823902
-        '''
-        print('Using Windows Cert Store.')
         certs = ssl.create_default_context().get_ca_certs(True)
         cert_string = ''
         for cert in certs:
             cert_string += ssl.DER_cert_to_PEM_cert(cert)
         return grpc.ssl_channel_credentials(root_certificates=cert_string.encode('utf-8'))
     else:
-        print('Using SSL file')
         cert_file = open(_ssl_file, 'rb')
         return grpc.ssl_channel_credentials(cert_file.read())
 

{dlubal_api-2.9.2rc3 → dlubal_api-2.9.4}/dlubal/api/common/model_id_pb2.py

@@ -24,7 +24,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n dlubal/api/common/model_id.proto\x12\x11\x64lubal.api.common\"\x15\n\x07ModelId\x12\n\n\x02id\x18\x01 \x01(\t\")\n\x0fOptionalModelId\x12\x0f\n\x02id\x18\x01 \x01(\tH\x00\x88\x01\x01\x42\x05\n\x03_idb\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n dlubal/api/common/model_id.proto\x12\x11\x64lubal.api.common\"\x17\n\x07ModelId\x12\x0c\n\x04guid\x18\x01 \x01(\t\"-\n\x0fOptionalModelId\x12\x11\n\x04guid\x18\x01 \x01(\tH\x00\x88\x01\x01\x42\x07\n\x05_guidb\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -32,7 +32,7 @@ _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'dlubal.api.common.model_id_
 if not _descriptor._USE_C_DESCRIPTORS:
   DESCRIPTOR._loaded_options = None
   _globals['_MODELID']._serialized_start=55
-  _globals['_MODELID']._serialized_end=76
-  _globals['_OPTIONALMODELID']._serialized_start=78
-  _globals['_OPTIONALMODELID']._serialized_end=119
+  _globals['_MODELID']._serialized_end=78
+  _globals['_OPTIONALMODELID']._serialized_start=80
+  _globals['_OPTIONALMODELID']._serialized_end=125
 # @@protoc_insertion_point(module_scope)

dlubal_api-2.9.4/dlubal/api/common/model_id_pb2.pyi

@@ -0,0 +1,17 @@
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Optional as _Optional
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class ModelId(_message.Message):
+    __slots__ = ("guid",)
+    GUID_FIELD_NUMBER: _ClassVar[int]
+    guid: str
+    def __init__(self, guid: _Optional[str] = ...) -> None: ...
+
+class OptionalModelId(_message.Message):
+    __slots__ = ("guid",)
+    GUID_FIELD_NUMBER: _ClassVar[int]
+    guid: str
+    def __init__(self, guid: _Optional[str] = ...) -> None: ...

{dlubal_api-2.9.2rc3 → dlubal_api-2.9.4}/dlubal/api/rfem/__init__.py

@@ -1,5 +1,6 @@
 from .application import *
 from .application_pb2 import *
+from .object_type_pb2 import *
 from . import aluminum_design_objects
 from . import base_data
 from . import building_model

{dlubal_api-2.9.2rc3 → dlubal_api-2.9.4}/dlubal/api/rfem/aluminum_design_objects/aluminum_design_sls_configuration_pb2.py

@@ -24,7 +24,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\nOdlubal/api/rfem/aluminum_design_objects/aluminum_design_sls_configuration.proto\x12\'dlubal.api.rfem.aluminum_design_objects\"\xfe\x03\n\x1e\x41luminumDesignSlsConfiguration\x12\n\n\x02no\x18\x01 \x01(\x05\x12&\n\x19user_defined_name_enabled\x18\x02 \x01(\x08H\x00\x88\x01\x01\x12\x11\n\x04name\x18\x03 \x01(\tH\x01\x88\x01\x01\x12$\n\x17\x61ssigned_to_all_members\x18\x04 \x01(\x08H\x02\x88\x01\x01\x12\x1b\n\x13\x61ssigned_to_members\x18\x05 \x03(\x05\x12(\n\x1b\x61ssigned_to_all_member_sets\x18\x06 \x01(\x08H\x03\x88\x01\x01\x12\x1f\n\x17\x61ssigned_to_member_sets\x18\x07 \x03(\x05\x12\x14\n\x07\x63omment\x18\x08 \x01(\tH\x04\x88\x01\x01\x12!\n\x14id_for_export_import\x18\t \x01(\tH\x05\x88\x01\x01\x12\'\n\x1ametadata_for_export_import\x18\n \x01(\tH\x06\x88\x01\x01\x42\x1c\n\x1a_user_defined_name_enabledB\x07\n\x05_nameB\x1a\n\x18_assigned_to_all_membersB\x1e\n\x1c_assigned_to_all_member_setsB\n\n\x08_commentB\x17\n\x15_id_for_export_importB\x1d\n\x1b_metadata_for_export_importb\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\nOdlubal/api/rfem/aluminum_design_objects/aluminum_design_sls_configuration.proto\x12\'dlubal.api.rfem.aluminum_design_objects\"\x8a\x04\n\x1e\x41luminumDesignSlsConfiguration\x12\x0f\n\x02no\x18\x01 \x01(\x05H\x00\x88\x01\x01\x12&\n\x19user_defined_name_enabled\x18\x02 \x01(\x08H\x01\x88\x01\x01\x12\x11\n\x04name\x18\x03 \x01(\tH\x02\x88\x01\x01\x12$\n\x17\x61ssigned_to_all_members\x18\x04 \x01(\x08H\x03\x88\x01\x01\x12\x1b\n\x13\x61ssigned_to_members\x18\x05 \x03(\x05\x12(\n\x1b\x61ssigned_to_all_member_sets\x18\x06 \x01(\x08H\x04\x88\x01\x01\x12\x1f\n\x17\x61ssigned_to_member_sets\x18\x07 \x03(\x05\x12\x14\n\x07\x63omment\x18\x08 \x01(\tH\x05\x88\x01\x01\x12!\n\x14id_for_export_import\x18\t \x01(\tH\x06\x88\x01\x01\x12\'\n\x1ametadata_for_export_import\x18\n \x01(\tH\x07\x88\x01\x01\x42\x05\n\x03_noB\x1c\n\x1a_user_defined_name_enabledB\x07\n\x05_nameB\x1a\n\x18_assigned_to_all_membersB\x1e\n\x1c_assigned_to_all_member_setsB\n\n\x08_commentB\x17\n\x15_id_for_export_importB\x1d\n\x1b_metadata_for_export_importb\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -32,5 +32,5 @@ _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'dlubal.api.rfem.aluminum_de
 if not _descriptor._USE_C_DESCRIPTORS:
   DESCRIPTOR._loaded_options = None
   _globals['_ALUMINUMDESIGNSLSCONFIGURATION']._serialized_start=125
-  _globals['_ALUMINUMDESIGNSLSCONFIGURATION']._serialized_end=635
+  _globals['_ALUMINUMDESIGNSLSCONFIGURATION']._serialized_end=647
 # @@protoc_insertion_point(module_scope)

{dlubal_api-2.9.2rc3 → dlubal_api-2.9.4}/dlubal/api/rfem/aluminum_design_objects/aluminum_design_uls_configuration_pb2.py

@@ -24,7 +24,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\nOdlubal/api/rfem/aluminum_design_objects/aluminum_design_uls_configuration.proto\x12\'dlubal.api.rfem.aluminum_design_objects\"\xfe\x03\n\x1e\x41luminumDesignUlsConfiguration\x12\n\n\x02no\x18\x01 \x01(\x05\x12&\n\x19user_defined_name_enabled\x18\x02 \x01(\x08H\x00\x88\x01\x01\x12\x11\n\x04name\x18\x03 \x01(\tH\x01\x88\x01\x01\x12$\n\x17\x61ssigned_to_all_members\x18\x04 \x01(\x08H\x02\x88\x01\x01\x12\x1b\n\x13\x61ssigned_to_members\x18\x05 \x03(\x05\x12(\n\x1b\x61ssigned_to_all_member_sets\x18\x06 \x01(\x08H\x03\x88\x01\x01\x12\x1f\n\x17\x61ssigned_to_member_sets\x18\x07 \x03(\x05\x12\x14\n\x07\x63omment\x18\x08 \x01(\tH\x04\x88\x01\x01\x12!\n\x14id_for_export_import\x18\t \x01(\tH\x05\x88\x01\x01\x12\'\n\x1ametadata_for_export_import\x18\n \x01(\tH\x06\x88\x01\x01\x42\x1c\n\x1a_user_defined_name_enabledB\x07\n\x05_nameB\x1a\n\x18_assigned_to_all_membersB\x1e\n\x1c_assigned_to_all_member_setsB\n\n\x08_commentB\x17\n\x15_id_for_export_importB\x1d\n\x1b_metadata_for_export_importb\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\nOdlubal/api/rfem/aluminum_design_objects/aluminum_design_uls_configuration.proto\x12\'dlubal.api.rfem.aluminum_design_objects\"\x8a\x04\n\x1e\x41luminumDesignUlsConfiguration\x12\x0f\n\x02no\x18\x01 \x01(\x05H\x00\x88\x01\x01\x12&\n\x19user_defined_name_enabled\x18\x02 \x01(\x08H\x01\x88\x01\x01\x12\x11\n\x04name\x18\x03 \x01(\tH\x02\x88\x01\x01\x12$\n\x17\x61ssigned_to_all_members\x18\x04 \x01(\x08H\x03\x88\x01\x01\x12\x1b\n\x13\x61ssigned_to_members\x18\x05 \x03(\x05\x12(\n\x1b\x61ssigned_to_all_member_sets\x18\x06 \x01(\x08H\x04\x88\x01\x01\x12\x1f\n\x17\x61ssigned_to_member_sets\x18\x07 \x03(\x05\x12\x14\n\x07\x63omment\x18\x08 \x01(\tH\x05\x88\x01\x01\x12!\n\x14id_for_export_import\x18\t \x01(\tH\x06\x88\x01\x01\x12\'\n\x1ametadata_for_export_import\x18\n \x01(\tH\x07\x88\x01\x01\x42\x05\n\x03_noB\x1c\n\x1a_user_defined_name_enabledB\x07\n\x05_nameB\x1a\n\x18_assigned_to_all_membersB\x1e\n\x1c_assigned_to_all_member_setsB\n\n\x08_commentB\x17\n\x15_id_for_export_importB\x1d\n\x1b_metadata_for_export_importb\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -32,5 +32,5 @@ _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'dlubal.api.rfem.aluminum_de
 if not _descriptor._USE_C_DESCRIPTORS:
   DESCRIPTOR._loaded_options = None
   _globals['_ALUMINUMDESIGNULSCONFIGURATION']._serialized_start=125
-  _globals['_ALUMINUMDESIGNULSCONFIGURATION']._serialized_end=635
+  _globals['_ALUMINUMDESIGNULSCONFIGURATION']._serialized_end=647
 # @@protoc_insertion_point(module_scope)

{dlubal_api-2.9.2rc3 → dlubal_api-2.9.4}/dlubal/api/rfem/application.py

@@ -8,6 +8,7 @@ from dlubal.api.common.table import Table
 from dlubal.api.common.table_data_pb2 import TableData
 from dlubal.api.rfem.results import ResultsId
 from dlubal.api.rfem.results.results_query_pb2 import ResultsQuery, ResultsFilter
+import grpc
 
 from collections.abc import Iterable
 from pandas import DataFrame
@@ -52,32 +53,27 @@ class Application:
         '''
         return self
 
-    def __exit__(self, exc, value, traceback):
+    def __exit__(self, exc_type, exc_value, traceback):
         '''
-        Ensure the session is finished and channel is closed properly
+        Ensure the session is finished and channel is closed properly before handling exceptions.
         '''
-        self.close_connection()
-
-        # Exception handler
-        if traceback or value:
-            exception_handler(exc, value, traceback)
-
-            dash = '-'
-            print(f'URL: {self.url if self.url else dash}, port: {self.port if self.port else dash}')
-            print(f'API key: {"..."+self.api_key.value[-6:] if self.api_key.value else dash}')
-            if self.ssl:
-                if self.ssl_file:
-                    print(f'SSL certificate: {self.ssl_file}')
-                else:
-                    print('SSL certificate: installed certificate (Windows Certification Store)')
-        else:
-            # Don't put any lines to indicate successfull termination.
-            # read: https://www.joelonsoftware.com/2000/04/26/designing-for-people-who-have-better-things-to-do-with-their-lives/
+
+        # Attempt to close the connection first to prevent delays
+        try:
+            self.close_connection()
+        except Exception as e:
             pass
 
-        return True
+        # Now handle exceptions that occurred in the `with` block
+        if exc_type is not None:
+            if issubclass(exc_type, grpc.RpcError):
+                raise RuntimeError(f"gRPC Error: {exc_value.code().name} - {exc_value.details()}") from None
+            elif issubclass(exc_type, (SystemExit, KeyboardInterrupt)):
+                return False
+            raise RuntimeError(f"Unexpected error: {str(exc_value)}") from None
 
     # Functions using packing
+
     def get_object(self, obj, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None):
         '''
         Retrieves a single object from the model using only the `no` argument in the object arguments.
@@ -115,22 +111,23 @@ class Application:
             model_id (:ref:`ModelId` | None): Unique identifier of the model.
 
         Returns:
-            None
+           ObjectId: ID of the created object
         '''
-        self.stub.create_object_impl(pack_object(obj, model_id))
+        return self.stub.create_object_impl(pack_object(obj, model_id))
 
-    def create_object_list(self, objs, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None):
+    def create_object_list(self, objs, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None, return_object_id=False):
         '''
         Creates a list of objects in the model.
 
         Args:
             objs (list[obj]): A list of objects to be created. Refer to the :ref:`rfem_objects` for available objects.
             model_id (:ref:`ModelId` | None): Unique identifier of the model.
+            return_object_id (bool): Specifies whether to return the list of object IDs.
 
         Returns:
-            None
+            ObjectIdList | None: List of IDs of the created objects if `return_object_id` is True, otherwise None.
         '''
-        self.stub.create_object_list_impl(pack_object_list(objs, model_id))
+        return self.stub.create_object_list_impl(pack_object_list(objs, model_id, return_object_id))
 
     def update_object(self, obj, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None):
         '''
@@ -282,6 +279,15 @@ class Application:
         """
         return self.stub.get_active_model(google.protobuf.empty_pb2.Empty())
 
+    def set_active_model(self, *, model_id: dlubal.api.common.model_id_pb2.ModelId):
+        """
+        Sets active model specified by model id
+
+        Args:
+            model_id (:ref:`ModelId` | None): Unique identifier of the model.
+        """
+        self.stub.set_active_model(model_id)
+
     def close_application(self):
         """
         Closes the whole application
@@ -312,15 +318,15 @@ class Application:
         """
         self.stub.close_connection(google.protobuf.empty_pb2.Empty())
 
-    def delete_all_objects(self, *, id: str | None = None):
+    def delete_all_objects(self, *, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None):
         """
         Deletes all objects
 
         Args:
-            id (str | None): Unique identifier of the model.
+            model_id (:ref:`ModelId` | None): Unique identifier of the model.
         Active model is used if this field is not set.
         """
-        request = dlubal.api.common.model_id_pb2.OptionalModelId(id=id)
+        request = dlubal.api.common.model_id_pb2.OptionalModelId(guid=model_id.guid)
         self.stub.delete_all_objects(request)
 
     def calculate_all(self, *, skip_warnings: bool, model_id: dlubal.api.common.model_id_pb2.ModelId | None = None) -> dlubal.api.rfem.application_pb2.OperationResult:

dlubal_api-2.9.4/dlubal/api/rfem/application_pb2.py

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: dlubal/api/rfem/application.proto
+# Protobuf Python Version: 5.28.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    5,
+    28,
+    1,
+    '',
+    'dlubal/api/rfem/application.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.protobuf import any_pb2 as google_dot_protobuf_dot_any__pb2
+from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2
+from dlubal.api.common import model_id_pb2 as dlubal_dot_api_dot_common_dot_model__id__pb2
+from dlubal.api.common import table_data_pb2 as dlubal_dot_api_dot_common_dot_table__data__pb2
+from dlubal.api.rfem import object_type_pb2 as dlubal_dot_api_dot_rfem_dot_object__type__pb2
+from dlubal.api.rfem.results import results_query_pb2 as dlubal_dot_api_dot_rfem_dot_results_dot_results__query__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n!dlubal/api/rfem/application.proto\x12\x0f\x64lubal.api.rfem\x1a\x19google/protobuf/any.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a dlubal/api/common/model_id.proto\x1a\"dlubal/api/common/table_data.proto\x1a!dlubal/api/rfem/object_type.proto\x1a+dlubal/api/rfem/results/results_query.proto\"P\n\x12\x43reateModelRequest\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x1a\n\rtemplate_path\x18\x02 \x01(\tH\x00\x88\x01\x01\x42\x10\n\x0e_template_path\" \n\x10OpenModelRequest\x12\x0c\n\x04path\x18\x01 \x01(\t\"^\n\x12SaveModelAsRequest\x12,\n\x08model_id\x18\x01 \x01(\x0b\x32\x1a.dlubal.api.common.ModelId\x12\x11\n\x04path\x18\x02 \x01(\tH\x00\x88\x01\x01\x42\x07\n\x05_path\"W\n\x11\x43loseModelRequest\x12,\n\x08model_id\x18\x01 \x01(\x0b\x32\x1a.dlubal.api.common.ModelId\x12\x14\n\x0csave_changes\x18\x02 \x01(\x08\"-\n\x15\x43loseAllModelsRequest\x12\x14\n\x0csave_changes\x18\x01 \x01(\x08\"C\n\tModelInfo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x0c\n\x04guid\x18\x02 \x01(\t\x12\x11\n\x04path\x18\x03 \x01(\tH\x00\x88\x01\x01\x42\x07\n\x05_path\";\n\tModelList\x12.\n\nmodel_info\x18\x01 \x03(\x0b\x32\x1a.dlubal.api.rfem.ModelInfo\"\xcf\x01\n\x0f\x41pplicationInfo\x12\x0c\n\x04name\x18\x01 \x01(\t\x12.\n\x04type\x18\x02 \x01(\x0e\x32 .dlubal.api.rfem.ApplicationType\x12\x1a\n\x12is_server_instance\x18\x03 \x01(\x08\x12\x0f\n\x07version\x18\x04 \x01(\t\x12\x14\n\x0c\x66ull_version\x18\x05 \x01(\t\x12\x0f\n\x07options\x18\x06 \x01(\t\x12\x15\n\rlanguage_name\x18\x07 \x01(\t\x12\x13\n\x0blanguage_id\x18\x08 \x01(\t\"n\n\x06Object\x12$\n\x06object\x18\x01 \x01(\x0b\x32\x14.google.protobuf.Any\x12\x31\n\x08model_id\x18\x02 \x01(\x0b\x32\x1a.dlubal.api.common.ModelIdH\x00\x88\x01\x01\x42\x0b\n\t_model_id\"6\n\nObjectList\x12(\n\x07objects\x18\x01 \x03(\x0b\x32\x17.dlubal.api.rfem.Object\"{\n\x17\x43reateObjectListRequest\x12,\n\x07objects\x18\x01 \x01(\x0b\x32\x1b.dlubal.api.rfem.ObjectList\x12\x1d\n\x10return_object_id\x18\x02 \x01(\x08H\x00\x88\x01\x01\x42\x13\n\x11_return_object_id\"\xc3\x01\n\x08ObjectId\x12\n\n\x02no\x18\x01 \x01(\x05\x12\x30\n\x0bobject_type\x18\x02 \x01(\x0e\x32\x1b.dlubal.api.rfem.ObjectType\x12\x16\n\tparent_no\x18\x03 \x01(\x05H\x00\x88\x01\x01\x12<\n\x12parent_object_type\x18\x04 \x01(\x0e\x32\x1b.dlubal.api.rfem.ObjectTypeH\x01\x88\x01\x01\x42\x0c\n\n_parent_noB\x15\n\x13_parent_object_type\"<\n\x0cObjectIdList\x12,\n\tobject_id\x18\x01 \x03(\x0b\x32\x19.dlubal.api.rfem.ObjectId\"l\n\x13\x43\x61lculateAllRequest\x12\x15\n\rskip_warnings\x18\x01 \x01(\x08\x12\x31\n\x08model_id\x18\x02 \x01(\x0b\x32\x1a.dlubal.api.common.ModelIdH\x00\x88\x01\x01\x42\x0b\n\t_model_id\"b\n\x0fOperationResult\x12\x11\n\tsucceeded\x18\x01 \x01(\x08\x12\x11\n\x04\x64\x61ta\x18\x02 \x01(\tH\x00\x88\x01\x01\x12\x14\n\x07message\x18\x03 \x01(\tH\x01\x88\x01\x01\x42\x07\n\x05_dataB\n\n\x08_message*\xf1\x01\n\x0f\x41pplicationType\x12\x1b\n\x17\x41PPLICATION_UNSPECIFIED\x10\x00\x12\x1d\n\x19\x41PPLICATION_DLUBAL_CENTER\x10\x01\x12\x1d\n\x19\x41PPLICATION_REPORT_VIEWER\x10\x02\x12\x14\n\x10\x41PPLICATION_RFEM\x10\x03\x12\x15\n\x11\x41PPLICATION_RSTAB\x10\x04\x12\x18\n\x14\x41PPLICATION_RSECTION\x10\x05\x12\x1c\n\x18\x41PPLICATION_WEB_SECTIONS\x10\x06\x12\x1e\n\x1a\x41PPLICATION_CRASH_REPORTER\x10\x07\x32\xe9\r\n\x0b\x41pplication\x12Q\n\x0c\x63reate_model\x12#.dlubal.api.rfem.CreateModelRequest\x1a\x1a.dlubal.api.common.ModelId\"\x00\x12M\n\nopen_model\x12!.dlubal.api.rfem.OpenModelRequest\x1a\x1a.dlubal.api.common.ModelId\"\x00\x12K\n\nsave_model\x12#.dlubal.api.rfem.SaveModelAsRequest\x1a\x16.google.protobuf.Empty\"\x00\x12K\n\x0b\x63lose_model\x12\".dlubal.api.rfem.CloseModelRequest\x1a\x16.google.protobuf.Empty\"\x00\x12T\n\x10\x63lose_all_models\x12&.dlubal.api.rfem.CloseAllModelsRequest\x1a\x16.google.protobuf.Empty\"\x00\x12H\n\x10get_active_model\x12\x16.google.protobuf.Empty\x1a\x1a.dlubal.api.common.ModelId\"\x00\x12H\n\x10set_active_model\x12\x1a.dlubal.api.common.ModelId\x1a\x16.google.protobuf.Empty\"\x00\x12\x45\n\x11\x63lose_application\x12\x16.google.protobuf.Empty\x1a\x16.google.protobuf.Empty\"\x00\x12\x46\n\x0eget_model_list\x12\x16.google.protobuf.Empty\x1a\x1a.dlubal.api.rfem.ModelList\"\x00\x12R\n\x14get_application_info\x12\x16.google.protobuf.Empty\x1a .dlubal.api.rfem.ApplicationInfo\"\x00\x12\x44\n\x10\x63lose_connection\x12\x16.google.protobuf.Empty\x1a\x16.google.protobuf.Empty\"\x00\x12\x45\n\x0fget_object_impl\x12\x17.dlubal.api.rfem.Object\x1a\x17.dlubal.api.rfem.Object\"\x00\x12R\n\x14get_object_list_impl\x12\x1b.dlubal.api.rfem.ObjectList\x1a\x1b.dlubal.api.rfem.ObjectList\"\x00\x12J\n\x12\x63reate_object_impl\x12\x17.dlubal.api.rfem.Object\x1a\x19.dlubal.api.rfem.ObjectId\"\x00\x12\x64\n\x17\x63reate_object_list_impl\x12(.dlubal.api.rfem.CreateObjectListRequest\x1a\x1d.dlubal.api.rfem.ObjectIdList\"\x00\x12G\n\x12update_object_impl\x12\x17.dlubal.api.rfem.Object\x1a\x16.google.protobuf.Empty\"\x00\x12P\n\x17update_object_list_impl\x12\x1b.dlubal.api.rfem.ObjectList\x1a\x16.google.protobuf.Empty\"\x00\x12G\n\x12\x64\x65lete_object_impl\x12\x17.dlubal.api.rfem.Object\x1a\x16.google.protobuf.Empty\"\x00\x12P\n\x17\x64\x65lete_object_list_impl\x12\x1b.dlubal.api.rfem.ObjectList\x1a\x16.google.protobuf.Empty\"\x00\x12R\n\x12\x64\x65lete_all_objects\x12\".dlubal.api.common.OptionalModelId\x1a\x16.google.protobuf.Empty\"\x00\x12Y\n\rcalculate_all\x12$.dlubal.api.rfem.CalculateAllRequest\x1a .dlubal.api.rfem.OperationResult\"\x00\x12Y\n\x10get_results_impl\x12%.dlubal.api.rfem.results.ResultsQuery\x1a\x1c.dlubal.api.common.TableData\"\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'dlubal.api.rfem.application_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  DESCRIPTOR._loaded_options = None
+  _globals['_APPLICATIONTYPE']._serialized_start=1712
+  _globals['_APPLICATIONTYPE']._serialized_end=1953
+  _globals['_CREATEMODELREQUEST']._serialized_start=260
+  _globals['_CREATEMODELREQUEST']._serialized_end=340
+  _globals['_OPENMODELREQUEST']._serialized_start=342
+  _globals['_OPENMODELREQUEST']._serialized_end=374
+  _globals['_SAVEMODELASREQUEST']._serialized_start=376
+  _globals['_SAVEMODELASREQUEST']._serialized_end=470
+  _globals['_CLOSEMODELREQUEST']._serialized_start=472
+  _globals['_CLOSEMODELREQUEST']._serialized_end=559
+  _globals['_CLOSEALLMODELSREQUEST']._serialized_start=561
+  _globals['_CLOSEALLMODELSREQUEST']._serialized_end=606
+  _globals['_MODELINFO']._serialized_start=608
+  _globals['_MODELINFO']._serialized_end=675
+  _globals['_MODELLIST']._serialized_start=677
+  _globals['_MODELLIST']._serialized_end=736
+  _globals['_APPLICATIONINFO']._serialized_start=739
+  _globals['_APPLICATIONINFO']._serialized_end=946
+  _globals['_OBJECT']._serialized_start=948
+  _globals['_OBJECT']._serialized_end=1058
+  _globals['_OBJECTLIST']._serialized_start=1060
+  _globals['_OBJECTLIST']._serialized_end=1114
+  _globals['_CREATEOBJECTLISTREQUEST']._serialized_start=1116
+  _globals['_CREATEOBJECTLISTREQUEST']._serialized_end=1239
+  _globals['_OBJECTID']._serialized_start=1242
+  _globals['_OBJECTID']._serialized_end=1437
+  _globals['_OBJECTIDLIST']._serialized_start=1439
+  _globals['_OBJECTIDLIST']._serialized_end=1499
+  _globals['_CALCULATEALLREQUEST']._serialized_start=1501
+  _globals['_CALCULATEALLREQUEST']._serialized_end=1609
+  _globals['_OPERATIONRESULT']._serialized_start=1611
+  _globals['_OPERATIONRESULT']._serialized_end=1709
+  _globals['_APPLICATION']._serialized_start=1956
+  _globals['_APPLICATION']._serialized_end=3725
+# @@protoc_insertion_point(module_scope)

{dlubal_api-2.9.2rc3 → dlubal_api-2.9.4}/dlubal/api/rfem/application_pb2.pyi

@@ -2,6 +2,7 @@ from google.protobuf import any_pb2 as _any_pb2
 from google.protobuf import empty_pb2 as _empty_pb2
 from dlubal.api.common import model_id_pb2 as _model_id_pb2
 from dlubal.api.common import table_data_pb2 as _table_data_pb2
+from dlubal.api.rfem import object_type_pb2 as _object_type_pb2
 from dlubal.api.rfem.results import results_query_pb2 as _results_query_pb2
 from google.protobuf.internal import containers as _containers
 from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
@@ -67,14 +68,14 @@ class CloseAllModelsRequest(_message.Message):
     def __init__(self, save_changes: bool = ...) -> None: ...
 
 class ModelInfo(_message.Message):
-    __slots__ = ("name", "id", "path")
+    __slots__ = ("name", "guid", "path")
     NAME_FIELD_NUMBER: _ClassVar[int]
-    ID_FIELD_NUMBER: _ClassVar[int]
+    GUID_FIELD_NUMBER: _ClassVar[int]
     PATH_FIELD_NUMBER: _ClassVar[int]
     name: str
-    id: str
+    guid: str
     path: str
-    def __init__(self, name: _Optional[str] = ..., id: _Optional[str] = ..., path: _Optional[str] = ...) -> None: ...
+    def __init__(self, name: _Optional[str] = ..., guid: _Optional[str] = ..., path: _Optional[str] = ...) -> None: ...
 
 class ModelList(_message.Message):
     __slots__ = ("model_info",)
@@ -116,6 +117,32 @@ class ObjectList(_message.Message):
     objects: _containers.RepeatedCompositeFieldContainer[Object]
     def __init__(self, objects: _Optional[_Iterable[_Union[Object, _Mapping]]] = ...) -> None: ...
 
+class CreateObjectListRequest(_message.Message):
+    __slots__ = ("objects", "return_object_id")
+    OBJECTS_FIELD_NUMBER: _ClassVar[int]
+    RETURN_OBJECT_ID_FIELD_NUMBER: _ClassVar[int]
+    objects: ObjectList
+    return_object_id: bool
+    def __init__(self, objects: _Optional[_Union[ObjectList, _Mapping]] = ..., return_object_id: bool = ...) -> None: ...
+
+class ObjectId(_message.Message):
+    __slots__ = ("no", "object_type", "parent_no", "parent_object_type")
+    NO_FIELD_NUMBER: _ClassVar[int]
+    OBJECT_TYPE_FIELD_NUMBER: _ClassVar[int]
+    PARENT_NO_FIELD_NUMBER: _ClassVar[int]
+    PARENT_OBJECT_TYPE_FIELD_NUMBER: _ClassVar[int]
+    no: int
+    object_type: _object_type_pb2.ObjectType
+    parent_no: int
+    parent_object_type: _object_type_pb2.ObjectType
+    def __init__(self, no: _Optional[int] = ..., object_type: _Optional[_Union[_object_type_pb2.ObjectType, str]] = ..., parent_no: _Optional[int] = ..., parent_object_type: _Optional[_Union[_object_type_pb2.ObjectType, str]] = ...) -> None: ...
+
+class ObjectIdList(_message.Message):
+    __slots__ = ("object_id",)
+    OBJECT_ID_FIELD_NUMBER: _ClassVar[int]
+    object_id: _containers.RepeatedCompositeFieldContainer[ObjectId]
+    def __init__(self, object_id: _Optional[_Iterable[_Union[ObjectId, _Mapping]]] = ...) -> None: ...
+
 class CalculateAllRequest(_message.Message):
     __slots__ = ("skip_warnings", "model_id")
     SKIP_WARNINGS_FIELD_NUMBER: _ClassVar[int]