libdebug.utils.libcontext

LibContext

A class that holds the global context of the library.

Source code in libdebug/utils/libcontext.py

class LibContext:
    """A class that holds the global context of the library."""

    _instance = None
    _pipe_logger_levels: list[str]
    _debugger_logger_levels: list[str]
    _general_logger_levels: list[str]
    _debuginfod_server: str

    def __new__(cls: type):
        """Create a new instance of the class if it does not exist yet.

        Returns:
            LibContext: the instance of the class.
        """
        if cls._instance is None:
            cls._instance = super().__new__(cls)
            cls._instance._initialized = False
        return cls._instance

    def __init__(self: LibContext) -> None:
        """Initializes the context."""
        if self._initialized:
            return

        self._pipe_logger_levels = ["DEBUG", "SILENT"]
        self._debugger_logger_levels = ["DEBUG", "SILENT"]
        self._general_logger_levels = ["DEBUG", "INFO", "WARNING", "SILENT"]
        self._sym_lvl = 5

        self._debugger_logger = "SILENT"
        self._pipe_logger = "SILENT"
        self._general_logger = "INFO"

        self._debuginfod_server = "https://debuginfod.elfutils.org/"

        # Adjust log levels based on command-line arguments
        if len(sys.argv) > 1:
            if "debugger" in sys.argv:
                liblog.debugger_logger.setLevel("DEBUG")
                self._debugger_logger = "DEBUG"
            elif "pipe" in sys.argv:
                liblog.pipe_logger.setLevel("DEBUG")
                self._pipe_logger = "DEBUG"
            elif "dbg" in sys.argv:
                self._set_debug_level_for_all()
                self._debugger_logger = "DEBUG"
                self._pipe_logger = "DEBUG"
                self._general_logger = "DEBUG"
        self._initialized = True

        self._terminal = []

    def _set_debug_level_for_all(self: LibContext) -> None:
        """Set the debug level for all the loggers to DEBUG."""
        for logger in [
            liblog.general_logger,
            liblog.debugger_logger,
            liblog.pipe_logger,
        ]:
            logger.setLevel("DEBUG")

    @property
    def sym_lvl(self: LibContext) -> int:
        """Property getter for sym_lvl.

        Returns:
            _sym_lvl (int): the current symbol level.
        """
        return self._sym_lvl

    @sym_lvl.setter
    def sym_lvl(self: LibContext, value: int) -> None:
        """Property setter for sym_lvl, ensuring it's between 0 and 5."""
        if 0 <= value <= 5:
            self._sym_lvl = value
        else:
            raise ValueError("sym_lvl must be between 0 and 5")

    @property
    def debugger_logger(self: LibContext) -> str:
        """Property getter for debugger_logger.

        Returns:
            _debugger_logger (str): the current debugger logger level.
        """
        return self._debugger_logger

    @debugger_logger.setter
    def debugger_logger(self: LibContext, value: str) -> None:
        """Property setter for debugger_logger, ensuring it's a supported logging level."""
        if value in self._debugger_logger_levels:
            self._debugger_logger = value
            liblog.debugger_logger.setLevel(value)
        else:
            raise ValueError(
                f"debugger_logger must be a supported logging level. The supported levels are: {self._debugger_logger_levels}",
            )

    @property
    def pipe_logger(self: LibContext) -> str:
        """Property getter for pipe_logger.

        Returns:
            _pipe_logger (str): the current pipe logger level.
        """
        return self._pipe_logger

    @pipe_logger.setter
    def pipe_logger(self: LibContext, value: str) -> None:
        """Property setter for pipe_logger, ensuring it's a supported logging level."""
        if value in self._pipe_logger_levels:
            self._pipe_logger = value
            liblog.pipe_logger.setLevel(value)
        else:
            raise ValueError(
                f"pipe_logger must be a supported logging level. The supported levels are: {self._pipe_logger_levels}",
            )

    @property
    def general_logger(self: LibContext) -> str:
        """Property getter for general_logger.

        Returns:
            _general_logger (str): the current general logger level.
        """
        return self._general_logger

    @general_logger.setter
    def general_logger(self: LibContext, value: str) -> None:
        """Property setter for general_logger, ensuring it's a supported logging level."""
        if value in self._general_logger_levels:
            self._general_logger = value
            liblog.general_logger.setLevel(value)
        else:
            raise ValueError(
                f"general_logger must be a supported logging level. The supported levels are: {self._general_logger_levels}",
            )

    @property
    def platform(self: LibContext) -> str:
        """Return the current platform."""
        return map_arch(platform.machine())

    @property
    def terminal(self: LibContext) -> list[str]:
        """Property getter for terminal.

        Returns:
            _terminal (str): the current terminal.
        """
        return self._terminal

    @terminal.setter
    def terminal(self: LibContext, value: list[str] | str) -> None:
        """Property setter for terminal, ensuring it's a valid terminal."""
        if isinstance(value, str):
            value = [value]

        self._terminal = value

    @property
    def debuginfod_server(self: LibContext) -> str:
        """Property getter for debuginfod_server.

        Returns:
            _debuginfod_server (str): the current debuginfod server.
        """
        return self._debuginfod_server

    @debuginfod_server.setter
    def debuginfod_server(self: LibContext, value: str) -> None:
        """Property setter for debuginfod_server, ensuring it's a valid URL."""
        if type(value) is not str or (not value.startswith("http://") and not value.startswith("https://")):
            raise ValueError(
                "debuginfod_server must be a valid string URL in the format 'http://<server>' or 'https://<server>'",
            )
        self._debuginfod_server = value

    def update(self: LibContext, **kwargs: ...) -> None:
        """Update the context with the given values."""
        for key, value in kwargs.items():
            if hasattr(self, key):
                setattr(self, key, value)

    @contextmanager
    def tmp(self: LibContext, **kwargs: ...) -> ...:
        """Context manager that temporarily changes the library context. Use "with" statement."""
        # Make a deep copy of the current state
        old_context = deepcopy(self.__dict__)
        self.update(**kwargs)
        try:
            yield
        finally:
            # Restore the original state
            self.__dict__.update(old_context)
            liblog.debugger_logger.setLevel(self.debugger_logger)
            liblog.pipe_logger.setLevel(self.pipe_logger)

debugger_logger property writable

Property getter for debugger_logger.

Returns:

Name	Type	Description
_debugger_logger	str	the current debugger logger level.

debuginfod_server property writable

Property getter for debuginfod_server.

Returns:

Name	Type	Description
_debuginfod_server	str	the current debuginfod server.

general_logger property writable

Property getter for general_logger.

Returns:

Name	Type	Description
_general_logger	str	the current general logger level.

pipe_logger property writable

Property getter for pipe_logger.

Returns:

Name	Type	Description
_pipe_logger	str	the current pipe logger level.

platform property

Return the current platform.

sym_lvl property writable

Property getter for sym_lvl.

Returns:

Name	Type	Description
_sym_lvl	int	the current symbol level.

terminal property writable

Property getter for terminal.

Returns:

Name	Type	Description
_terminal	str	the current terminal.

__init__()

Initializes the context.

Source code in libdebug/utils/libcontext.py

def __init__(self: LibContext) -> None:
    """Initializes the context."""
    if self._initialized:
        return

    self._pipe_logger_levels = ["DEBUG", "SILENT"]
    self._debugger_logger_levels = ["DEBUG", "SILENT"]
    self._general_logger_levels = ["DEBUG", "INFO", "WARNING", "SILENT"]
    self._sym_lvl = 5

    self._debugger_logger = "SILENT"
    self._pipe_logger = "SILENT"
    self._general_logger = "INFO"

    self._debuginfod_server = "https://debuginfod.elfutils.org/"

    # Adjust log levels based on command-line arguments
    if len(sys.argv) > 1:
        if "debugger" in sys.argv:
            liblog.debugger_logger.setLevel("DEBUG")
            self._debugger_logger = "DEBUG"
        elif "pipe" in sys.argv:
            liblog.pipe_logger.setLevel("DEBUG")
            self._pipe_logger = "DEBUG"
        elif "dbg" in sys.argv:
            self._set_debug_level_for_all()
            self._debugger_logger = "DEBUG"
            self._pipe_logger = "DEBUG"
            self._general_logger = "DEBUG"
    self._initialized = True

    self._terminal = []

__new__()

Create a new instance of the class if it does not exist yet.

Returns:

Name	Type	Description
LibContext		the instance of the class.

Source code in libdebug/utils/libcontext.py

def __new__(cls: type):
    """Create a new instance of the class if it does not exist yet.

    Returns:
        LibContext: the instance of the class.
    """
    if cls._instance is None:
        cls._instance = super().__new__(cls)
        cls._instance._initialized = False
    return cls._instance

_set_debug_level_for_all()

Set the debug level for all the loggers to DEBUG.

Source code in libdebug/utils/libcontext.py

def _set_debug_level_for_all(self: LibContext) -> None:
    """Set the debug level for all the loggers to DEBUG."""
    for logger in [
        liblog.general_logger,
        liblog.debugger_logger,
        liblog.pipe_logger,
    ]:
        logger.setLevel("DEBUG")

tmp(**kwargs)

Context manager that temporarily changes the library context. Use "with" statement.

Source code in libdebug/utils/libcontext.py

@contextmanager
def tmp(self: LibContext, **kwargs: ...) -> ...:
    """Context manager that temporarily changes the library context. Use "with" statement."""
    # Make a deep copy of the current state
    old_context = deepcopy(self.__dict__)
    self.update(**kwargs)
    try:
        yield
    finally:
        # Restore the original state
        self.__dict__.update(old_context)
        liblog.debugger_logger.setLevel(self.debugger_logger)
        liblog.pipe_logger.setLevel(self.pipe_logger)

update(**kwargs)

Update the context with the given values.

Source code in libdebug/utils/libcontext.py

def update(self: LibContext, **kwargs: ...) -> None:
    """Update the context with the given values."""
    for key, value in kwargs.items():
        if hasattr(self, key):
            setattr(self, key, value)