Class CddlModule

py/generate_bidi.py:606–1018

Represents a CDDL module (e.g., script, network, browsing_context).

@dataclass
class CddlModule:
    """Represents a CDDL module (e.g., script, network, browsing_context)."""

    name: str
    commands: list[CddlCommand] = field(default_factory=list)
    types: list[CddlTypeDefinition] = field(default_factory=list)
    enums: list[CddlEnum] = field(default_factory=list)
    events: list[CddlEvent] = field(default_factory=list)

    @staticmethod
    def _convert_method_to_event_name(method_suffix: str) -> str:
        """Convert BiDi method suffix to friendly event name.

        Examples:
            "contextCreated" -> "context_created"
            "navigationStarted" -> "navigation_started"
            "userPromptOpened" -> "user_prompt_opened"
        """
        # Convert camelCase to snake_case
        s1 = re.sub("(.)([A-Z][a-z]+)", r"\1_\2", method_suffix)
        return re.sub("([a-z0-9])([A-Z])", r"\1_\2", s1).lower()

    def generate_code(self, enhancements: dict[str, Any] | None = None) -> str:
        """Generate Python code for this module.

        Args:
            enhancements: Dictionary with module-level enhancements
        """
        enhancements = enhancements or {}
        module_docstring = enhancements.get("module_docstring", "")
        code = _MODULE_HEADER_COMMENTS.format(self.name)
        if module_docstring:
            code += _emit_docstring(module_docstring, 0) + "\n"
        code += _MODULE_HEADER_IMPORTS

        # Collect needed imports to avoid duplicates
        needs_command_builder = bool(self.commands)
        needs_dataclass = self.commands or self.types or self.events
        needs_callable = self.events

        stdlib_imports = []
        local_imports = []

        # Add imports (field import will be added conditionally after code generation)
        if needs_callable:
            stdlib_imports.append("from collections.abc import Callable")
        if needs_dataclass:
            stdlib_imports.append("from dataclasses import dataclass")
        stdlib_imports.append("from typing import Any")

        if needs_command_builder:
            local_imports.append("from selenium.webdriver.common.bidi.common import command_builder")
        if self.events:
            local_imports.append(
                "from selenium.webdriver.common.bidi._event_manager import EventConfig, _EventWrapper, _EventManager"
            )

        code += "\n".join(stdlib_imports) + "\n"