Merge branch 'developement'

Author: evereux

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.5.9
+
+* Added missing com_oject to references in navigator_interfaces. (@evereux & @marciolrc)
+* Fixed reference plane method in HybridShapePlaneAngle. (@Mithro86)
+* Updates to examples to include latest supported python version. Also fix IDE autocompletion & syntax highlighting 
+ issues. (@deloarts)
+*  
+
 ## 0.5.8
 
 * Added new document type CatalogDocument.

CONTRIBUTORS.md

@@ -17,3 +17,5 @@ deloarts
 Mithro86
 
 ptm-tm
+
+marciolrc

docs/conf.py

@@ -36,7 +36,7 @@ def __getattr__(cls, name):
 author = 'Paul Bourne'
 
 # The short X.Y version
-version = '0.5.8'
+version = '0.5.9'
 # The full version, including alpha/beta/rc tags
 release = version
 

examples/example__assembly_convertor__001.py

@@ -1,19 +1,23 @@
-#! /usr/bin/python3.6
+#! /usr/bin/python3.9
 
 """
 
     Example - Assembly Convertor - 001
 
-    Print the BOM of a product to XLS using the inbuilt AssemblyConvertor. You
-    must already have excel installed.
+    Description:
+        Print the BOM of a product to XLS using the inbuilt AssemblyConvertor.
+        This can also be used to create TXT and HTML files.
 
-    This can also be used to create TXT and HTML files.
+    Requirements:
+        - An open product document with parts inside.
+        - MS EXCEL must be installed.
 
-    See github issue https://github.com/evereux/pycatia/issues/110 with regards
-    to file paths and saying "No" to overwriting existing files and file paths
-    when using excel. These issues are mitigated using the code below by
-    checking for an existing excel file and removing it and also using pythons
-    pathlib.Path module.
+    Further information:
+        See github issue https://github.com/evereux/pycatia/issues/110 with regards
+        to file paths and saying "No" to overwriting existing files and file paths
+        when using excel. These issues are mitigated using the code below by
+        checking for an existing excel file and removing it and also using pythons
+        pathlib.Path module.
 
 """
 
@@ -34,13 +38,32 @@
 
 # file_type can be "TXT", "HTML" or "XLS".
 file_type = "XLS"
-# full path to excel file.
-# use pathlib.Path to prevent path related errors. See github link above.
-excel_file = Path("C:\\Users\\evereux\\Desktop\\my_bom.xls")
 
-# check that the parent folder exists
-if not excel_file.parent.is_dir():
-    raise NotADirectoryError(f'Directory "{excel_file.parent}" doesn\'t exist')
+caa = catia()
+document = ProductDocument(caa.active_document.com_object)
+product = Product(document.product.com_object)
+# Note: It's not necessary to explicitly use the ProductDocument or the Product class
+# with the com_object. It's perfectly fine to write it like this:
+#   document = caa.active_document
+#   product = document.product
+# But declaring 'document' and 'product' this way, your linter can't resolve the
+# product reference, see https://github.com/evereux/pycatia/issues/107#issuecomment-1336195688
+
+bom = product.get_item("BillOfMaterial")
+assembly_convertor = AssemblyConvertor(bom.com_object)
+
+details_top = ("Quantity", "Part Number", "Type", "Nomenclature", "Revision")
+details_recap = ("Quantity", "Part Number")
+# Note: Keep in mind that CATIA is language based when it comes to the bill of material format.
+# So 'Part Number' in english will become 'Teilenummer' in german, and so on.
+assembly_convertor.set_current_format(details_top)
+assembly_convertor.set_secondary_format(details_recap)
+
+# Define the absolute path for the excel file.
+# In this example the excel file will be saved to the same folder as the product,
+# from which the bill of material is created. The excel file will also have the
+# same name as the product.
+excel_path = Path(product.path().parent, product.name + ".xls")
 
 # check if the file already exists. I recommend doing this in python for two
 # reasons ....
@@ -50,25 +73,11 @@
 # errors until CATIA is restarted.
 # see github link above for more information.
 # !! this will delete excel file if it exists !!
-if excel_file.is_file():
-    os.remove(excel_file)
+if excel_path.is_file():
+    os.remove(excel_path)
 
 
-caa = catia()
-document = caa.active_document
-product = ProductDocument(document.com_object).product
-# not neccessary but will provide autocompletion in IDEs.
-product = Product(product.com_object)
-
-bom = product.get_item("BillOfMaterial")
-assembly_convertor = AssemblyConvertor(bom.com_object)
-
-details_top = ("Quantity", "Part Number", "Type", "Nomenclature", "Revision")
-details_recap = ("Quantity", "Part Number")
-assembly_convertor.set_current_format(details_top)
-assembly_convertor.set_secondary_format(details_recap)
-
-assembly_convertor.print(file_type, excel_file, product)
+assembly_convertor.print(file_type, excel_path, product)
 # Important note:
 # The print-method will fail if you try to export the bill-of-material-xls file
 # to a location, where another process will access this file. Such process is

examples/example__bom_custom_001.py

@@ -1,10 +1,14 @@
-#! /usr/bin/python3.6
+#! /usr/bin/python3.9
 
 """
 
-    Example - BOM CUSTOM - 001:
+    Example - BOM CUSTOM - 001
 
-    Create a custom formatted html of the product tree.
+    Description:
+        Create a custom formatted html of the product tree.
+
+    Requirements:
+        - An open product document with parts inside.
 
 """
 
@@ -14,22 +18,26 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('..\\pycatia'))
+sys.path.insert(0, os.path.abspath("..\\pycatia"))
 ##########################################################
 
 from collections import Counter
 from datetime import datetime
 
 from pycatia import catia
 from pycatia.product_structure_interfaces.product import Product
-
+from pycatia.product_structure_interfaces.product_document import ProductDocument
 
 caa = catia()
-document = caa.active_document
-product = document.product
-# not neccessary but will provide autocompletion in IDEs.
-product = Product(product.com_object)
+document = ProductDocument(caa.active_document.com_object).product
+product = Product(document.com_object)
 products = product.products
+# Note: It's not necessary to explicitly use the ProductDocument or the Product class
+# with the com_object. It's perfectly fine to write it like this:
+#   document = caa.active_document
+#   product = document.product
+# But declaring 'document' and 'product' this way, your linter can't resolve the
+# product reference, see https://github.com/evereux/pycatia/issues/107#issuecomment-1336195688
 
 part_numbers = []
 prd_dict = {}
@@ -86,5 +94,5 @@
     </body>
 </html>"""
 
-with open((product.part_number + '.html'), 'w') as f:
+with open((product.part_number + ".html"), "w") as f:
     f.write(html)

examples/example__constraints_001.py

@@ -1,11 +1,15 @@
-#! /usr/bin/python3.6
+#! /usr/bin/python3.9
 
 """
 
-    Example - Constraints - 001:
+    Example - Constraints - 001
 
-    Fix the first Sub Product in Product using constraints. The Sketch examples
-    also show further usage of constraints.
+    Description:
+        Fix the first Sub Product in Product using constraints.
+        The Sketch examples also show further usage of constraints.
+
+    Requirements:
+        - An open product document with at least two parts inside.
 
 """
 
@@ -15,21 +19,26 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('..\\pycatia'))
+sys.path.insert(0, os.path.abspath("..\\pycatia"))
 ##########################################################
 
 from pycatia import catia
-from pycatia.product_structure_interfaces.product import Product
 from pycatia.enumeration.enumeration_types import cat_constraint_type
+from pycatia.product_structure_interfaces.product import Product
+from pycatia.product_structure_interfaces.product_document import ProductDocument
 
 caa = catia()
-document = caa.active_document
-product = document.product
-# not neccessary but will provide autocompletion in IDEs.
-product = Product(product.com_object)
-constraints = product.constraints()
+document = ProductDocument(caa.active_document.com_object).product
+product = Product(document.com_object)
+# Note: It's not necessary to explicitly use the ProductDocument or the Product class
+# with the com_object. It's perfectly fine to write it like this:
+#   document = caa.active_document
+#   product = document.product
+# But declaring 'document' and 'product' this way, your linter can't resolve the
+# product reference, see https://github.com/evereux/pycatia/issues/107#issuecomment-1336195688
 
 products = product.products
+constraints = product.constraints()
 sub_prod_1 = products.item(1)
 ref_sub_prod_1 = sub_prod_1.reference_product
 

examples/example__document__001.py

@@ -1,10 +1,15 @@
-#! /usr/bin/python3.6
+#! /usr/bin/python3.9
 
 """
 
-    Example - Document - 001:
+    Example - Document - 001
 
-    Use the context manager to open CATIA documents and close
+    Description:
+        Use the context manager to open CATIA documents and close
+
+    Requirements:
+        - CATIA running.
+        - Tests already setup.
 
 """
 
@@ -14,14 +19,14 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('..\\pycatia'))
+sys.path.insert(0, os.path.abspath("..\\pycatia"))
 ##########################################################
 
 import time
 
 from pycatia import CATIADocHandler
 
-catia_part = r'tests\cat_files\part_measurable.CATPart'
+catia_part = r"tests\cat_files\part_measurable.CATPart"
 
 with CATIADocHandler(catia_part) as caa:
     document = caa.document

examples/example__document__002.py

@@ -1,10 +1,15 @@
-#! /usr/bin/python3.6
+#! /usr/bin/python3.9
 
 """
 
-    Example - Document - 002:
+    Example - Document - 002
 
-    Open all CATParts in source directory and save to IGS in target directory.
+    Description:
+        Open all CATParts in source directory and save to IGS in target directory.
+
+    Requirements:
+        - CATIA running.
+        - Tests already setup.
 
 """
 
@@ -14,35 +19,38 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('..\\pycatia'))
+sys.path.insert(0, os.path.abspath("..\\pycatia"))
 ##########################################################
 
 import os
+from pathlib import Path
 
 from pycatia import CATIADocHandler
+from pycatia.in_interfaces.document import Document
 
 # make these directories the full pathname.
-source_directory = 'tests/cat_files'
-target_directory = '__junk__'
+source_directory = "tests/cat_files"
+target_directory = "__junk__"
 
 # if full paths are supplied above you should not do this.
 source_directory = os.path.join(os.getcwd(), source_directory)
 target_directory = os.path.join(os.getcwd(), target_directory)
 
 # This loop assumes there are NO sub-directories.
 for root, dirs, files in os.walk(source_directory):
-
     for file in files:
-
         # only convert CATParts.
-        if os.path.splitext(file)[1] == '.CATPart':
+        if os.path.splitext(file)[1] == ".CATPart":
             # create filename with path.
             file_name = os.path.join(source_directory, file)
 
             with CATIADocHandler(file_name) as caa:
-                file_ext = 'igs'
+                file_ext = "igs"
                 document = caa.document
+                assert isinstance(document, Document)
+
                 # create the full name of the target file, minus extension.
-                target_file = os.path.join(target_directory, os.path.splitext(file)[0]) + "." + file_ext
+                target_file = Path(target_directory, os.path.splitext(file)[0] + "." + file_ext)
+
                 # create the igs file in the __junk__ directory.
                 document.export_data(target_file, file_ext)