fixed regression in Documents.open() Documents.read() and Documents.new_from()

 where strings are passed in lieu of Path objects. It was the intention for both
 strings and paths to work. Tests updated to test for both Path and str objects.

Author: evereux

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## 0.7.2
 * addded missing type hints to `Document()` methods.
+* fixed regression in Documents.open() Documents.read() and Documents.new_from() 
+ where strings are passed in lieu of Path objects. It was the intention for both 
+ strings and paths to work. Tests updated to test for both Path and str objects.
 
 ## 0.7.1
 

pycatia/in_interfaces/documents.py

@@ -150,14 +150,12 @@ def new_from(self, file_name: Path) -> Document:
         :rtype: Document
         """
 
-        # legacy support for < 0.7.1 where file_name could be a string.
-        if isinstance(file_name, str):
-            if not os.path.isfile(file_name):
-                raise FileNotFoundError(f'Could not find file {file_name}.')
-        else:
-            if not file_name.is_file():
-                raise FileNotFoundError(f'Could not find file {file_name}.')
+        # legacy support for strings.
+        if type(file_name) is str:
+            file_name = Path(file_name)
 
+        if not file_name.is_file:
+            raise FileNotFoundError(f'Could not find file {file_name}.')
 
         return Document(self.documents.NewFrom(file_name))
 
@@ -256,13 +254,13 @@ def open(self, file_name: Path) -> Document:
         :param Path file_name:
         :rtype: Document
         """
-        # legacy support for < 0.7.1 where file_name could be a string.
-        if isinstance(file_name, str):
-            if not os.path.isfile(file_name):
-                raise FileNotFoundError(f'Could not find file {file_name}.')
-        else:
-            if not file_name.is_file:
-                raise FileNotFoundError(f'Could not find file {file_name}.')
+        
+        # legacy support for strings.
+        if type(file_name) is str:
+            file_name = Path(file_name)
+
+        if not file_name.is_file:
+            raise FileNotFoundError(f'Could not find file {file_name}.')
 
         try:
             self.logger.info(f'Opening document "{file_name}".')
@@ -313,6 +311,14 @@ def read(self, file_name: Path) -> Document:
         """
         # return Document(self.documents.Read(file_name))
 
+        # legacy support for strings.
+        if type(file_name) is str:
+            file_name = Path(file_name)
+        
+        if not file_name.is_file:
+            raise FileNotFoundError(f'Could not find file {file_name}.')
+
+
         read_doc_com = self.documents.Read(file_name)
         extension = file_name.suffix[1:]
         types = [document_types[k]['type'] for k in (document_types) if document_types[k]['extension'] == extension]

tests/in/test_document.py

@@ -166,14 +166,13 @@ def test_new_from():
 
     document.close()
 
-    with pytest.raises(FileNotFoundError):
-        documents.new_from("lala")
+def test_new_from_str():
+    documents = caa.documents
+    document = documents.new_from(str(cat_part_measurable))
 
+    assert document.name is not os.path.basename(cat_part_measurable)
 
-def test_no_such_file():
-    with pytest.raises(FileNotFoundError):
-        documents = caa.documents
-        documents.open("lala")
+    document.close()
 
 
 def test_num_open():
@@ -185,22 +184,40 @@ def test_num_open():
 
 
 def test_open_document():
-    # This assertion has been removed as my version of CATIA keeps an open link to ABQMaterialPropertiesCatalog.CATfct
-    # once the document is closed. I don't know if this is a CATIA bug or `feature` to keep the linked item loaded.
-    # assert documents.documents.Count == 0
+    
+    documents = caa.documents
+    document = documents.open(cat_part_measurable)
+
+    assert type(document) is PartDocument
+
+    document.close
+
+def test_open_document_str():
+    
+    documents = caa.documents
+    document = documents.open(str(cat_part_measurable))
+
+    assert type(document) is PartDocument
+
+    document.close
 
-    with CATIADocHandler(cat_part_measurable) as caa:
-        document = caa.document
-        assert document is not None
-        assert document.name == cat_part_measurable.name
-        assert f'PartDocument(name="{document.name}")' == document.__repr__()
 
 def test_read_document():
 
     documents = caa.documents
     document = documents.read(cat_part_measurable)
 
-    assert type(document) == PartDocument
+    assert type(document) is PartDocument
+
+    document.close
+
+
+def test_read_document_str():
+
+    documents = caa.documents
+    document = documents.read(str(cat_part_measurable))
+
+    assert type(document) is PartDocument
 
     document.close