typing fixes

Author: aaronsteers

airbyte_cdk/cli/airbyte_cdk/__init__.py

@@ -48,7 +48,7 @@
 
 
 @click.group(
-    help=cast(str, __doc__).replace("\n", "\n\n"),  # Workaround to format help text correctly
+    help=__doc__.replace("\n", "\n\n"),  # Workaround to format help text correctly
     invoke_without_command=True,
 )
 @click.option(

airbyte_cdk/cli/airbyte_cdk/_connector.py

@@ -40,6 +40,7 @@
 
 import os
 from pathlib import Path
+from types import ModuleType
 
 import rich_click as click
 
@@ -49,6 +50,7 @@
 
 click.rich_click.TEXT_MARKUP = "markdown"
 
+pytest: ModuleType | None
 try:
     import pytest
 except ImportError:

airbyte_cdk/test/declarative/models/__init__.py

@@ -1,7 +0,0 @@
-from airbyte_cdk.test.declarative.models.scenario import (
-    ConnectorTestScenario,
-)
-
-__all__ = [
-    "ConnectorTestScenario",
-]

airbyte_cdk/test/declarative/utils/job_runner.py

@@ -16,7 +16,7 @@
     Status,
 )
 from airbyte_cdk.test import entrypoint_wrapper
-from airbyte_cdk.test.declarative.models import (
+from airbyte_cdk.test.standard_tests.models import (
     ConnectorTestScenario,
 )
 

airbyte_cdk/test/standard_tests/connector_base.py

@@ -19,10 +19,10 @@
     Type,
 )
 from airbyte_cdk.test import entrypoint_wrapper
-from airbyte_cdk.test.declarative.models import (
+from airbyte_cdk.test.standard_tests._job_runner import IConnector, run_test_job
+from airbyte_cdk.test.standard_tests.models import (
     ConnectorTestScenario,
 )
-from airbyte_cdk.test.declarative.utils.job_runner import IConnector, run_test_job
 from airbyte_cdk.test.standard_tests.test_resources import (
     ACCEPTANCE_TEST_CONFIG,
     find_connector_root,
@@ -32,9 +32,46 @@
 class ConnectorTestSuiteBase(abc.ABC):
     """Base class for connector test suites."""
 
-    connector: type[IConnector] | Callable[[], IConnector] | None
+    connector: type[IConnector] | Callable[[], IConnector] | None  # type: ignore [reportRedeclaration]
     """The connector class or a factory function that returns an scenario of IConnector."""
 
+    @classproperty  # type: ignore [no-redef]
+    def connector(cls) -> type[IConnector] | Callable[[], IConnector] | None:
+        """Get the connector class for the test suite.
+
+        This assumes a python connector and should be overridden by subclasses to provide the
+        specific connector class to be tested.
+        """
+        connector_root = cls.get_connector_root_dir()
+        connector_name = connector_root.name
+
+        expected_module_name = connector_name.replace("-", "_").lower()
+        expected_class_name = connector_name.replace("-", "_").title().replace("_", "")
+
+        # dynamically import and get the connector class: <expected_module_name>.<expected_class_name>
+
+        # Dynamically import the module
+        try:
+            module = importlib.import_module(expected_module_name)
+        except ModuleNotFoundError as e:
+            raise ImportError(f"Could not import module '{expected_module_name}'.") from e
+
+        # Dynamically get the class from the module
+        try:
+            return cast(type[IConnector], getattr(module, expected_class_name))
+        except AttributeError as e:
+            # We did not find it based on our expectations, so let's check if we can find it
+            # with a case-insensitive match.
+            matching_class_name = next(
+                (name for name in dir(module) if name.lower() == expected_class_name.lower()),
+                None,
+            )
+            if not matching_class_name:
+                raise ImportError(
+                    f"Module '{expected_module_name}' does not have a class named '{expected_class_name}'."
+                ) from e
+            return cast(type[IConnector], getattr(module, matching_class_name))
+
     @classmethod
     def get_test_class_dir(cls) -> Path:
         """Get the file path that contains the class."""
@@ -85,43 +122,6 @@ def get_connector_root_dir(cls) -> Path:
         """Get the root directory of the connector."""
         return find_connector_root([cls.get_test_class_dir(), Path.cwd()])
 
-    @classproperty
-    def connector(cls) -> type[IConnector]:
-        """Get the connector class for the test suite.
-
-        This assumes a python connector and should be overridden by subclasses to provide the
-        specific connector class to be tested.
-        """
-        connector_root = cls.get_connector_root_dir()
-        connector_name = connector_root.name
-
-        expected_module_name = connector_name.replace("-", "_").lower()
-        expected_class_name = connector_name.replace("-", "_").title().replace("_", "")
-
-        # dynamically import and get the connector class: <expected_module_name>.<expected_class_name>
-
-        # Dynamically import the module
-        try:
-            module = importlib.import_module(expected_module_name)
-        except ModuleNotFoundError as e:
-            raise ImportError(f"Could not import module '{expected_module_name}'.") from e
-
-        # Dynamically get the class from the module
-        try:
-            return getattr(module, expected_class_name)
-        except AttributeError as e:
-            # We did not find it based on our expectations, so let's check if we can find it
-            # with a case-insensitive match.
-            matching_class_name = next(
-                (name for name in dir(module) if name.lower() == expected_class_name.lower()),
-                None,
-            )
-            if not matching_class_name:
-                raise ImportError(
-                    f"Module '{expected_module_name}' does not have a class named '{expected_class_name}'."
-                ) from e
-            return getattr(module, matching_class_name)
-
     @classproperty
     def acceptance_test_config_path(cls) -> Path:
         """Get the path to the acceptance test config file."""

airbyte_cdk/test/standard_tests/declarative_sources.py

@@ -9,8 +9,8 @@
 from airbyte_cdk.sources.declarative.concurrent_declarative_source import (
     ConcurrentDeclarativeSource,
 )
-from airbyte_cdk.test.declarative.models import ConnectorTestScenario
 from airbyte_cdk.test.declarative.utils.job_runner import IConnector
+from airbyte_cdk.test.standard_tests.models import ConnectorTestScenario
 from airbyte_cdk.test.standard_tests.source_base import SourceTestSuiteBase
 from airbyte_cdk.test.standard_tests.test_resources import MANIFEST_YAML
 

airbyte_cdk/test/standard_tests/source_base.py

@@ -13,10 +13,6 @@
     Type,
 )
 from airbyte_cdk.test import entrypoint_wrapper
-from airbyte_cdk.test.declarative.models import (
-    ConnectorTestScenario,
-)
-from airbyte_cdk.test.declarative.utils.job_runner import run_test_job
 from airbyte_cdk.test.standard_tests._job_runner import run_test_job
 from airbyte_cdk.test.standard_tests.connector_base import (
     ConnectorTestSuiteBase,