etlplus 0.4.7__py3-none-any.whl → 0.8.3__py3-none-any.whl

etlplus/cli/main.py

@@ -9,187 +9,27 @@ This module exposes :func:`main` for the console script as well as
 
 from __future__ import annotations
 
-import argparse
 import contextlib
 import sys
-from collections.abc import Sequence
-from typing import Literal
+import warnings
 
 import click
 import typer
 
-from .. import __version__
-from ..enums import DataConnectorType
-from ..enums import FileFormat
-from ..utils import json_type
-from .app import PROJECT_URL
-from .app import app
-from .handlers import cmd_extract
-from .handlers import cmd_list
-from .handlers import cmd_load
-from .handlers import cmd_pipeline
-from .handlers import cmd_run
-from .handlers import cmd_transform
-from .handlers import cmd_validate
+from .commands import app
 
 # SECTION: EXPORTS ========================================================== #
 
 
 __all__ = [
     # Functions
-    'create_parser',
     'main',
 ]
 
 
-# SECTION: TYPE ALIASES ===================================================== #
-
-
-type FormatContext = Literal['source', 'target']
-
-
-# SECTION: INTERNAL CLASSES ================================================= #
-
-
-class _FormatAction(argparse.Action):
-    """
-    Argparse action that records when ``--source-format`` or
-    ``--target-format`` is provided."""
-
-    def __call__(
-        self,
-        parser: argparse.ArgumentParser,
-        namespace: argparse.Namespace,
-        values: str | Sequence[object] | None,
-        option_string: str | None = None,
-    ) -> None:  # pragma: no cover
-        setattr(namespace, self.dest, values)
-        namespace._format_explicit = True
-
-
 # SECTION: INTERNAL FUNCTIONS =============================================== #
 
 
-def _add_boolean_flag(
-    parser: argparse.ArgumentParser,
-    *,
-    name: str,
-    help_text: str,
-) -> None:
-    """Add a toggle that also supports the ``--no-`` prefix via 3.13.
-
-    Parameters
-    ----------
-    parser : argparse.ArgumentParser
-        Parser receiving the flag.
-    name : str
-        Primary flag name without leading dashes.
-    help_text : str
-        Help text rendered in ``--help`` output.
-    """
-
-    parser.add_argument(
-        f'--{name}',
-        action=argparse.BooleanOptionalAction,
-        default=False,
-        help=help_text,
-    )
-
-
-def _add_config_option(
-    parser: argparse.ArgumentParser,
-    *,
-    required: bool = True,
-) -> None:
-    """Attach the shared ``--config`` option used by legacy commands.
-
-    Parameters
-    ----------
-    parser : argparse.ArgumentParser
-        Parser receiving the option.
-    required : bool, optional
-        Whether the flag must be provided. Defaults to ``True``.
-    """
-
-    parser.add_argument(
-        '--config',
-        required=required,
-        help='Path to pipeline YAML configuration file',
-    )
-
-
-def _add_format_options(
-    parser: argparse.ArgumentParser,
-    *,
-    context: FormatContext,
-) -> None:
-    """
-    Attach shared ``--source-format`` or ``--target-format`` options to
-    extract/load parsers.
-
-    Parameters
-    ----------
-    parser : argparse.ArgumentParser
-        Parser to augment.
-    context : FormatContext
-        Context for the format option: either ``'source'`` or ``'target'``
-    """
-    parser.set_defaults(_format_explicit=False)
-    parser.add_argument(
-        '--source-format',
-        choices=list(FileFormat.choices()),
-        default='json',
-        action=_FormatAction,
-        help=(
-            f'Format of the {context}. Overrides filename-based inference '
-            'when provided.'
-        ),
-    )
-    parser.add_argument(
-        '--target-format',
-        choices=list(FileFormat.choices()),
-        default='json',
-        action=_FormatAction,
-        help=(
-            f'Format of the {context}. Overrides filename-based inference '
-            'when provided.'
-        ),
-    )
-
-
-def _cli_description() -> str:
-    return '\n'.join(
-        [
-            'ETLPlus - A Swiss Army knife for simple ETL operations.',
-            '',
-            '    Provide a subcommand and options. Examples:',
-            '',
-            '    etlplus extract file in.csv > out.json',
-            '    etlplus validate in.json --rules \'{"required": ["id"]}\'',
-            (
-                '    etlplus transform --from file in.csv --operations '
-                '\'{"select": ["id"]}\' --to file -o out.json'
-            ),
-            '    etlplus extract in.csv | etlplus load --to file out.json',
-            '',
-            '    Override format inference when extensions are misleading:',
-            '',
-            '    etlplus extract data.txt --source-format csv',
-            '    etlplus load payload.bin --target-format json',
-        ],
-    )
-
-
-def _cli_epilog() -> str:
-    return '\n'.join(
-        [
-            'Tip:',
-            '    --source-format and --target-format override format '
-            'inference based on filename extensions when needed.',
-        ],
-    )
-
-
 def _emit_context_help(
     ctx: click.Context | None,
 ) -> bool:
@@ -280,216 +120,23 @@ def _is_unknown_command_error(
 # SECTION: FUNCTIONS ======================================================== #
 
 
-def create_parser() -> argparse.ArgumentParser:
+def create_parser() -> object:
     """
-    Return the legacy :mod:`argparse` parser wired to current handlers.
+    Deprecated legacy entrypoint.
 
-    Returns
-    -------
-    argparse.ArgumentParser
-        Parser compatible with historical ``etlplus`` entry points.
+    The argparse-based parser has been removed. Use the Typer-powered
+    ``etlplus`` CLI instead (``etlplus.cli.commands.app``).
     """
-
-    parser = argparse.ArgumentParser(
-        prog='etlplus',
-        description=_cli_description(),
-        epilog=_cli_epilog(),
-        formatter_class=argparse.RawDescriptionHelpFormatter,
-    )
-
-    parser.add_argument(
-        '-V',
-        '--version',
-        action='version',
-        version=f'%(prog)s {__version__}',
-    )
-
-    subparsers = parser.add_subparsers(
-        dest='command',
-        help='Available commands',
-    )
-    subparsers.required = True
-
-    extract_parser = subparsers.add_parser(
-        'extract',
-        help='Extract data from sources (files, databases, REST APIs)',
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-    )
-    extract_parser.add_argument(
-        'source_type',
-        choices=list(DataConnectorType.choices()),
-        help='Type of source to extract from',
-    )
-    extract_parser.add_argument(
-        'source',
-        help=(
-            'Source location (file path, database connection string, '
-            'or API URL)'
-        ),
-    )
-    _add_format_options(extract_parser, context='source')
-    extract_parser.set_defaults(func=cmd_extract)
-
-    validate_parser = subparsers.add_parser(
-        'validate',
-        help='Validate data from sources',
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-    )
-    validate_parser.add_argument(
-        'source',
-        help='Data source to validate (file path or JSON string)',
-    )
-    validate_parser.add_argument(
-        '--rules',
-        type=json_type,
-        default={},
-        help='Validation rules as JSON string',
-    )
-    validate_parser.set_defaults(func=cmd_validate)
-
-    transform_parser = subparsers.add_parser(
-        'transform',
-        help='Transform data',
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-    )
-    transform_parser.add_argument(
-        'source',
-        help='Data source to transform (file path or JSON string)',
-    )
-    transform_parser.add_argument(
-        '--operations',
-        type=json_type,
-        default={},
-        help='Transformation operations as JSON string',
-    )
-    transform_parser.add_argument(
-        '--from',
-        dest='from_',
-        choices=list(DataConnectorType.choices()),
-        help='Override the inferred source type (file, database, api).',
-    )
-    transform_parser.add_argument(
-        '--to',
-        dest='to',
-        choices=list(DataConnectorType.choices()),
-        help='Override the inferred target type (file, database, api).',
-    )
-    transform_parser.add_argument(
-        '--source-format',
-        choices=list(FileFormat.choices()),
-        dest='source_format',
-        help=(
-            'Input payload format when SOURCE is - or a literal payload. '
-            'File sources infer format from the extension.'
-        ),
+    warnings.warn(
+        'create_parser is deprecated and no longer returns an argparse '
+        'parser. Use the Typer CLI entrypoint instead.',
+        DeprecationWarning,
+        stacklevel=2,
     )
-    transform_parser.add_argument(
-        '--target-format',
-        dest='target_format',
-        choices=list(FileFormat.choices()),
-        help=(
-            'Output payload format '
-            'when writing to stdout or non-file targets. '
-            'File targets infer format from the extension.'
-        ),
-    )
-    transform_parser.set_defaults(func=cmd_transform)
-
-    load_parser = subparsers.add_parser(
-        'load',
-        help='Load data to targets (files, databases, REST APIs)',
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-    )
-    load_parser.add_argument(
-        'source',
-        help='Data source to load (file path or JSON string)',
-    )
-    load_parser.add_argument(
-        'target_type',
-        choices=list(DataConnectorType.choices()),
-        help='Type of target to load to',
-    )
-    load_parser.add_argument(
-        'target',
-        help=(
-            'Target location (file path, database connection string, '
-            'or API URL)'
-        ),
-    )
-    _add_format_options(load_parser, context='target')
-    load_parser.set_defaults(func=cmd_load)
-
-    pipe_parser = subparsers.add_parser(
-        'pipeline',
-        help=(
-            'Inspect or run pipeline YAML (see '
-            f'{PROJECT_URL}/blob/main/docs/pipeline-guide.md)'
-        ),
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+    raise RuntimeError(
+        'The legacy argparse parser has been removed. Invoke the Typer-based '
+        'CLI via `etlplus` or import `etlplus.cli.commands.app`.',
     )
-    _add_config_option(pipe_parser)
-    pipe_parser.add_argument(
-        '--list',
-        action='store_true',
-        help='List available job names and exit',
-    )
-    pipe_parser.add_argument(
-        '--run',
-        metavar='JOB',
-        help='Run a specific job by name',
-    )
-    pipe_parser.set_defaults(func=cmd_pipeline)
-
-    list_parser = subparsers.add_parser(
-        'list',
-        help='List ETL pipeline metadata',
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-    )
-    _add_config_option(list_parser)
-    _add_boolean_flag(
-        list_parser,
-        name='pipelines',
-        help_text='List ETL pipelines',
-    )
-    _add_boolean_flag(
-        list_parser,
-        name='sources',
-        help_text='List data sources',
-    )
-    _add_boolean_flag(
-        list_parser,
-        name='targets',
-        help_text='List data targets',
-    )
-    _add_boolean_flag(
-        list_parser,
-        name='transforms',
-        help_text='List data transforms',
-    )
-    list_parser.set_defaults(func=cmd_list)
-
-    run_parser = subparsers.add_parser(
-        'run',
-        help=(
-            'Run an ETL pipeline '
-            f'(see {PROJECT_URL}/blob/main/docs/run-module.md)'
-        ),
-        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-    )
-    _add_config_option(run_parser)
-    run_parser.add_argument(
-        '-j',
-        '--job',
-        help='Name of the job to run',
-    )
-    run_parser.add_argument(
-        '-p',
-        '--pipeline',
-        help='Name of the pipeline to run',
-    )
-    run_parser.set_defaults(func=cmd_run)
-
-    return parser
 
 
 def main(

etlplus/cli/options.py

@@ -0,0 +1,49 @@
+"""
+:mod:`etlplus.cli.options` module.
+
+Shared Typer helper utilities for command-line interface (CLI) option
+configuration.
+"""
+
+from __future__ import annotations
+
+from .types import DataConnectorContext
+
+# SECTION: EXPORTS ========================================================== #
+
+
+__all__ = [
+    # Functions
+    'typer_format_option_kwargs',
+]
+
+
+def typer_format_option_kwargs(
+    *,
+    context: DataConnectorContext,
+    rich_help_panel: str = 'Format overrides',
+) -> dict[str, object]:
+    """
+    Return common Typer option kwargs for format overrides.
+
+    Parameters
+    ----------
+    context : DataConnectorContext
+        Either ``'source'`` or ``'target'`` to tailor help text.
+    rich_help_panel : str, optional
+        The rich help panel name. Default is ``'Format overrides'``.
+
+    Returns
+    -------
+    dict[str, object]
+        The Typer option keyword arguments.
+    """
+    return {
+        'metavar': 'FORMAT',
+        'show_default': False,
+        'rich_help_panel': rich_help_panel,
+        'help': (
+            f'Payload format when the {context} is stdin/inline or a '
+            'non-file connector. File connectors infer from extensions.'
+        ),
+    }