Add pathlib.Path support to XML #4455.

pekkaklarck · pekkaklarck · commit f43b23f1091c · 2022-09-16T21:26:23.000+03:00
Parsing alraedy worked with pathlib.Path but saving didn't.
diff --git a/atest/robot/standard_libraries/xml/save_xml.robot b/atest/robot/standard_libraries/xml/save_xml.robot
@@ -24,6 +24,9 @@ Save Non-ASCII XML
 Save Non-ASCII XML Using Custom Encoding
     Check Test Case    ${TESTNAME}
 
+Save to `pathlib.Path`
+    Check Test Case    ${TESTNAME}
+
 Save to Invalid File
     Check Test Case    ${TESTNAME}
 
diff --git a/atest/robot/standard_libraries/xml/save_xml_with_lxml.robot b/atest/robot/standard_libraries/xml/save_xml_with_lxml.robot
@@ -25,6 +25,9 @@ Save Non-ASCII XML
 Save Non-ASCII XML Using Custom Encoding
     Check Test Case    ${TESTNAME}
 
+Save to `pathlib.Path`
+    Check Test Case    ${TESTNAME}
+
 Save to Invalid File
     Check Test Case    ${TESTNAME}
 
diff --git a/atest/testdata/standard_libraries/xml/save_xml.robot b/atest/testdata/standard_libraries/xml/save_xml.robot
@@ -34,6 +34,10 @@ Save Non-ASCII XML Using Custom Encoding
     Save XML    ${NON-ASCII}    ${OUTPUT}    ISO-8859-1
     XML Content Should Be    ${NON-ASCII}    ISO-8859-1
 
+Save to `pathlib.Path`
+    Save XML    ${SIMPLE}    ${{pathlib.Path($OUTPUT)}}
+    XML Content Should Be    ${SIMPLE}
+
 Save to Invalid File
     [Documentation]    FAIL REGEXP: (IOError|IsADirectoryError|PermissionError): .*
     Save XML    ${SIMPLE}    %{TEMPDIR}
diff --git a/atest/testdata/standard_libraries/xml/save_xml_with_lxml.robot b/atest/testdata/standard_libraries/xml/save_xml_with_lxml.robot
@@ -36,6 +36,10 @@ Save Non-ASCII XML Using Custom Encoding
     Save XML    ${NON-ASCII}    ${OUTPUT}    ISO-8859-1
     XML Content Should Be    ${NON-ASCII}    ISO-8859-1
 
+Save to `pathlib.Path`
+    Save XML    ${SIMPLE}    ${{pathlib.Path($OUTPUT)}}
+    XML Content Should Be    ${SIMPLE SAVED}
+
 Save to Invalid File
     [Documentation]    FAIL REGEXP: (IOError|IsADirectoryError|PermissionError): .*
     Save XML    ${SIMPLE}    %{TEMPDIR}
diff --git a/src/robot/libraries/XML.py b/src/robot/libraries/XML.py
@@ -15,7 +15,6 @@
 
 import copy
 import os
-import pathlib
 import re
 
 try:
@@ -517,7 +516,7 @@ def parse_xml(self, source, keep_clark_notation=False, strip_namespaces=False):
         the whole structure. See `Parsing XML` section for more details and
         examples.
         """
-        if isinstance(source, pathlib.Path):
+        if isinstance(source, os.PathLike):
             source = str(source)
         with ETSource(source) as source:
             tree = self.etree.parse(source)
@@ -589,7 +588,7 @@ def get_elements(self, source, xpath):
         | ${children} =    | Get Elements | ${XML} | first/child |
         | Should Be Empty  |  ${children} |        |             |
         """
-        if is_string(source) or is_bytes(source) or isinstance(source, pathlib.Path):
+        if isinstance(source, (str, bytes, os.PathLike)):
             source = self.parse_xml(source)
         finder = ElementFinder(self.etree, self.modern_etree, self.lxml_etree)
         return finder.find_all(source, xpath)
@@ -1349,7 +1348,8 @@ def save_xml(self, source, path, encoding='UTF-8'):
         Use `Element To String` if you just need a string representation of
         the element.
         """
-        path = os.path.abspath(path.replace('/', os.sep))
+        path = os.path.abspath(str(path) if isinstance(path, os.PathLike)
+                               else path.replace('/', os.sep))
         elem = self.get_element(source)
         tree = self.etree.ElementTree(elem)
         config = {'encoding': encoding}
