tinybird 0.0.1.dev0__py3-none-any.whl

tinybird/tb_cli_modules/exceptions.py

@@ -0,0 +1,91 @@
+from typing import Any, Dict, Optional
+
+import click
+
+from tinybird.tb_cli_modules.telemetry import add_telemetry_event
+
+
+class CLIException(click.exceptions.ClickException):
+    """Default exception for all exceptions raised in the CLI.
+
+    Allows to specift a custom telemetry event to be sent before
+    raising the exception (if not specified, it sends a generic
+    `error` beacon with the error message)
+    """
+
+    def __init__(self, message: str, telemetry_event: Optional[str] = None, **kw_telemetry_event_data: Any) -> None:
+        telemetry_event = telemetry_event or "error"
+        data: Dict[str, Any] = {"error": message}
+        data.update(kw_telemetry_event_data)
+        add_telemetry_event(telemetry_event, **data)
+        super().__init__(message)
+
+
+class CLIAuthException(CLIException):
+    """Exceptions generated by the auth commands"""
+
+    def __init__(self, message: str, **kw_telemetry_event_data: Any) -> None:
+        super().__init__(message, "auth_error", **kw_telemetry_event_data)
+
+
+class CLIReleaseException(CLIException):
+    """Exceptions generated by the release commands"""
+
+    def __init__(self, message: str, **kw_telemetry_event_data: Any) -> None:
+        super().__init__(message, "release_error", **kw_telemetry_event_data)
+
+
+class CLIBranchException(CLIException):
+    """Exceptions generated by the branch commands"""
+
+    def __init__(self, message: str, **kw_telemetry_event_data: Any) -> None:
+        super().__init__(message, "branch_error", **kw_telemetry_event_data)
+
+
+class CLIGitReleaseException(CLIException):
+    """Exceptions generated by the git release related commands"""
+
+    def __init__(self, message: str, **kw_telemetry_event_data: Any) -> None:
+        super().__init__(message, "git_release_error", **kw_telemetry_event_data)
+
+
+class CLIConnectionException(CLIException):
+    """Exceptions generated by the connection commands"""
+
+    def __init__(self, message: str, **kw_telemetry_event_data: Any) -> None:
+        super().__init__(message, "connection_error", **kw_telemetry_event_data)
+
+
+class CLIDatasourceException(CLIException):
+    """Exceptions generated by the datasource commands"""
+
+    def __init__(self, message: str, **kw_telemetry_event_data: Any) -> None:
+        super().__init__(message, "datasource_error", **kw_telemetry_event_data)
+
+
+class CLIPipeException(CLIException):
+    """Exceptions generated by the pipe commands"""
+
+    def __init__(self, message: str, **kw_telemetry_event_data: Any) -> None:
+        super().__init__(message, "pipe_error", **kw_telemetry_event_data)
+
+
+class CLIWorkspaceMembersException(CLIException):
+    """Exceptions generated by the workspace members commands"""
+
+    def __init__(self, message: str, **kw_telemetry_event_data: Any) -> None:
+        super().__init__(message, "workspace_members_error", **kw_telemetry_event_data)
+
+
+class CLIWorkspaceException(CLIException):
+    """Exceptions generated by the workspace commands"""
+
+    def __init__(self, message: str, **kw_telemetry_event_data: Any) -> None:
+        super().__init__(message, "workspace_error", **kw_telemetry_event_data)
+
+
+class CLITokenException(CLIException):
+    """Exceptions generated by the token commands"""
+
+    def __init__(self, message: str, **kw_telemetry_event_data: Any) -> None:
+        super().__init__(message, "token_error", **kw_telemetry_event_data)

tinybird/tb_cli_modules/fmt.py

@@ -0,0 +1,91 @@
+import difflib
+import sys
+from pathlib import Path
+from typing import List, Optional
+
+import aiofiles
+import click
+from click import Context
+
+from tinybird.datafile import color_diff, format_datasource, format_pipe, is_file_a_datasource, peek
+from tinybird.feedback_manager import FeedbackManager
+from tinybird.tb_cli_modules.cli import cli
+from tinybird.tb_cli_modules.common import coro
+
+
+@cli.command()
+@click.argument("filenames", type=click.Path(exists=True), nargs=-1, required=True)
+@click.option(
+    "--line-length",
+    is_flag=False,
+    default=100,
+    help="A number indicating the maximum characters per line in the node SQL, lines will be splitted based on the SQL syntax and the number of characters passed as a parameter",
+)
+@click.option("--dry-run", is_flag=True, default=False, help="Don't ask to override the local file")
+@click.option("--yes", is_flag=True, default=False, help="Do not ask for confirmation to overwrite the local file")
+@click.option(
+    "--diff",
+    is_flag=True,
+    default=False,
+    help="Formats local file, prints the diff and exits 1 if different, 0 if equal",
+)
+@click.pass_context
+@coro
+async def fmt(
+    ctx: Context, filenames: List[str], line_length: int, dry_run: bool, yes: bool, diff: bool
+) -> Optional[str]:
+    """
+    Formats a .datasource, .pipe or .incl file
+
+    This command removes comments starting with # from the file, use DESCRIPTION instead.
+
+    The format command tries to parse the datafile so syntax errors might rise.
+
+    .incl files must contain a NODE definition
+    """
+
+    result = ""
+    failed = []
+    for filename in filenames:
+        if not diff:
+            click.echo(filename)
+        extensions = Path(filename).suffixes
+        if is_file_a_datasource(filename):
+            result = await format_datasource(filename, skip_eval=True)
+        elif (".pipe" in extensions) or (".incl" in extensions):
+            result = await format_pipe(filename, line_length, skip_eval=True)
+        else:
+            click.echo("Unsupported file type. Supported files types are: .pipe, .incl and .datasource")
+            return None
+
+        if diff:
+            result = result.rstrip("\n")
+            lines_fmt = [f"{line}\n" for line in result.split("\n")]
+            async with aiofiles.open(filename, "r") as file:
+                lines_file = await file.readlines()
+            diff_result = difflib.unified_diff(
+                lines_file, lines_fmt, fromfile=f"{Path(filename).name} local", tofile="fmt datafile"
+            )
+            diff_result = color_diff(diff_result)
+            not_empty, diff_lines = peek(diff_result)
+            if not_empty:
+                sys.stdout.writelines(diff_lines)
+                failed.append(filename)
+                click.echo("")
+        else:
+            click.echo(result)
+            if dry_run:
+                return None
+
+            if yes or click.confirm(FeedbackManager.prompt_override_local_file(name=filename)):
+                async with aiofiles.open(f"{filename}", "w") as file:
+                    await file.write(result)
+
+                click.echo(FeedbackManager.success_generated_local_file(file=filename))
+
+    if len(failed):
+        click.echo(FeedbackManager.error_failed_to_format_files(number=len(failed)))
+        for f in failed:
+            click.echo(f"tb fmt {f} --yes")
+        sys.exit(1)
+    return result

tinybird/tb_cli_modules/job.py

@@ -0,0 +1,85 @@
+# This is a command file for our CLI. Please keep it clean.
+#
+# - If it makes sense and only when strictly necessary, you can create utility functions in this file.
+# - But please, **do not** interleave utility functions and command definitions.
+
+import click
+from click import Context
+
+from tinybird.client import DoesNotExistException, TinyB
+from tinybird.feedback_manager import FeedbackManager
+from tinybird.tb_cli_modules.cli import cli
+from tinybird.tb_cli_modules.common import coro, echo_safe_humanfriendly_tables_format_smart_table
+from tinybird.tb_cli_modules.exceptions import CLIException
+
+
+@cli.group()
+@click.pass_context
+def job(ctx: Context) -> None:
+    """Jobs commands."""
+
+
+@job.command(name="ls")
+@click.option(
+    "-s",
+    "--status",
+    help="Show only jobs with this status",
+    type=click.Choice(["waiting", "working", "done", "error"], case_sensitive=False),
+    multiple=True,
+    default=None,
+)
+@click.pass_context
+@coro
+async def jobs_ls(ctx: Context, status: str) -> None:
+    """List jobs, up to 100 in the last 48h"""
+    client: TinyB = ctx.ensure_object(dict)["client"]
+    jobs = await client.jobs(status=status)
+    columns = ["id", "kind", "status", "created at", "updated at", "job url"]
+    click.echo(FeedbackManager.info_jobs())
+    table = []
+    for j in jobs:
+        table.append([j[c.replace(" ", "_")] for c in columns])
+    echo_safe_humanfriendly_tables_format_smart_table(table, column_names=columns)
+    click.echo("\n")
+
+
+@job.command(name="details")
+@click.argument("job_id")
+@click.pass_context
+@coro
+async def job_details(ctx: Context, job_id: str) -> None:
+    """Get details for any job created in the last 48h"""
+    client: TinyB = ctx.ensure_object(dict)["client"]
+    job = await client.job(job_id)
+    columns = []
+    click.echo(FeedbackManager.info_job(job=job_id))
+    table = []
+    columns = job.keys()
+    table = [job.values()]
+    echo_safe_humanfriendly_tables_format_smart_table(table, column_names=columns)
+    click.echo("\n")
+
+
+@job.command(name="cancel")
+@click.argument("job_id")
+@click.pass_context
+@coro
+async def job_cancel(ctx: Context, job_id: str) -> None:
+    """Try to cancel a job"""
+    client = ctx.ensure_object(dict)["client"]
+
+    try:
+        result = await client.job_cancel(job_id)
+    except DoesNotExistException:
+        raise CLIException(FeedbackManager.error_job_does_not_exist(job_id=job_id))
+    except Exception as e:
+        raise CLIException(FeedbackManager.error_exception(error=e))
+    else:
+        current_job_status = result["status"]
+        if current_job_status == "cancelling":
+            click.echo(FeedbackManager.success_job_cancellation_cancelling(job_id=job_id))
+        elif current_job_status == "cancelled":
+            click.echo(FeedbackManager.success_job_cancellation_cancelled(job_id=job_id))
+        else:
+            raise CLIException(FeedbackManager.error_job_cancelled_but_status_unknown(job_id=job_id))
+    click.echo("\n")