airbyte.sources.util

  1# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
  2"""Utility functions for working with sources."""
  3
  4from __future__ import annotations
  5
  6import warnings
  7from decimal import Decimal, InvalidOperation
  8from typing import TYPE_CHECKING, Any
  9
 10from airbyte._executors.util import get_connector_executor
 11from airbyte.exceptions import PyAirbyteInputError
 12from airbyte.sources.base import Source
 13
 14
 15if TYPE_CHECKING:
 16    from pathlib import Path
 17
 18    from airbyte.callbacks import ConfigChangeCallback
 19
 20
 21def get_connector(
 22    name: str,
 23    config: dict[str, Any] | None = None,
 24    *,
 25    version: str | None = None,
 26    pip_url: str | None = None,
 27    local_executable: Path | str | None = None,
 28    install_if_missing: bool = True,
 29) -> Source:
 30    """Deprecated. Use get_source instead."""
 31    warnings.warn(
 32        "The `get_connector()` function is deprecated and will be removed in a future version."
 33        "Please use `get_source()` instead.",
 34        DeprecationWarning,
 35        stacklevel=2,
 36    )
 37    return get_source(
 38        name=name,
 39        config=config,
 40        version=version,
 41        pip_url=pip_url,
 42        local_executable=local_executable,
 43        install_if_missing=install_if_missing,
 44    )
 45
 46
 47def get_source(  # noqa: PLR0913 # Too many arguments
 48    name: str,
 49    config: dict[str, Any] | None = None,
 50    *,
 51    config_change_callback: ConfigChangeCallback | None = None,
 52    streams: str | list[str] | None = None,
 53    version: str | None = None,
 54    use_python: bool | Path | str | None = None,
 55    pip_url: str | None = None,
 56    local_executable: Path | str | None = None,
 57    docker_image: bool | str | None = None,
 58    use_host_network: bool = False,
 59    source_manifest: bool | dict | Path | str | None = None,
 60    install_if_missing: bool = True,
 61    install_root: Path | None = None,
 62) -> Source:
 63    """Get a connector by name and version.
 64
 65    If an explicit install or execution method is requested (e.g. `local_executable`,
 66    `docker_image`, `pip_url`, `source_manifest`), the connector will be executed using this method.
 67
 68    Otherwise, an appropriate method will be selected based on the available connector metadata:
 69    1. If the connector is registered and has a YAML source manifest is available, the YAML manifest
 70       will be downloaded and used to to execute the connector.
 71    2. Else, if the connector is registered and has a PyPI package, it will be installed via pip.
 72    3. Else, if the connector is registered and has a Docker image, and if Docker is available, it
 73       will be executed using Docker.
 74
 75    Args:
 76        name: connector name
 77        config: connector config - if not provided, you need to set it later via the set_config
 78            method.
 79        config_change_callback: callback function to be called when the connector config changes.
 80        streams: list of stream names to select for reading. If set to "*", all streams will be
 81            selected. If not provided, you can set it later via the `select_streams()` or
 82            `select_all_streams()` method.
 83        version: connector version - if not provided, the currently installed version will be used.
 84            If no version is installed, the latest available version will be used. The version can
 85            also be set to "latest" to force the use of the latest available version.
 86        use_python: (Optional.) Python interpreter specification:
 87            - True: Use current Python interpreter. (Inferred if `pip_url` is set.)
 88            - False: Use Docker instead.
 89            - Path: Use interpreter at this path.
 90            - str: Use specific Python version. E.g. "3.11" or "3.11.10". If the version is not yet
 91                installed, it will be installed by uv. (This generally adds less than 3 seconds
 92                to install times.)
 93        pip_url: connector pip URL - if not provided, the pip url will be inferred from the
 94            connector name.
 95        local_executable: If set, the connector will be assumed to already be installed and will be
 96            executed using this path or executable name. Otherwise, the connector will be installed
 97            automatically in a virtual environment.
 98        docker_image: If set, the connector will be executed using Docker. You can specify `True`
 99            to use the default image for the connector, or you can specify a custom image name.
100            If `version` is specified and your image name does not already contain a tag
101            (e.g. `my-image:latest`), the version will be appended as a tag (e.g. `my-image:0.1.0`).
102        use_host_network: If set, along with docker_image, the connector will be executed using
103            the host network. This is useful for connectors that need to access resources on
104            the host machine, such as a local database. This parameter is ignored when
105            `docker_image` is not set.
106        source_manifest: If set, the connector will be executed based on a declarative YAML
107            source definition. This input can be `True` to attempt to auto-download a YAML spec,
108            `dict` to accept a Python dictionary as the manifest, `Path` to pull a manifest from
109            the local file system, or `str` to pull the definition from a web URL.
110        install_if_missing: Whether to install the connector if it is not available locally. This
111            parameter is ignored when `local_executable` or `source_manifest` are set.
112        install_root: (Optional.) The root directory where the virtual environment will be
113            created. If not provided, the current working directory will be used.
114    """
115    return Source(
116        name=name,
117        config=config,
118        config_change_callback=config_change_callback,
119        streams=streams,
120        executor=get_connector_executor(
121            name=name,
122            version=version,
123            use_python=use_python,
124            pip_url=pip_url,
125            local_executable=local_executable,
126            docker_image=docker_image,
127            use_host_network=use_host_network,
128            source_manifest=source_manifest,
129            install_if_missing=install_if_missing,
130            install_root=install_root,
131        ),
132    )
133
134
135def get_benchmark_source(
136    num_records: int | str = "5e5",
137    *,
138    install_if_missing: bool = True,
139) -> Source:
140    """Get a source for benchmarking.
141
142    This source will generate dummy records for performance benchmarking purposes.
143    You can specify the number of records to generate using the `num_records` parameter.
144    The `num_records` parameter can be an integer or a string in scientific notation.
145    For example, `"5e6"` will generate 5 million records. If underscores are providing
146    within a numeric a string, they will be ignored.
147
148    Args:
149        num_records: The number of records to generate. Defaults to "5e5", or
150            500,000 records.
151            Can be an integer (`1000`) or a string in scientific notation.
152            For example, `"5e6"` will generate 5 million records.
153        install_if_missing: Whether to install the source if it is not available locally.
154
155    Returns:
156        Source: The source object for benchmarking.
157    """
158    if isinstance(num_records, str):
159        try:
160            num_records = int(Decimal(num_records.replace("_", "")))
161        except InvalidOperation as ex:
162            raise PyAirbyteInputError(
163                message="Invalid number format.",
164                original_exception=ex,
165                input_value=str(num_records),
166            ) from None
167
168    return get_source(
169        name="source-e2e-test",
170        docker_image=True,
171        # docker_image="airbyte/source-e2e-test:latest",
172        config={
173            "type": "BENCHMARK",
174            "schema": "FIVE_STRING_COLUMNS",
175            "terminationCondition": {
176                "type": "MAX_RECORDS",
177                "max": num_records,
178            },
179        },
180        streams="*",
181        install_if_missing=install_if_missing,
182    )
183
184
185__all__ = [
186    "get_source",
187    "get_benchmark_source",
188]