utils

utils

Shared utility functions for BigBrotr services.

Provides lightweight helpers used across multiple services. Domain-specific logic belongs in per-service utils.py modules; only truly shared primitives live here.

See Also

configs: Shared Pydantic network configuration models. queries: Centralized SQL query functions. mixins: Reusable service mixin classes.

Classes

Functions

parse_relay_url

parse_relay_url(url: str) -> Relay | None

Parse a relay URL string into a Relay object.

Strips whitespace, rejects empty/non-string input, and delegates to the Relay constructor for RFC 3986 validation and network detection.

Parameters:

• url (str) –

  Potential relay URL string.

Returns:

• Relay | None –

  Relay object if valid, None

• Relay | None –

  otherwise.

Source code in src/bigbrotr/services/common/utils.py

def parse_relay_url(url: str) -> Relay | None:
    """Parse a relay URL string into a Relay object.

    Strips whitespace, rejects empty/non-string input, and delegates to the
    [Relay][bigbrotr.models.relay.Relay] constructor for RFC 3986 validation
    and network detection.

    Args:
        url: Potential relay URL string.

    Returns:
        [Relay][bigbrotr.models.relay.Relay] object if valid, ``None``
        otherwise.
    """
    if not url or not isinstance(url, str):
        return None

    url = url.strip()
    if not url:
        return None

    try:
        return Relay(url)
    except (ValueError, TypeError):
        return None

parse_delete_result

parse_delete_result(result: str | None) -> int

Extract the row count from a PostgreSQL DELETE command status string.

PostgreSQL returns status strings like 'DELETE 42' from DELETE commands. This function extracts the trailing integer count.

Parameters:

• result (str | None) –

  The command status string (e.g., 'DELETE 42'), or None if the command returned no status.

Returns:

• int –

  Number of rows affected, or 0 if parsing fails.

Source code in src/bigbrotr/services/common/utils.py

def parse_delete_result(result: str | None) -> int:
    """Extract the row count from a PostgreSQL DELETE command status string.

    PostgreSQL returns status strings like ``'DELETE 42'`` from DELETE
    commands. This function extracts the trailing integer count.

    Args:
        result: The command status string (e.g., ``'DELETE 42'``), or
            ``None`` if the command returned no status.

    Returns:
        Number of rows affected, or ``0`` if parsing fails.
    """
    if not result:
        return 0
    try:
        return int(result.split()[-1])
    except (ValueError, IndexError):
        return 0