sourcery_analytics_cli_partials.py

"""Parts of larger commands."""

# This file is a copy from `sourcery_analytics.cli.partials` from the
# `sourcery_analytics` project.
#
# At the time of writing, this file violates the following rules:
# - `require-parameter-annotation`
# - `require-return-annotation`
#
# According to the Google Python Style Guide, all public functions must have their
# parameter and return types annotated, which is not the case here.
#
# File extracted from:
# https://github.com/sourcery-ai/sourcery-analytics/blob/d605829bbc0e3ae84decf21998c26df8980c66b9/sourcery_analytics/cli/partials.py
#
# No changes were introduced apart from this comment block.

import operator
import pathlib
import typing

import pydantic
import typer
import rich.progress
import rich.table
import rich.console

from sourcery_analytics import analyze
from sourcery_analytics.metrics.compounders import NamedMetricResult
from sourcery_analytics.settings import Settings


def analyze_rich_output(method_metric, methods, metrics, sort):
    """Performs analysis and displays results in a rich-formatted table."""

    console = rich.console.Console()
    methods_progress = rich.progress.track(methods, description="Analyzing methods...")
    analysis: typing.List[NamedMetricResult] = sorted(
        analyze(methods_progress, metrics=metrics),
        key=operator.itemgetter(sort.method_method_name),
        reverse=True,
    )
    console.print("[bold green]Analysis Complete")
    table = rich.table.Table()
    table.add_column("Method")
    for metric_choice in method_metric:
        table.add_column(metric_choice.value, justify="right")
    for metric in analysis:
        table.add_row(
            *(
                f"{value}" if isinstance(value, (float, int)) else str(value)
                for _sub_metric_name, value in metric
            )
        )
    console.print(table)
    raise typer.Exit()


def analyze_plain_output(methods, metrics, sort):
    """Performs analysis and displays the python object's representation."""
    analysis = sorted(
        analyze(methods, metrics=metrics),
        key=operator.itemgetter(sort.method_method_name),
        reverse=True,
    )
    typer.echo(analysis)


def analyze_csv_output(method_metric, methods, metrics, sort):
    """Performs analysis and displays the results in CSV format."""
    analysis = sorted(
        analyze(methods, metrics=metrics),
        key=operator.itemgetter(sort.method_method_name),
        reverse=True,
    )
    result = ""
    result += (
        "qualname,"
        + ",".join([str(metric_choice.value) for metric_choice in method_metric])
        + "\n"
    )
    for metric in analysis:
        result += ",".join([str(value) for _sub_metric_name, value in metric]) + "\n"
    typer.echo(result)


def aggregate_rich_output(aggregation, aggregation_method, methods, metrics) -> None:
    """Analyse methods, and aggregates results.

    Displays the results in a rich-formatted table.
    """

    console = rich.console.Console()
    methods_progress = rich.progress.track(methods, description="Analyzing methods...")
    result = analyze(methods_progress, metrics=metrics, aggregation=aggregation_method)
    table = rich.table.Table()
    table.add_column("Metric")
    table.add_column(f"{aggregation.value.title()} Value", justify="right")
    for metric_name, metric_value in result:
        table.add_row(metric_name, str(metric_value))
    console.print(table)


def aggregate_plain_output(aggregation_method, methods, metrics) -> None:
    """Analyse methods, and aggregates results.

    Displays the python representation of the results.
    """
    result = analyze(methods, metrics=metrics, aggregation=aggregation_method)
    typer.echo(result)


def aggregate_csv_output(aggregation_method, method_metric, methods, metrics) -> None:
    """Analyse methods, and aggregates results.

    Displays the results in CSV format.
    """
    analysis = analyze(methods, metrics=metrics, aggregation=aggregation_method)
    result = ",".join([m.value for m in method_metric]) + "\n"
    result += ",".join(str(value) for _metric_name, value in analysis)
    typer.echo(result)


def read_settings(
    settings_file: pathlib.Path, console: rich.console.Console
) -> Settings:
    """Loads settings in the CLI.

    Wraps the basic settings loader in order to print relevant error messages and
    exit with correct codes.
    """
    if not settings_file.exists():
        console.print(
            f"[yellow]Warning:[/] could not find settings file "
            f"[bold]{settings_file}[/], using defaults."
        )
        settings = Settings()
    else:
        try:
            settings = Settings.from_toml_file(settings_file)
        except pydantic.ValidationError as exc:
            console.print(
                f"[bold red]Error:[/] unable to parse settings file "
                f"[bold]{settings_file}[/]."
            )
            raise typer.Exit(2) from exc
    return settings