Fixed doc and import

Author: GlassOfWhiskey

cwl_utils/file_formats.py

@@ -1,3 +1,9 @@
+"""
+CWL file formats utilities.
+
+For more information, please visit https://www.commonwl.org/user_guide/16-file-formats/
+"""
+
 from typing import List, Optional, Set, Union
 
 from rdflib import Graph, OWL, RDFS, URIRef

tests/test_format.py

@@ -8,10 +8,11 @@
 from schema_salad.exceptions import ValidationException
 from schema_salad.fetcher import DefaultFetcher
 
-from cwl_utils.format import check_format
+from cwl_utils.file_formats import check_format
+from cwl_utils.types import CWLObjectType
 
 
-def _create_file(format_: Optional[str] = None):
+def _create_file(format_: Optional[str] = None) -> CWLObjectType:
     obj = {
         "class": "File",
         "basename": "example.txt",
@@ -25,7 +26,7 @@ def _create_file(format_: Optional[str] = None):
     return obj
 
 
-def _load_format(fetchurl: str):
+def _load_format(fetchurl: str) -> Graph:
     fetcher = DefaultFetcher({}, requests.Session())
     content = fetcher.fetch_text(fetchurl)
     graph = Graph()
@@ -38,15 +39,15 @@ def _load_format(fetchurl: str):
     return graph
 
 
-def test_check_format():
+def test_check_format() -> None:
     check_format(
         actual_file=_create_file(format_="http://edamontology.org/format_2330"),
         input_formats="http://edamontology.org/format_2330",
         ontology=_load_format("http://edamontology.org/EDAM.owl"),
     )
 
 
-def test_check_format_no_format():
+def test_check_format_no_format() -> None:
     with raises(ValidationException, match=r"File has no 'format' defined: .*"):
         check_format(
             actual_file=_create_file(),
@@ -55,7 +56,7 @@ def test_check_format_no_format():
         )
 
 
-def test_check_format_no_input_formats():
+def test_check_format_no_input_formats() -> None:
     with raises(ValidationException, match=r"File has an incompatible format: .*"):
         check_format(
             actual_file=_create_file(format_="http://edamontology.org/format_2330"),
@@ -64,7 +65,7 @@ def test_check_format_no_input_formats():
         )
 
 
-def test_check_format_no_ontology():
+def test_check_format_no_ontology() -> None:
     check_format(
         actual_file=_create_file(format_="http://edamontology.org/format_2330"),
         input_formats="http://edamontology.org/format_2330",