rename Registry class

Author: geritwagner

search_query/ebscohost/v_1_0_0/parser.py

@@ -2,9 +2,13 @@
 """Versioned EBSCO parser wrappers."""
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from search_query.ebscohost.linter import EBSCOListLinter
-from search_query.ebscohost.parser import EBSCOListParser
-from search_query.ebscohost.parser import EBSCOParser
+from search_query.ebscohost.parser import EBSCOListParser, EBSCOParser
+
+if TYPE_CHECKING:  # pragma: no cover
+    from search_query.registry import Registry
 
 # pylint: disable=too-few-public-methods
 
@@ -26,6 +30,8 @@ def __init__(self, query_list: str, *, field_general: str = "") -> None:
         self.linter = EBSCOListLinter(self, EBSCOParser_v1_0_0)
 
 
-def register(registry, *, platform: str, version: str) -> None:
+def register(registry: Registry, *, platform: str, version: str) -> None:
+    """Register these parsers with the ``registry``."""
+
     registry.register_parser_string(platform, version, EBSCOParser_v1_0_0)
     registry.register_parser_list(platform, version, EBSCOListParser_v1_0_0)

search_query/ebscohost/v_1_0_0/serializer.py

@@ -2,17 +2,23 @@
 """EBSCO serializer for version 1.0.0."""
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from search_query.ebscohost.serializer import EBSCOQuerySerializer
 
-# pylint: disable=too-few-public-methods
+if TYPE_CHECKING:  # pragma: no cover
+    from search_query.registry import Registry
 
 
+# pylint: disable=too-few-public-methods
 class EBCOSerializer_v1_0_0(EBSCOQuerySerializer):
     """EBSCO serializer for version 1.0.0."""
 
     VERSION = "1.0.0"
 
 
-def register(registry, *, platform: str, version: str) -> None:
+def register(registry: Registry, *, platform: str, version: str) -> None:
+    """Register this serializer with the ``registry``."""
+
     registry.register_serializer_string(platform, version, EBCOSerializer_v1_0_0)
     registry.register_serializer_list(platform, version, EBCOSerializer_v1_0_0)

search_query/ebscohost/v_1_0_0/translator.py

@@ -2,14 +2,21 @@
 """EBSCO translator for version 1.0.0."""
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from search_query.ebscohost.translator import EBSCOTranslator
 
+if TYPE_CHECKING:  # pragma: no cover
+    from search_query.registry import Registry
+
 
 class EBSCOTranslator_v1_0_0(EBSCOTranslator):
     """Translator for EBSCO queries."""
 
     VERSION = "1.0.0"
 
 
-def register(registry, *, platform: str, version: str) -> None:
+def register(registry: Registry, *, platform: str, version: str) -> None:
+    """Register this translator with the ``registry``."""
+
     registry.register_translator(platform, version, EBSCOTranslator_v1_0_0)

search_query/generic/v_1_0_0/serializer.py

@@ -1,15 +1,24 @@
 #!/usr/bin/env python3
+"""Generic serializer for version 1.0.0."""
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from search_query.generic.serializer import GenericSerializer
 
+if TYPE_CHECKING:  # pragma: no cover
+    from search_query.registry import Registry
+
 
-class GenericSerializer_v_1_0_0(GenericSerializer):
+# pylint: disable=too-few-public-methods
+class GenericSerializer_v1_0_0(GenericSerializer):
     """Generic serializer for version 1.0.0."""
 
     VERSION = "1.0.0"
 
 
-def register(registry, *, platform: str, version: str) -> None:
-    registry.register_serializer_string(platform, version, GenericSerializer_v_1_0_0)
-    registry.register_serializer_list(platform, version, GenericSerializer_v_1_0_0)
+def register(registry: Registry, *, platform: str, version: str) -> None:
+    """Register this serializer with the ``registry``."""
+
+    registry.register_serializer_string(platform, version, GenericSerializer_v1_0_0)
+    registry.register_serializer_list(platform, version, GenericSerializer_v1_0_0)

search_query/pubmed/v_1_0_0/parser.py

@@ -2,9 +2,13 @@
 """Versioned PubMed parser wrappers."""
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from search_query.pubmed.linter import PubmedQueryListLinter
-from search_query.pubmed.parser import PubmedListParser
-from search_query.pubmed.parser import PubmedParser
+from search_query.pubmed.parser import PubmedListParser, PubmedParser
+
+if TYPE_CHECKING:  # pragma: no cover
+    from search_query.registry import Registry
 
 
 class PubMedParser_v1_0_0(PubmedParser):
@@ -25,6 +29,8 @@ def __init__(self, query_list: str, *, field_general: str = "") -> None:
         self.linter = PubmedQueryListLinter(self, PubMedParser_v1_0_0)
 
 
-def register(registry, *, platform: str, version: str) -> None:
+def register(registry: Registry, *, platform: str, version: str) -> None:
+    """Register these parsers with the ``registry``."""
+
     registry.register_parser_string(platform, version, PubMedParser_v1_0_0)
     registry.register_parser_list(platform, version, PubMedListParser_v1_0_0)

search_query/pubmed/v_1_0_0/serializer.py

@@ -2,18 +2,23 @@
 """PubMed serializer for version 1.0.0."""
 from __future__ import annotations
 
-from search_query.pubmed.serializer import PUBMEDQuerySerializer
+from typing import TYPE_CHECKING
 
+from search_query.pubmed.serializer import PUBMEDQuerySerializer
 
-# pylint: disable=too-few-public-methods
+if TYPE_CHECKING:  # pragma: no cover
+    from search_query.registry import Registry
 
 
+# pylint: disable=too-few-public-methods
 class PubMedSerializer_v1_0_0(PUBMEDQuerySerializer):
     """PubMed serializer for version 1.0.0."""
 
     VERSION = "1.0.0"
 
 
-def register(registry, *, platform: str, version: str) -> None:
+def register(registry: Registry, *, platform: str, version: str) -> None:
+    """Register this serializer with the ``registry``."""
+
     registry.register_serializer_string(platform, version, PubMedSerializer_v1_0_0)
     registry.register_serializer_list(platform, version, PubMedSerializer_v1_0_0)

search_query/pubmed/v_1_0_0/translator.py

@@ -2,14 +2,21 @@
 """PubMed translator for version 1.0.0."""
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 from search_query.pubmed.translator import PubmedTranslator
 
+if TYPE_CHECKING:  # pragma: no cover
+    from search_query.registry import Registry
+
 
 class PubMedTranslator_v1_0_0(PubmedTranslator):
     """Translator for Pubmed queries."""
 
     VERSION = "1.0.0"
 
 
-def register(registry, *, platform: str, version: str) -> None:
+def register(registry: Registry, *, platform: str, version: str) -> None:
+    """Register this translator with the ``registry``."""
+
     registry.register_translator(platform, version, PubMedTranslator_v1_0_0)