provide-foundation 0.0.0.dev0__py3-none-any.whl → 0.0.0.dev2__py3-none-any.whl

provide/foundation/logger/emoji/sets.py

@@ -1,458 +0,0 @@
-# src/provide/foundation/telemetry/emoji_sets.py
-"""
-Predefined Emoji Sets for Foundation Telemetry.
-
-This module contains definitions for built-in emoji set configurations that provide
-visual emoji mappings for common technologies and domains like LLMs, HTTP interactions,
-and databases.
-"""
-
-from provide.foundation.logger.emoji.matrix import (
-    PRIMARY_EMOJI,
-    SECONDARY_EMOJI,
-    TERTIARY_EMOJI,
-)
-from provide.foundation.logger.emoji.types import (
-    EmojiSet,
-    EmojiSetConfig,
-    FieldToEmojiMapping,
-)
-
-# --- Core DAS Layer Definition (Internal representation) ---
-# This serves as the default Domain-Action-Status system when no custom layers are active.
-# It handles the standard keys "domain", "action", "status".
-LEGACY_DAS_EMOJI_SETS: list[EmojiSet] = [
-    EmojiSet(name="_legacy_domain", emojis=PRIMARY_EMOJI, default_emoji_key="default"),
-    EmojiSet(
-        name="_legacy_action", emojis=SECONDARY_EMOJI, default_emoji_key="default"
-    ),
-    EmojiSet(name="_legacy_status", emojis=TERTIARY_EMOJI, default_emoji_key="default"),
-]
-LEGACY_DAS_FIELD_DEFINITIONS: list[FieldToEmojiMapping] = [
-    FieldToEmojiMapping(log_key="domain", emoji_set_name="_legacy_domain"),
-    FieldToEmojiMapping(log_key="action", emoji_set_name="_legacy_action"),
-    FieldToEmojiMapping(log_key="status", emoji_set_name="_legacy_status"),
-]
-# Note: The core DAS system is not a formal "EmojiSetConfig" that users enable by name.
-# It's the default behavior used in the `add_das_emoji_prefix` processor.
-
-# --- LLM Layer ---
-LLM_EMOJI_SETS: list[EmojiSet] = [
-    EmojiSet(
-        name="llm_provider",
-        emojis={
-            "openai": "🤖",
-            "anthropic": "📚",
-            "google": "🇬",
-            "meta": "🦙",
-            "mistral": "🌬️",
-            "perplexity": "❓",
-            "cohere": "🔊",
-            "default": "💡",
-        },
-        default_emoji_key="default",
-    ),
-    EmojiSet(
-        name="llm_task",
-        emojis={
-            "generation": "✍️",
-            "completion": "✅",
-            "embedding": "🔗",
-            "chat": "💬",
-            "tool_use": "🛠️",
-            "summarization": "📜",
-            "translation": "🌐",
-            "classification": "🏷️",
-            "default": "⚡",
-        },
-        default_emoji_key="default",
-    ),
-    EmojiSet(
-        name="llm_outcome",
-        emojis={
-            "success": "👍",
-            "error": "🔥",
-            "filtered_input": "🛡️👁️",
-            "filtered_output": "🛡️🗣️",
-            "rate_limit": "⏳",
-            "partial_success": "🤏",
-            "tool_call": "📞",
-            "default": "➡️",
-        },
-        default_emoji_key="default",
-    ),
-]
-LLM_FIELD_DEFINITIONS: list[FieldToEmojiMapping] = [
-    FieldToEmojiMapping(
-        log_key="llm.provider",
-        description="Name of the LLM provider (e.g., openai, anthropic)",
-        value_type="string",
-        emoji_set_name="llm_provider",
-    ),
-    FieldToEmojiMapping(
-        log_key="llm.task",
-        description="The specific LLM task being performed (e.g., generation, chat)",
-        value_type="string",
-        emoji_set_name="llm_task",
-    ),
-    FieldToEmojiMapping(
-        log_key="llm.model",
-        description="Identifier of the LLM model used",
-        value_type="string",
-        emoji_set_name="llm_provider",
-    ),  # Reuses provider emojis for model by default
-    FieldToEmojiMapping(
-        log_key="llm.outcome",
-        description="Outcome of the LLM operation",
-        value_type="string",
-        emoji_set_name="llm_outcome",
-    ),
-    FieldToEmojiMapping(
-        log_key="llm.input.tokens",
-        description="Number of input tokens",
-        value_type="integer",
-    ),
-    FieldToEmojiMapping(
-        log_key="llm.output.tokens",
-        description="Number of output tokens",
-        value_type="integer",
-    ),
-    FieldToEmojiMapping(
-        log_key="llm.tool.name",
-        description="Name of the tool called by the LLM",
-        value_type="string",
-    ),
-    FieldToEmojiMapping(
-        log_key="llm.tool.call_id",
-        description="Identifier for a specific tool call",
-        value_type="string",
-    ),
-    FieldToEmojiMapping(
-        log_key="duration_ms",
-        description="Duration of the LLM operation in milliseconds",
-        value_type="integer",
-    ),
-    FieldToEmojiMapping(
-        log_key="trace_id",
-        description="Distributed trace ID for the operation",
-        value_type="string",
-    ),
-]
-LLM_EMOJI_SET = EmojiSetConfig(
-    name="llm",
-    description="Emoji mappings for logging Large Language Model interactions.",
-    emoji_sets=LLM_EMOJI_SETS,
-    field_definitions=LLM_FIELD_DEFINITIONS,
-    priority=100,  # High priority
-)
-
-# --- Database Layer ---
-DB_EMOJI_SETS: list[EmojiSet] = [
-    EmojiSet(
-        name="db_system",
-        emojis={
-            "postgres": "🐘",
-            "mysql": "🐬",
-            "sqlite": "💾",
-            "mongodb": "🍃",
-            "redis": "🟥",
-            "elasticsearch": "🔍",
-            "default": "🗄️",
-        },
-        default_emoji_key="default",
-    ),
-    EmojiSet(
-        name="db_operation",
-        emojis={
-            "query": "🔍",
-            "select": "🔍",
-            "insert": "➕",
-            "update": "🔄",
-            "delete": "🗑️",
-            "connect": "🔗",
-            "disconnect": "💔",
-            "transaction_begin": "💳🟢",
-            "transaction_commit": "💳✅",
-            "transaction_rollback": "💳❌",
-            "default": "⚙️",
-        },
-        default_emoji_key="default",
-    ),
-    EmojiSet(  # Can reuse llm_outcome or define specific DB outcomes
-        name="db_outcome",
-        emojis={
-            "success": "👍",
-            "error": "🔥",
-            "not_found": "❓🤷",
-            "timeout": "⏱️",
-            "default": "➡️",
-        },
-        default_emoji_key="default",
-    ),
-]
-DB_FIELD_DEFINITIONS: list[FieldToEmojiMapping] = [
-    FieldToEmojiMapping(
-        log_key="db.system",
-        description="Type of database system (e.g., postgres, mysql)",
-        value_type="string",
-        emoji_set_name="db_system",
-    ),
-    FieldToEmojiMapping(
-        log_key="db.operation",
-        description="Database operation performed (e.g., query, insert)",
-        value_type="string",
-        emoji_set_name="db_operation",
-    ),
-    FieldToEmojiMapping(
-        log_key="db.statement",
-        description="The database statement executed (potentially truncated/sanitized)",
-        value_type="string",
-    ),
-    FieldToEmojiMapping(
-        log_key="db.table",
-        description="Name of the database table involved",
-        value_type="string",
-        emoji_set_name="db_system",
-        default_emoji_override_key="default",
-    ),  # Use default DB emoji
-    FieldToEmojiMapping(
-        log_key="db.rows_affected",
-        description="Number of rows affected by the operation",
-        value_type="integer",
-    ),
-    FieldToEmojiMapping(
-        log_key="db.outcome",
-        description="Outcome of the database operation",
-        value_type="string",
-        emoji_set_name="db_outcome",
-    ),
-    FieldToEmojiMapping(
-        log_key="duration_ms",
-        description="Duration of the database operation in milliseconds",
-        value_type="integer",
-    ),
-    FieldToEmojiMapping(
-        log_key="trace_id",
-        description="Distributed trace ID for the operation",
-        value_type="string",
-    ),
-]
-DATABASE_EMOJI_SET = EmojiSetConfig(
-    name="database",
-    description="Emoji mappings for logging database interactions.",
-    emoji_sets=DB_EMOJI_SETS,
-    field_definitions=DB_FIELD_DEFINITIONS,
-    priority=90,
-)
-
-# --- HTTP Layer (Client/Server) ---
-HTTP_EMOJI_SETS: list[EmojiSet] = [
-    EmojiSet(
-        name="http_method",
-        emojis={
-            "get": "📥",
-            "post": "📤",
-            "put": "📝⬆️",
-            "delete": "🗑️",
-            "patch": "🩹",
-            "head": "👤❔",
-            "options": "⚙️❔",
-            "default": "🌐",
-        },
-        default_emoji_key="default",
-    ),
-    EmojiSet(
-        name="http_status_class",  # For 2xx, 3xx etc.
-        emojis={
-            "1xx": "ℹ️",
-            "2xx": "✅",
-            "3xx": "↪️",
-            "4xx": "⚠️CLIENT",
-            "5xx": "🔥SERVER",
-            "default": "❓",
-        },
-        default_emoji_key="default",
-    ),
-    EmojiSet(
-        name="http_target_type",  # For path, query, fragment
-        emojis={"path": "🛣️", "query": "❓", "fragment": "#️⃣", "default": "🎯"},
-        default_emoji_key="default",
-    ),
-]
-HTTP_FIELD_DEFINITIONS: list[FieldToEmojiMapping] = [
-    FieldToEmojiMapping(
-        log_key="http.method",
-        description="HTTP request method (e.g., GET, POST)",
-        value_type="string",
-        emoji_set_name="http_method",
-    ),
-    FieldToEmojiMapping(
-        log_key="http.url",
-        description="Full HTTP URL of the request",
-        value_type="string",
-    ),
-    FieldToEmojiMapping(
-        log_key="http.target",
-        description="Request target (path and query string)",
-        value_type="string",
-        emoji_set_name="http_target_type",
-        default_emoji_override_key="path",
-    ),
-    FieldToEmojiMapping(
-        log_key="http.scheme",
-        description="URL scheme (e.g., http, https)",
-        value_type="string",
-    ),
-    FieldToEmojiMapping(
-        log_key="http.host", description="Hostname of the request", value_type="string"
-    ),
-    FieldToEmojiMapping(
-        log_key="http.status_code",
-        description="HTTP response status code",
-        value_type="integer",
-    ),
-    FieldToEmojiMapping(
-        log_key="http.status_class",
-        description="HTTP status code class (e.g., 2xx, 4xx)",
-        value_type="string",
-        emoji_set_name="http_status_class",
-    ),
-    FieldToEmojiMapping(
-        log_key="http.request.body.size",
-        description="Size of HTTP request body in bytes",
-        value_type="integer",
-    ),
-    FieldToEmojiMapping(
-        log_key="http.response.body.size",
-        description="Size of HTTP response body in bytes",
-        value_type="integer",
-    ),
-    FieldToEmojiMapping(
-        log_key="client.address", description="Client IP address", value_type="string"
-    ),
-    FieldToEmojiMapping(
-        log_key="server.address",
-        description="Server IP address or hostname",
-        value_type="string",
-    ),
-    FieldToEmojiMapping(
-        log_key="duration_ms",
-        description="Duration of the HTTP request/response cycle in milliseconds",
-        value_type="integer",
-    ),
-    FieldToEmojiMapping(
-        log_key="trace_id",
-        description="Distributed trace ID for the operation",
-        value_type="string",
-    ),
-    FieldToEmojiMapping(
-        log_key="span_id", description="Span ID for the operation", value_type="string"
-    ),
-    FieldToEmojiMapping(
-        log_key="error.message",
-        description="Error message if request failed",
-        value_type="string",
-    ),
-    FieldToEmojiMapping(
-        log_key="error.type",
-        description="Type of error if request failed",
-        value_type="string",
-    ),
-]
-HTTP_EMOJI_SET = EmojiSetConfig(
-    name="http",
-    description="Emoji mappings for logging HTTP client and server interactions.",
-    emoji_sets=HTTP_EMOJI_SETS,
-    field_definitions=HTTP_FIELD_DEFINITIONS,
-    priority=80,
-)
-
-# --- Task Queue Layer ---
-TASK_QUEUE_EMOJI_SETS: list[EmojiSet] = [
-    EmojiSet(
-        name="task_system",
-        emojis={
-            "celery": "🥕",
-            "rq": "🟥🇶",
-            "dramatiq": "🎭",
-            "kafka": "🌊",
-            "rabbitmq": "🐇",
-            "default": "📨",
-        },
-        default_emoji_key="default",
-    ),
-    EmojiSet(
-        name="task_status",
-        emojis={
-            "submitted": "➡️📨",
-            "received": "📥",
-            "started": "▶️",
-            "progress": "🔄",
-            "retrying": "🔁",
-            "success": "✅🏁",
-            "failure": "❌🔥",
-            "revoked": "🚫",
-            "default": "❓",
-        },
-        default_emoji_key="default",
-    ),
-]
-TASK_QUEUE_FIELD_DEFINITIONS: list[FieldToEmojiMapping] = [
-    FieldToEmojiMapping(
-        log_key="task.system",
-        description="Task queue system used (e.g., celery, rq)",
-        value_type="string",
-        emoji_set_name="task_system",
-    ),
-    FieldToEmojiMapping(
-        log_key="task.id",
-        description="Unique identifier for the task instance",
-        value_type="string",
-    ),
-    FieldToEmojiMapping(
-        log_key="task.name", description="Name of the task or job", value_type="string"
-    ),
-    FieldToEmojiMapping(
-        log_key="task.queue_name",
-        description="Name of the queue the task was processed on",
-        value_type="string",
-    ),
-    FieldToEmojiMapping(
-        log_key="task.status",
-        description="Current status of the task",
-        value_type="string",
-        emoji_set_name="task_status",
-    ),
-    FieldToEmojiMapping(
-        log_key="task.retries",
-        description="Number of retries for the task",
-        value_type="integer",
-    ),
-    FieldToEmojiMapping(
-        log_key="duration_ms",
-        description="Execution duration of the task in milliseconds",
-        value_type="integer",
-    ),
-    FieldToEmojiMapping(
-        log_key="trace_id",
-        description="Distributed trace ID associated with the task",
-        value_type="string",
-    ),
-]
-TASK_QUEUE_EMOJI_SET = EmojiSetConfig(
-    name="task_queue",
-    description="Emoji mappings for logging asynchronous task queue operations.",
-    emoji_sets=TASK_QUEUE_EMOJI_SETS,
-    field_definitions=TASK_QUEUE_FIELD_DEFINITIONS,
-    priority=70,
-)
-
-
-# Registry of all built-in emoji sets
-BUILTIN_EMOJI_SETS: dict[str, EmojiSetConfig] = {
-    LLM_EMOJI_SET.name: LLM_EMOJI_SET,
-    DATABASE_EMOJI_SET.name: DATABASE_EMOJI_SET,
-    HTTP_EMOJI_SET.name: HTTP_EMOJI_SET,
-    TASK_QUEUE_EMOJI_SET.name: TASK_QUEUE_EMOJI_SET,
-    # Add more emoji sets here (e.g., FILE_IO_EMOJI_SET, RPC_EMOJI_SET)
-}

provide/foundation/logger/emoji/types.py

@@ -1,56 +0,0 @@
-"""
-Emoji-related type definitions for the Foundation logger.
-
-This module contains data structures for emoji mapping configurations
-used in structured logging visual enhancement.
-"""
-
-from attrs import define, field
-
-
-@define(frozen=True, slots=True)
-class EmojiSet:
-    """
-    Emoji set for registry-based component management.
-
-    This replaces EmojiSet and is used by the new component registry system.
-    """
-
-    name: str = field()
-    emojis: dict[str, str] = field(factory=lambda: {})
-    default_emoji_key: str = field(default="default")
-
-
-@define(frozen=True, slots=True)
-class FieldToEmojiMapping:
-    """
-    Defines a single log field key and its optional emoji mapping.
-    """
-
-    log_key: str = field()  # e.g., "http.method", "llm.request.model"
-    description: str | None = field(default=None)
-    value_type: str | None = field(
-        default=None
-    )  # e.g., "string", "integer", "iso_timestamp"
-    emoji_set_name: str | None = field(
-        default=None
-    )  # Optional: references an EmojiSet.name
-    default_emoji_override_key: str | None = field(
-        default=None
-    )  # Optional: key within the emoji_set for this field's default
-
-
-@define(frozen=True, slots=True)
-class EmojiSetConfig:
-    """
-    Defines an emoji set configuration with emoji mappings for specific fields.
-    Provides visual enhancement for structured logging in specific domains.
-    """
-
-    name: str = field()  # e.g., "llm", "database", "http_client"
-    description: str | None = field(default=None)
-    emoji_sets: list[EmojiSet] = field(factory=lambda: [])
-    field_definitions: list[FieldToEmojiMapping] = field(factory=lambda: [])
-    priority: int = field(
-        default=0, converter=int
-    )  # Higher priority layers take precedence in case of conflicts

provide/foundation/logger/setup/emoji_resolver.py

@@ -1,64 +0,0 @@
-#
-# emoji_resolver.py
-#
-"""
-Emoji configuration resolution for Foundation Telemetry.
-Handles the merging and resolution of emoji set configurations from multiple sources.
-"""
-
-from provide.foundation.logger.config import LoggingConfig
-from provide.foundation.logger.emoji.sets import LEGACY_DAS_EMOJI_SETS
-from provide.foundation.logger.emoji.types import (
-    EmojiSet,
-    EmojiSetConfig,
-    FieldToEmojiMapping,
-)
-
-ResolvedEmojiConfig = tuple[list[FieldToEmojiMapping], dict[str, EmojiSet]]
-
-
-def resolve_active_emoji_config(
-    logging_config: LoggingConfig, builtin_emoji_registry: dict[str, EmojiSetConfig]
-) -> ResolvedEmojiConfig:
-    """
-    Resolve the active emoji configuration from multiple sources.
-
-    Args:
-        logging_config: The logging configuration
-        builtin_emoji_registry: Registry of built-in emoji sets
-
-    Returns:
-        Tuple of (field_definitions, emoji_sets_dict)
-    """
-    resolved_fields_dict: dict[str, FieldToEmojiMapping] = {}
-    resolved_emoji_sets_dict: dict[str, EmojiSet] = {
-        s.name: s for s in LEGACY_DAS_EMOJI_SETS
-    }
-
-    emoji_sets_to_process: list[EmojiSetConfig] = [
-        builtin_emoji_registry[name]
-        for name in logging_config.enabled_emoji_sets
-        if name in builtin_emoji_registry
-    ]
-    emoji_sets_to_process.extend(logging_config.custom_emoji_sets)
-    emoji_sets_to_process.sort(key=lambda emoji_set: emoji_set.priority)
-
-    ordered_log_keys: list[str] = []
-    seen_log_keys: set[str] = set()
-
-    for emoji_set_config in emoji_sets_to_process:
-        for emoji_set in emoji_set_config.emoji_sets:
-            resolved_emoji_sets_dict[emoji_set.name] = emoji_set
-        for field_def in emoji_set_config.field_definitions:
-            resolved_fields_dict[field_def.log_key] = field_def
-            if field_def.log_key not in seen_log_keys:
-                ordered_log_keys.append(field_def.log_key)
-                seen_log_keys.add(field_def.log_key)
-
-    for user_emoji_set in logging_config.user_defined_emoji_sets:
-        resolved_emoji_sets_dict[user_emoji_set.name] = user_emoji_set
-
-    final_ordered_field_definitions = [
-        resolved_fields_dict[log_key] for log_key in ordered_log_keys
-    ]
-    return final_ordered_field_definitions, resolved_emoji_sets_dict