logdetective 2.13.0__py3-none-any.whl → 3.1.0__py3-none-any.whl

logdetective/server/plot.py

@@ -1,432 +0,0 @@
-import datetime
-from typing import Optional, Union, Dict
-
-import numpy
-from numpy.typing import ArrayLike
-from matplotlib import dates, colormaps, axes, pyplot, figure
-
-from logdetective.server.models import TimePeriod
-from logdetective.server.database.models import (
-    AnalyzeRequestMetrics,
-    EndpointType,
-    Reactions,
-)
-
-
-class Definition:
-    """Define plot details, given a time period."""
-
-    def __init__(self, time_period: TimePeriod):
-        self.time_period = time_period
-        self.days_diff = time_period.get_time_period().days
-        if self.time_period.hours:
-            self._freq = "H"
-            self._time_format = "%Y-%m-%d %H"
-            self._locator = dates.HourLocator(interval=2)
-            self._time_unit = "hour"
-            self._time_delta = datetime.timedelta(hours=1)
-        elif self.time_period.days:
-            self._freq = "D"
-            self._time_format = "%Y-%m-%d"
-            self._locator = dates.DayLocator(interval=1)
-            self._time_unit = "day"
-            self._time_delta = datetime.timedelta(days=1)
-        elif self.time_period.weeks:
-            self._freq = "W"
-            self._time_format = "%Y-%m-%d"
-            self._locator = dates.WeekdayLocator(interval=1)
-            self._time_unit = "week"
-            self._time_delta = datetime.timedelta(weeks=1)
-
-    @property
-    def freq(self):
-        # pylint: disable=missing-function-docstring
-        return self._freq
-
-    @property
-    def time_format(self):
-        # pylint: disable=missing-function-docstring
-        return self._time_format
-
-    @property
-    def locator(self):
-        # pylint: disable=missing-function-docstring
-        return self._locator
-
-    @property
-    def time_unit(self):
-        # pylint: disable=missing-function-docstring
-        return self._time_unit
-
-    @property
-    def time_delta(self):
-        # pylint: disable=missing-function-docstring
-        return self._time_delta
-
-
-def create_time_series_arrays(
-    values_dict: dict[datetime.datetime, int],
-    plot_def: Definition,
-    start_time: datetime.datetime,
-    end_time: datetime.datetime,
-    value_type: Optional[Union[type[int], type[float]]] = int,
-) -> tuple[numpy.ndarray, numpy.ndarray]:
-    """Create time series arrays from a dictionary of values.
-
-    This function generates two aligned numpy arrays:
-    1. An array of timestamps from start_time to end_time
-    2. A corresponding array of valuesfor each timestamp
-
-    The timestamps are truncated to the precision specified by time_format.
-    If a timestamp in values_dict matches a generated timestamp, its values is used;
-    otherwise, the value defaults to zero.
-
-    Args:
-        values_dict: Dictionary mapping timestamps to their respective values
-        start_time: The starting timestamp of the time series
-        end_time: The ending timestamp of the time series
-        time_delta: The time interval between consecutive timestamps
-        time_format: String format for datetime truncation (e.g., '%Y-%m-%d %H:%M')
-
-    Returns:
-        A tuple containing:
-            - numpy.ndarray: Array of timestamps
-            - numpy.ndarray: Array of corresponding values
-    """
-    num_intervals = int((end_time - start_time) / plot_def.time_delta) + 1
-
-    timestamps = numpy.array(
-        [
-            datetime.datetime.strptime(
-                (start_time + i * plot_def.time_delta).strftime(
-                    format=plot_def.time_format
-                ),
-                plot_def.time_format,
-            )
-            for i in range(num_intervals)
-        ]
-    )
-    values = numpy.zeros(num_intervals, dtype=value_type)
-
-    timestamp_to_index = {timestamp: i for i, timestamp in enumerate(timestamps)}
-
-    for timestamp, count in values_dict.items():
-        if timestamp in timestamp_to_index:
-            values[timestamp_to_index[timestamp]] = count
-
-    return timestamps, values
-
-
-def _add_bar_chart(
-    ax: axes.Axes,
-    plot_def: Definition,
-    timestamps: ArrayLike,
-    values: ArrayLike,
-    label: str,
-) -> None:
-    """Add a blue bar chart"""
-    bar_width = (
-        0.8 * plot_def.time_delta.total_seconds() / 86400
-    )  # Convert to days for matplotlib
-    ax.bar(
-        timestamps,
-        values,
-        width=bar_width,
-        alpha=0.7,
-        color="skyblue",
-        label=label,
-    )
-    ax.set_xlabel("Time")
-    ax.set_ylabel(label, color="blue")
-    ax.tick_params(axis="y", labelcolor="blue")
-
-    ax.xaxis.set_major_formatter(dates.DateFormatter(plot_def.time_format))
-    ax.xaxis.set_major_locator(plot_def.locator)
-
-    pyplot.xticks(rotation=45)
-
-    ax.grid(True, alpha=0.3)
-
-
-def _add_line_chart(  # pylint: disable=too-many-arguments disable=too-many-positional-arguments
-    ax: axes.Axes,
-    timestamps: ArrayLike,
-    values: ArrayLike,
-    label: str,
-    color: str = "red",
-    set_label: bool = True,
-):
-    """Add a red line chart"""
-    ax.plot(timestamps, values, color=color, linestyle="-", linewidth=2, label=label)
-    if set_label:
-        ax.set_ylabel(label, color=color)
-        ax.tick_params(axis="y", labelcolor=color)
-
-
-async def requests_per_time(
-    period_of_time: TimePeriod,
-    endpoint: EndpointType = EndpointType.ANALYZE,
-    end_time: Optional[datetime.datetime] = None,
-) -> figure.Figure:
-    """
-    Generate a visualization of request counts over a specified time period.
-
-    This function creates a dual-axis plot showing:
-    1. A bar chart of request counts per time interval
-    2. A line chart showing the cumulative request count
-
-    The time intervals are determined by the provided TimePeriod object, which defines
-    the granularity and formatting of the time axis.
-
-    Args:
-        period_of_time: A TimePeriod object that defines the time period and interval
-                        for the analysis (e.g., hourly, daily, weekly)
-        endpoint: One of the API endpoints
-        end_time: The end time for the analysis period. If None, defaults to the current
-                  UTC time
-
-    Returns:
-        A matplotlib Figure object containing the generated visualization
-    """
-    end_time = end_time or datetime.datetime.now(datetime.timezone.utc)
-    start_time = period_of_time.get_period_start_time(end_time)
-    plot_def = Definition(period_of_time)
-    requests_counts = await AnalyzeRequestMetrics.get_requests_in_period(
-        start_time, end_time, plot_def.time_format, endpoint
-    )
-    timestamps, counts = create_time_series_arrays(
-        requests_counts, plot_def, start_time, end_time
-    )
-
-    fig, ax1 = pyplot.subplots(figsize=(12, 6))
-    _add_bar_chart(ax1, plot_def, timestamps, counts, "Requests")
-
-    ax2 = ax1.twinx()
-    _add_line_chart(ax2, timestamps, numpy.cumsum(counts), "Cumulative Requests")
-
-    pyplot.title(
-        f"Requests received for API {endpoint} ({start_time.strftime(plot_def.time_format)} "
-        f"to {end_time.strftime(plot_def.time_format)})"
-    )
-
-    lines1, labels1 = ax1.get_legend_handles_labels()
-    lines2, labels2 = ax2.get_legend_handles_labels()
-    ax1.legend(lines1 + lines2, labels1 + labels2, loc="center")
-
-    pyplot.tight_layout()
-
-    return fig
-
-
-async def average_time_per_responses(  # pylint: disable=too-many-locals
-    period_of_time: TimePeriod,
-    endpoint: EndpointType = EndpointType.ANALYZE,
-    end_time: Optional[datetime.datetime] = None,
-) -> figure.Figure:
-    """
-    Generate a visualization of average response time and length over a specified time period.
-
-    This function creates a dual-axis plot showing:
-    1. A bar chart of average response time per time interval
-    1. A line chart of average response length per time interval
-
-    The time intervals are determined by the provided TimePeriod object, which defines
-    the granularity and formatting of the time axis.
-
-    Args:
-        period_of_time: A TimePeriod object that defines the time period and interval
-                        for the analysis (e.g., hourly, daily, weekly)
-        endpoint: One of the API endpoints
-        end_time: The end time for the analysis period. If None, defaults to the current
-                  UTC time
-
-    Returns:
-        A matplotlib Figure object containing the generated visualization
-    """
-    end_time = end_time or datetime.datetime.now(datetime.timezone.utc)
-    start_time = period_of_time.get_period_start_time(end_time)
-    plot_def = Definition(period_of_time)
-    responses_average_time = (
-        await AnalyzeRequestMetrics.get_responses_average_time_in_period(
-            start_time, end_time, plot_def.time_format, endpoint
-        )
-    )
-    timestamps, average_time = create_time_series_arrays(
-        responses_average_time,
-        plot_def,
-        start_time,
-        end_time,
-        float,
-    )
-
-    fig, ax1 = pyplot.subplots(figsize=(12, 6))
-    _add_bar_chart(
-        ax1, plot_def, timestamps, average_time, "average response time (seconds)"
-    )
-
-    responses_average_length = (
-        await AnalyzeRequestMetrics.get_responses_average_length_in_period(
-            start_time, end_time, plot_def.time_format, endpoint
-        )
-    )
-    timestamps, average_length = create_time_series_arrays(
-        responses_average_length,
-        plot_def,
-        start_time,
-        end_time,
-        float,
-    )
-
-    ax2 = ax1.twinx()
-    _add_line_chart(ax2, timestamps, average_length, "average response length (chars)")
-
-    pyplot.title(
-        f"average response time for API {endpoint} ({start_time.strftime(plot_def.time_format)} "
-        f"to {end_time.strftime(plot_def.time_format)})"
-    )
-
-    lines1, labels1 = ax1.get_legend_handles_labels()
-    lines2, labels2 = ax2.get_legend_handles_labels()
-    ax1.legend(lines1 + lines2, labels1 + labels2, loc="center")
-
-    pyplot.tight_layout()
-
-    return fig
-
-
-async def _collect_emoji_data(
-    start_time: datetime.datetime, plot_def: Definition
-) -> Dict[str, Dict[datetime.datetime, int]]:
-    """Collect and organize emoji feedback data
-
-    Counts all emojis given to logdetective comments created since start_time.
-    Collect counts in time accordingly to the plot definition.
-    """
-    reactions = await Reactions.get_since(start_time)
-    reactions_values_dict: Dict[str, Dict] = {}
-    for comment_created_at, reaction in reactions:
-        comment_created_at_formatted = comment_created_at.strptime(
-            comment_created_at.strftime(plot_def.time_format), plot_def.time_format
-        )
-        if reaction.reaction_type in reactions_values_dict:
-            reaction_values_dict = reactions_values_dict[reaction.reaction_type]
-            if comment_created_at_formatted in reaction_values_dict:
-                reaction_values_dict[comment_created_at_formatted] += reaction.count
-            else:
-                reaction_values_dict[comment_created_at_formatted] = reaction.count
-        else:
-            reaction_values_dict = {comment_created_at_formatted: reaction.count}
-            reactions_values_dict.update({reaction.reaction_type: reaction_values_dict})
-
-    return reactions_values_dict
-
-
-def _plot_emoji_data(  # pylint: disable=too-many-locals
-    ax: axes.Axes,
-    reactions_values_dict: Dict[str, Dict[datetime.datetime, int]],
-    plot_def: Definition,
-    start_time: datetime.datetime,
-    end_time: datetime.datetime,
-):
-    """Plot each emoji's data on its own axis."""
-    emoji_lines = {}
-    emoji_labels = {}
-
-    # Find global min and max y values to set consistent scale
-    all_counts = []
-    for emoji, dict_counts in reactions_values_dict.items():
-        timestamps, counts = create_time_series_arrays(
-            dict_counts, plot_def, start_time, end_time
-        )
-        all_counts.extend(counts)
-
-    colors = [
-        colormaps["viridis"](i)
-        for i in numpy.linspace(0, 1, len(reactions_values_dict))
-    ]
-
-    first_emoji = True
-    for i, (emoji, dict_counts) in enumerate(reactions_values_dict.items()):
-        timestamps, counts = create_time_series_arrays(
-            dict_counts, plot_def, start_time, end_time
-        )
-
-        if first_emoji:
-            current_ax = ax
-            first_emoji = False
-        else:
-            current_ax = ax.twinx()
-            current_ax.spines["right"].set_position(("outward", 60 * (i - 1)))
-
-        _add_line_chart(current_ax, timestamps, counts, f"{emoji}", colors[i], False)
-        emoji_lines[emoji], emoji_labels[emoji] = current_ax.get_legend_handles_labels()
-
-        # Set the same y-limits for all axes
-        current_ax.set_ylim(0, max(all_counts) * 1.1)
-
-        # Only show y-ticks on the first axis to avoid clutter
-        if 0 < i < len(reactions_values_dict):
-            current_ax.set_yticks([])
-
-    return emoji_lines, emoji_labels
-
-
-async def emojis_per_time(
-    period_of_time: TimePeriod,
-    end_time: Optional[datetime.datetime] = None,
-) -> figure.Figure:
-    """
-    Generate a visualization of overall emoji feedback
-    over a specified time period.
-
-    This function creates a multiple-axis plot showing
-    a line chart for every found emoji
-
-    The time intervals are determined by the provided TimePeriod object, which defines
-    the granularity and formatting of the time axis.
-
-    Args:
-        period_of_time: A TimePeriod object that defines the time period and interval
-                        for the analysis (e.g., hourly, daily, weekly)
-        end_time: The end time for the analysis period. If None, defaults to the current
-                  UTC time
-
-    Returns:
-        A matplotlib Figure object containing the generated visualization
-    """
-    plot_def = Definition(period_of_time)
-    end_time = end_time or datetime.datetime.now(datetime.timezone.utc)
-    start_time = period_of_time.get_period_start_time(end_time)
-    reactions_values_dict = await _collect_emoji_data(start_time, plot_def)
-
-    fig, ax = pyplot.subplots(figsize=(12, 6))
-
-    emoji_lines, emoji_labels = _plot_emoji_data(
-        ax, reactions_values_dict, plot_def, start_time, end_time
-    )
-
-    pyplot.title(
-        f"Emoji feedback ({start_time.strftime(plot_def.time_format)} "
-        f"to {end_time.strftime(plot_def.time_format)})"
-    )
-
-    all_lines = []
-    for lines in emoji_lines.values():
-        all_lines.extend(lines)
-    all_labels = []
-    for labels in emoji_labels.values():
-        all_labels.extend(labels)
-
-    ax.legend(all_lines, all_labels, loc="upper left")
-    ax.set_xlabel("Time")
-    ax.set_ylabel("Count")
-
-    # Format x-axis
-    ax.xaxis.set_major_formatter(dates.DateFormatter(plot_def.time_format))
-    ax.xaxis.set_major_locator(plot_def.locator)
-    ax.tick_params(axis="x", labelrotation=45)
-    ax.grid(True, alpha=0.3)
-
-    pyplot.tight_layout()
-
-    return fig