Rename functions related to reading/parsing CLF to be consistent with similar functions exposed in colour.

Author: MichaelMauderer

colour_clf_io/__init__.py

@@ -104,7 +104,7 @@
 __version__ = f"{__major_version__}.{__minor_version__}.{__change_version__}"
 
 
-def read_clf(path: str | Path) -> ProcessList:
+def read_clf_from_file(path: str | Path) -> ProcessList:
     """
     Read given *CLF* file and return a *ProcessList*.
 
@@ -134,7 +134,7 @@ def read_clf(path: str | Path) -> ProcessList:
     return process_list
 
 
-def parse_clf(text: str | bytes) -> ProcessList | None:
+def read_clf(text: str | bytes) -> ProcessList | None:
     """
     Read given string as a *CLF* file and return a *ProcessList*.
 

colour_clf_io/tests/test_clf_common.py

@@ -80,7 +80,7 @@ def snippet_to_process_list(
 
     doc = wrap_snippet(snippet)
 
-    return colour_clf_io.parse_clf(doc)
+    return colour_clf_io.read_clf(doc)
 
 
 def snippet_as_tmp_file(snippet: str) -> str:

colour_clf_io/tests/test_clf_parsing.py

@@ -11,7 +11,7 @@
 import colour_clf_io.elements
 import colour_clf_io.process_nodes
 import colour_clf_io.values
-from colour_clf_io import parse_clf, read_clf
+from colour_clf_io import read_clf, read_clf_from_file
 from colour_clf_io.errors import ParsingError
 
 from .test_clf_common import wrap_snippet
@@ -49,7 +49,9 @@ def test_read_sample_document_1(self) -> None:
         Test parsing of the sample file `ACES2065_1_to_ACEScct.xml`.
         """
 
-        clf_data = read_clf(os.path.join(ROOT_CLF, "ACES2065_1_to_ACEScct.xml"))
+        clf_data = read_clf_from_file(
+            os.path.join(ROOT_CLF, "ACES2065_1_to_ACEScct.xml")
+        )
 
         assert clf_data is not None
         assert clf_data.description == ["Conversion from linear ACES2065-1 to ACEScct"]
@@ -76,7 +78,7 @@ def test_read_sample_document_2(self) -> None:
         Test parsing of the sample file `LMT Kodak 2383 Print Emulation.xml`.
         """
 
-        clf_data = read_clf(
+        clf_data = read_clf_from_file(
             os.path.join(ROOT_CLF, "LMT Kodak 2383 Print Emulation.xml")
         )
 
@@ -91,7 +93,9 @@ def test_read_sample_document_3(self) -> None:
         Test parsing of the sample file `LMT_ARRI_K1S1_709_EI800_v3.xml`.
         """
 
-        clf_data = read_clf(os.path.join(ROOT_CLF, "LMT_ARRI_K1S1_709_EI800_v3.xml"))
+        clf_data = read_clf_from_file(
+            os.path.join(ROOT_CLF, "LMT_ARRI_K1S1_709_EI800_v3.xml")
+        )
 
         assert clf_data is not None
         assert clf_data.description == ["An ARRI based look"]
@@ -117,7 +121,7 @@ def test_LUT1D_example(self) -> None:
         </LUT1D>
         """
 
-        doc = parse_clf(wrap_snippet(example))
+        doc = read_clf(wrap_snippet(example))
 
         assert doc is not None
 
@@ -155,7 +159,7 @@ def test_LUT3D_example(self) -> None:
         </LUT3D>
         """  # noqa: E501
 
-        doc = parse_clf(wrap_snippet(example))
+        doc = read_clf(wrap_snippet(example))
 
         assert doc is not None
 
@@ -201,7 +205,7 @@ def test_matrix_example_1(self) -> None:
         </Matrix>
         """
 
-        doc = parse_clf(wrap_snippet(example))
+        doc = read_clf(wrap_snippet(example))
 
         assert doc is not None
 
@@ -241,7 +245,7 @@ def test_matrix_example_2(self) -> None:
         </Matrix>
         """  # noqa: E501
 
-        doc = parse_clf(wrap_snippet(example))
+        doc = read_clf(wrap_snippet(example))
 
         assert doc is not None
 
@@ -295,7 +299,7 @@ def test_range_example(self) -> None:
         </Range>
         """
 
-        doc = parse_clf(wrap_snippet(example))
+        doc = read_clf(wrap_snippet(example))
 
         assert doc is not None
 
@@ -323,7 +327,7 @@ def test_log_example_1(self) -> None:
         </Log>
         """
 
-        doc = parse_clf(wrap_snippet(example))
+        doc = read_clf(wrap_snippet(example))
 
         assert doc is not None
 
@@ -353,7 +357,7 @@ def test_log_example_2(self) -> None:
         </Log>
         """
 
-        doc = parse_clf(wrap_snippet(example))
+        doc = read_clf(wrap_snippet(example))
 
         assert doc is not None
 
@@ -394,7 +398,7 @@ def test_exponent_example_1(self) -> None:
         </Exponent>
         """
 
-        doc = parse_clf(wrap_snippet(example))
+        doc = read_clf(wrap_snippet(example))
 
         assert doc is not None
 
@@ -422,7 +426,7 @@ def test_exponent_example_2(self) -> None:
         </Exponent>
         """
 
-        doc = parse_clf(wrap_snippet(example))
+        doc = read_clf(wrap_snippet(example))
 
         assert doc is not None
 
@@ -453,7 +457,7 @@ def test_exponent_example_3(self) -> None:
         </Exponent>
         """
 
-        doc = parse_clf(wrap_snippet(example))
+        doc = read_clf(wrap_snippet(example))
 
         assert doc is not None
 
@@ -484,7 +488,7 @@ def test_exponent_example_4(self) -> None:
         </Exponent>
         """
 
-        doc = parse_clf(wrap_snippet(example))
+        doc = read_clf(wrap_snippet(example))
 
         assert doc is not None
 
@@ -522,7 +526,7 @@ def test_ASC_CDL_example(self) -> None:
         </ASC_CDL>
         """
 
-        doc = parse_clf(wrap_snippet(example))
+        doc = read_clf(wrap_snippet(example))
 
         assert doc is not None
 
@@ -571,7 +575,7 @@ def test_ACES2065_1_to_ACEScg_example(self) -> None:
         </ProcessList>
         """
 
-        doc = parse_clf(example)
+        doc = read_clf(example)
 
         assert doc is not None
 
@@ -610,7 +614,7 @@ def test_ACES2065_1_to_ACEScct_example(self) -> None:
         </ProcessList>
         """  # noqa: E501
 
-        doc = parse_clf(example)
+        doc = read_clf(example)
 
         assert doc is not None
 
@@ -653,7 +657,7 @@ def test_CIE_XYZ_to_CIELAB_example(self) -> None:
         </ProcessList>
         """
 
-        doc = parse_clf(example)
+        doc = read_clf(example)
 
         assert doc is not None
 
@@ -676,7 +680,7 @@ def test_fail_on_invalid_namespace(self) -> None:
         </ProcessList>
         """
 
-        pytest.raises(ParsingError, parse_clf, example)
+        pytest.raises(ParsingError, read_clf, example)
 
     @pytest.mark.with_ocio
     def test_CLF_from_OCIO(self) -> None:
@@ -693,7 +697,7 @@ def test_CLF_from_OCIO(self) -> None:
         )
         clf_text = ocio_transform.write("Academy/ASC Common LUT Format").encode()
 
-        doc = parse_clf(clf_text)
+        doc = read_clf(clf_text)
 
         assert doc is not None
 

colour_clf_io/tests/test_clf_writing.py

@@ -8,7 +8,7 @@
 import colour_clf_io.elements
 import colour_clf_io.process_nodes
 import colour_clf_io.values
-from colour_clf_io import parse_clf, write_clf
+from colour_clf_io import read_clf, write_clf
 
 from .test_clf_common import wrap_snippet
 
@@ -46,11 +46,11 @@ def assert_valid_roundtrip_for_file(path: str) -> None:
 
 
 def assert_valid_roundtrip_for_doc(doc: str) -> None:
-    doc_original = parse_clf(doc)
+    doc_original = read_clf(doc)
     assert doc_original is not None
     xml = write_clf(doc_original)
     assert xml is not None
-    doc_after_roundtrip = parse_clf(xml)
+    doc_after_roundtrip = read_clf(xml)
     assert doc_original == doc_after_roundtrip
 
 
@@ -323,7 +323,7 @@ def test_ACES2065_1_to_ACEScg_example(self) -> None:
         </ProcessList>
         """
 
-        doc = parse_clf(example)
+        doc = read_clf(example)
 
         assert doc is not None
 
@@ -362,7 +362,7 @@ def test_ACES2065_1_to_ACEScct_example(self) -> None:
         </ProcessList>
         """  # noqa: E501
 
-        doc = parse_clf(example)
+        doc = read_clf(example)
 
         assert doc is not None
 
@@ -405,7 +405,7 @@ def test_CIE_XYZ_to_CIELAB_example(self) -> None:
         </ProcessList>
         """
 
-        doc = parse_clf(example)
+        doc = read_clf(example)
 
         assert doc is not None