Merge branch 'main' into edgarrmondragon/refactor/limit-usage-of-pend…

…ulum

docs/classes/singer_sdk.authenticators.APIAuthenticatorBase.rst

@@ -5,4 +5,4 @@
 
 .. autoclass:: APIAuthenticatorBase
     :members:
-    :special-members: __init__, __call__
+    :special-members: __init__, __call__

docs/conf.py

@@ -56,7 +56,7 @@
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # Show typehints in the description, along with parameter descriptions
-autodoc_typehints = "signature"
+autodoc_typehints = "description"
 autodoc_class_signature = "separated"
 autodoc_member_order = "groupwise"
 

docs/testing.md

@@ -10,7 +10,7 @@ The Meltano SDK test framework consists of 4 main components:
 1. A runner class (`TapTestRunner` and `TargetTestRunner`), responsible for executing Taps/Targets and capturing their output.
 1. A suite dataclass, containing a list of tests.
 1. A test template classes (`TapTestTemplate`, `StreamTestTemplate`, `AttributeTestTemplate` and `TargetTestTemplate`), with methods to `.setup()`, `.test()`, `.validate()` and `.teardown()` (called in that order using `.run()`).
-1. `get_tap_test_class` and `get_target_test_class` factory methods. These wrap a `get_test_class` factory method, which takes a runner and a list of suites and return a `pytest` test class.
+1. {func}`get_tap_test_class <singer_sdk.testing.get_tap_test_class>` and {func}`get_target_test_class <singer_sdk.testing.get_target_test_class>` factory methods. These wrap a `get_test_class` factory method, which takes a runner and a list of suites and return a `pytest` test class.
 
 ## Example Usage
 
@@ -76,7 +76,7 @@ class TestTargetExample(StandardTargetTests):
 
 ## Configuring Tests
 
-Test suite behaviors can be configured by passing a `SuiteConfig` instance to the `get_test_class` functions:
+Test suite behaviors can be configured by passing a {func}`SuiteConfig <singer_sdk.testing.SuiteConfig>` instance to the `get_test_class` functions:
 
 ```python
 from singer_sdk.testing import SuiteConfig, get_tap_test_class
@@ -101,7 +101,7 @@ TestTapStackExchange = get_tap_test_class(
 )
 ```
 
-Check out [`singer_sdk/testing/config.py`](https://github.com/meltano/sdk/tree/main/singer_sdk/testing/config.py) for available config options.
+Check out [the reference](#reference) for more information on the available configuration options.
 
 ## Writing New Tests
 
@@ -127,6 +127,21 @@ my_custom_tap_tests = TestSuite(
 )
 ```
 
-This suite can now be passed to `get_tap_test_class` or `get_target_test_class` in a list of `custom_suites` along with any other suites, to generate your custom test class.
+This suite can now be passed to {func}`get_tap_test_class <singer_sdk.testing.get_tap_test_class>` or {func}`get_target_test_class <singer_sdk.testing.get_target_test_class>` in a list of `custom_suites` along with any other suites, to generate your custom test class.
 
 If your new test covers a common or general case, consider contributing to the standard test library via a pull request to [meltano/sdk](https://github.com/meltano/sdk).
+
+## Reference
+
+```{eval-rst}
+.. autofunction:: singer_sdk.testing.get_tap_test_class
+```
+
+```{eval-rst}
+.. autofunction:: singer_sdk.testing.get_target_test_class
+```
+
+```{eval-rst}
+.. autoclass:: singer_sdk.testing.SuiteConfig
+    :members:
+```

pyproject.toml

@@ -91,14 +91,15 @@ pytest = {version=">=7.2.1", optional = true}
 pytest-durations = {version = ">=1.2.0", optional = true}
 
 # installed as optional 'faker' extra
-faker = {version = "~=22.5", optional = true}
+faker = {version = ">=22.5,<24.0", optional = true}
 
 [tool.poetry.extras]
 docs = [
-    "sphinx",
     "furo",
-    "sphinx-copybutton",
     "myst-parser",
+    "pytest",
+    "sphinx",
+    "sphinx-copybutton",
     "sphinx-autobuild",
     "sphinx-inline-tabs",
     "sphinx-notfound-page",

singer_sdk/connectors/sql.py

@@ -464,7 +464,8 @@ def discover_catalog_entry(
                 th.Property(
                     name=column_name,
                     wrapped=th.CustomType(jsonschema_type),
-                    required=not is_nullable,
+                    nullable=is_nullable,
+                    required=column_name in key_properties if key_properties else False,
                 ),
             )
         schema = table_schema.to_dict()

singer_sdk/typing.py

@@ -517,7 +517,7 @@ class Property(JSONTypeHelper[T], t.Generic[T]):
     """Generic Property. Should be nested within a `PropertiesList`."""
 
     # TODO: Make some of these arguments keyword-only. This is a breaking change.
-    def __init__(
+    def __init__(  # noqa: PLR0913
         self,
         name: str,
         wrapped: JSONTypeHelper[T] | type[JSONTypeHelper[T]],
@@ -527,6 +527,8 @@ def __init__(
         secret: bool | None = False,  # noqa: FBT002
         allowed_values: list[T] | None = None,
         examples: list[T] | None = None,
+        *,
+        nullable: bool | None = None,
     ) -> None:
         """Initialize Property object.
 
@@ -547,6 +549,7 @@ def __init__(
                 are permitted. This will define the type as an 'enum'.
             examples: Optional. A list of one or more sample values. These may be
                 displayed to the user as hints of the expected format of inputs.
+            nullable: If True, the property may be null.
         """
         self.name = name
         self.wrapped = wrapped
@@ -556,6 +559,7 @@ def __init__(
         self.secret = secret
         self.allowed_values = allowed_values or None
         self.examples = examples or None
+        self.nullable = nullable
 
     @property
     def type_dict(self) -> dict:  # type: ignore[override]
@@ -585,7 +589,7 @@ def to_dict(self) -> dict:
             A JSON Schema dictionary describing the object.
         """
         type_dict = self.type_dict
-        if self.optional:
+        if self.nullable or self.optional:
             type_dict = append_type(type_dict, "null")
         if self.default is not None:
             type_dict.update({"default": self.default})

tests/samples/conftest.py

@@ -25,7 +25,14 @@ def _sqlite_sample_db(sqlite_connector):
         for t in range(3):
             conn.execute(sa.text(f"DROP TABLE IF EXISTS t{t}"))
             conn.execute(
-                sa.text(f"CREATE TABLE t{t} (c1 int PRIMARY KEY, c2 varchar(10))"),
+                sa.text(
+                    f"""
+                    CREATE TABLE t{t} (
+                        c1 int PRIMARY KEY NOT NULL,
+                        c2 varchar(10) NOT NULL
+                    )
+                    """
+                ),
             )
             for x in range(100):
                 conn.execute(

tests/samples/test_tap_sqlite.py

@@ -80,6 +80,8 @@ def test_sqlite_discovery(sqlite_sample_tap: SQLTap):
 
     assert stream.metadata.root.table_key_properties == ["c1"]
     assert stream.primary_keys == ["c1"]
+    assert stream.schema["properties"]["c1"] == {"type": ["integer"]}
+    assert stream.schema["required"] == ["c1"]
 
 
 def test_sqlite_input_catalog(sqlite_sample_tap: SQLTap):
@@ -90,7 +92,7 @@ def test_sqlite_input_catalog(sqlite_sample_tap: SQLTap):
 
     for schema in [stream.schema, stream.stream_maps[0].transformed_schema]:
         assert len(schema["properties"]) == 2
-        assert schema["properties"]["c1"] == {"type": ["integer", "null"]}
+        assert schema["properties"]["c1"] == {"type": ["integer"]}
         assert schema["properties"]["c2"] == {"type": ["string", "null"]}
         assert stream.name == stream.tap_stream_id == "main-t1"