merging issues - sync with developement

Author: evereux

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.9.0
+
+Please note the change to VisPropertySet.get_show() will break existing scripts where this is used.
+
+* updated the following VisPropertySet() methods with fixed type hinting:
+  get_layer(), get_pick(), get_real_color(), get_real_inheritance(),
+  get_real_line_type(), get_real_opacity(), get_real_width(), get_show(),
+  get_symbol_type(), get_visible_color(), get_visible_line_type(),
+  get_visible_opacity(), get_visible_width().
+  Thanks to @HubertDomaros for pointing out the initial issue #269.
+* updated Selection.select_element4() type hints and the returned objects.
+  Thanks to @CossackLucas for reporting #263.
+* updated ParameterSet.all_parameters to return a Parameters collection object.
+* fixed DrawingDimension.get_boundary_box(). #275
+* many type hinting improvements / fixes.
+
 ## 0.8.3
 
 * fixed methods for Plane.get_first_axis(), Plane.get_origin(),

docs/conf.py

@@ -32,7 +32,7 @@ def __getattr__(cls, name):
 # -- Project information -----------------------------------------------------
 
 project = 'pycatia'
-copyright = '2024, Paul Bourne'
+copyright = '2025, Paul Bourne'
 author = 'Paul Bourne'
 
 # The short X.Y version

docs/examples.rst

@@ -5,7 +5,7 @@ Examples
 
 Simple examples that help you get started using pycatia.
 
-For more complex scripts see the section on :ref:`User Scripts`.
+For more complex scripts see the section on :ref:`User Scripts<User Scripts>`.
 
 Index
 -----
@@ -404,7 +404,7 @@ Change the Length value of parameter named Thickness.
 
 
 
-.. _Example Part:
+.. _Example Parts:
 
 PART EXAMPLES
 ----------------

docs/user_scripts.rst

@@ -3,7 +3,7 @@
 User Scripts
 ============
 
-User created scripts that are more advanced than the :ref:`examples`.
+User created scripts that are more advanced than the :ref:`Examples<examples>`.
 
 Index
 -----

pycatia/abq_automation_interfaces/abq_analysis_cases.py

@@ -10,7 +10,7 @@
 """
 from pycatia.abq_automation_interfaces.abq_analysis_case import ABQAnalysisCase
 from pycatia.system_interfaces.collection import Collection
-from pycatia.types.general import cat_variant
+from pycatia.types.general import CATVariant
 
 
 class ABQAnalysisCases(Collection):
@@ -73,7 +73,7 @@ def add(self, i_analysis_type: str) -> ABQAnalysisCase:
         """
         return ABQAnalysisCase(self.abq_analysis_cases.Add(i_analysis_type))
 
-    def item(self, i_index: cat_variant) -> ABQAnalysisCase:
+    def item(self, i_index: CATVariant) -> ABQAnalysisCase:
         """
         .. note::
             :class: toggle
@@ -106,12 +106,12 @@ def item(self, i_index: cat_variant) -> ABQAnalysisCase:
                 |          Set ThisCase = CaseColl.Item(5)
                 |          Set ThatCase = CaseColl.Item("MyCase")
 
-        :param cat_variant i_index:
+        :param CATVariant i_index:
         :rtype: ABQAnalysisCase
         """
         return ABQAnalysisCase(self.abq_analysis_cases.Item(i_index))
 
-    def remove(self, i_index: cat_variant) -> None:
+    def remove(self, i_index: CATVariant) -> None:
         """
         .. note::
             :class: toggle
@@ -134,7 +134,7 @@ def remove(self, i_index: cat_variant) -> None:
                 |             the analysis case using the CATIABase::Name
                 |             property.
 
-        :param cat_variant i_index:
+        :param CATVariant i_index:
         :rtype: None
         """
         return self.abq_analysis_cases.Remove(i_index)

pycatia/abq_automation_interfaces/abq_boundary_conditions.py

@@ -10,7 +10,7 @@
 """
 from pycatia.abq_automation_interfaces.abq_boundary_condition import ABQBoundaryCondition
 from pycatia.system_interfaces.collection import Collection
-from pycatia.types.general import cat_variant
+from pycatia.types.general import CATVariant
 
 
 class ABQBoundaryConditions(Collection):
@@ -76,7 +76,7 @@ def add(self, i_boundary_type: str) -> ABQBoundaryCondition:
         """
         return ABQBoundaryCondition(self.abq_boundary_conditions.Add(i_boundary_type))
 
-    def item(self, i_index: cat_variant) -> ABQBoundaryCondition:
+    def item(self, i_index: CATVariant) -> ABQBoundaryCondition:
         """
         .. note::
             :class: toggle
@@ -101,12 +101,12 @@ def item(self, i_index: cat_variant) -> ABQBoundaryCondition:
                 |     Returns:
                 |         The specified ABQBoundaryCondition.
 
-        :param cat_variant i_index:
+        :param CATVariant i_index:
         :rtype: ABQBoundaryCondition
         """
         return ABQBoundaryCondition(self.abq_boundary_conditions.Item(i_index))
 
-    def remove(self, i_index: cat_variant) -> None:
+    def remove(self, i_index: CATVariant) -> None:
         """
         .. note::
             :class: toggle
@@ -128,7 +128,7 @@ def remove(self, i_index: cat_variant) -> None:
                 |             specifies the name you assigned to the boundary condition using the
                 |             CATIACollection::Name property.
 
-        :param cat_variant i_index:
+        :param CATVariant i_index:
         :rtype: None
         """
         return self.abq_boundary_conditions.Remove(i_index)

pycatia/abq_automation_interfaces/abq_data_output_requests.py

@@ -10,7 +10,7 @@
 """
 from pycatia.abq_automation_interfaces.abq_data_output_request import ABQDataOutputRequest
 from pycatia.system_interfaces.collection import Collection
-from pycatia.types.general import cat_variant
+from pycatia.types.general import CATVariant
 
 
 class ABQDataOutputRequests(Collection):
@@ -65,7 +65,7 @@ def add(self) -> ABQDataOutputRequest:
         """
         return ABQDataOutputRequest(self.abq_data_output_requests.Add())
 
-    def item(self, i_index: cat_variant) -> ABQDataOutputRequest:
+    def item(self, i_index: CATVariant) -> ABQDataOutputRequest:
         """
         .. note::
             :class: toggle
@@ -90,12 +90,12 @@ def item(self, i_index: cat_variant) -> ABQDataOutputRequest:
                 |     Returns:
                 |         The specified ABQDataOutputRequest.
 
-        :param cat_variant i_index:
+        :param CATVariant i_index:
         :rtype: ABQDataOutputRequest
         """
         return ABQDataOutputRequest(self.abq_data_output_requests.Item(i_index))
 
-    def remove(self, i_index: cat_variant) -> None:
+    def remove(self, i_index: CATVariant) -> None:
         """
         .. note::
             :class: toggle
@@ -116,7 +116,7 @@ def remove(self, i_index: cat_variant) -> None:
                 |             is Count. As a string, it is the name you assigned to the data output request
                 |             using the CATIABase::Name property.
 
-        :param cat_variant i_index:
+        :param CATVariant i_index:
         :rtype: None
         """
         return self.abq_data_output_requests.Remove(i_index)

pycatia/abq_automation_interfaces/abq_display_groups.py

@@ -10,7 +10,7 @@
 """
 from pycatia.abq_automation_interfaces.abq_display_group import ABQDisplayGroup
 from pycatia.system_interfaces.collection import Collection
-from pycatia.types.general import cat_variant
+from pycatia.types.general import CATVariant
 
 
 class ABQDisplayGroups(Collection):
@@ -36,7 +36,7 @@ def __init__(self, com_object):
         super().__init__(com_object, child_object=ABQDisplayGroup)
         self.abq_display_groups = com_object
 
-    def item(self, i_index: cat_variant) -> ABQDisplayGroup:
+    def item(self, i_index: CATVariant) -> ABQDisplayGroup:
         """
         .. note::
             :class: toggle
@@ -60,7 +60,7 @@ def item(self, i_index: cat_variant) -> ABQDisplayGroup:
                 |     Returns:
                 |         The specified ABQDisplayGroup.
 
-        :param cat_variant i_index:
+        :param CATVariant i_index:
         :rtype: ABQDisplayGroup
         """
         return ABQDisplayGroup(self.abq_display_groups.Item(i_index))

pycatia/abq_automation_interfaces/abq_field_output_requests.py

@@ -10,7 +10,7 @@
 """
 from pycatia.abq_automation_interfaces.abq_field_output_request import ABQFieldOutputRequest
 from pycatia.system_interfaces.collection import Collection
-from pycatia.types.general import cat_variant
+from pycatia.types.general import CATVariant
 
 
 class ABQFieldOutputRequests(Collection):
@@ -65,7 +65,7 @@ def add(self) -> ABQFieldOutputRequest:
         """
         return ABQFieldOutputRequest(self.abq_field_output_requests.Add())
 
-    def item(self, i_index: cat_variant) -> ABQFieldOutputRequest:
+    def item(self, i_index: CATVariant) -> ABQFieldOutputRequest:
         """
         .. note::
             :class: toggle
@@ -90,12 +90,12 @@ def item(self, i_index: cat_variant) -> ABQFieldOutputRequest:
                 |     Returns:
                 |         The specified ABQFieldOutputRequest.
 
-        :param cat_variant i_index:
+        :param CATVariant i_index:
         :rtype: ABQFieldOutputRequest
         """
         return ABQFieldOutputRequest(self.abq_field_output_requests.Item(i_index))
 
-    def remove(self, i_index: cat_variant) -> None:
+    def remove(self, i_index: CATVariant) -> None:
         """
         .. note::
             :class: toggle
@@ -116,7 +116,7 @@ def remove(self, i_index: cat_variant) -> None:
                 |             request is Count. As a string, it is the name you assigned to the field output
                 |             request using the CATIABase::Name property.
 
-        :param cat_variant i_index:
+        :param CATVariant i_index:
         :rtype: None
         """
         return self.abq_field_output_requests.Remove(i_index)

pycatia/abq_automation_interfaces/abq_fields.py

@@ -10,7 +10,7 @@
 """
 from pycatia.abq_automation_interfaces.abq_temperature import ABQTemperature
 from pycatia.system_interfaces.collection import Collection
-from pycatia.types.general import cat_variant
+from pycatia.types.general import CATVariant
 
 
 class ABQFields(Collection):
@@ -84,7 +84,7 @@ def add(self, i_field_type: str) -> ABQTemperature:
         """
         return ABQTemperature(self.abq_fields.Add(i_field_type))
 
-    def item(self, i_index: cat_variant) -> ABQTemperature:
+    def item(self, i_index: CATVariant) -> ABQTemperature:
         """
         .. note::
             :class: toggle
@@ -108,12 +108,12 @@ def item(self, i_index: cat_variant) -> ABQTemperature:
                 |     Returns:
                 |         The specified ABQTemperature.
 
-        :param cat_variant i_index:
+        :param CATVariant i_index:
         :rtype: ABQTemperature
         """
         return ABQTemperature(self.abq_fields.Item(i_index))
 
-    def remove(self, i_index: cat_variant) -> None:
+    def remove(self, i_index: CATVariant) -> None:
         """
         .. note::
             :class: toggle
@@ -134,7 +134,7 @@ def remove(self, i_index: cat_variant) -> None:
                 |             string, it specifies the name you assigned to the field using the
                 |             CATIABase::Name property.
 
-        :param cat_variant i_index:
+        :param CATVariant i_index:
         :rtype: None
         """
         return self.abq_fields.Remove(i_index)