Skip to content

Module gnupg.handlers.status_handler

View Source
from __future__ import annotations

from typing import TYPE_CHECKING, NoReturn

if TYPE_CHECKING:

    from gnupg.gnupg import GPG

class StatusHandler:

    """

    The base class for handling status messages from `gpg`.

    """

    def __init__(self, gpg: GPG) -> None:

        """

        Initialize an instance.

        Args:

            gpg (GPG): The :class:`GPG` instance in use.

        """

        self.gpg = gpg

        self.data: str | None = None

    def handle_status(self, key: str, value: str) -> NoReturn:

        """

        Handle status messages from the `gpg` child process. These are lines of the format

            [GNUPG:] <key> <value>

        Args:

            key (str): Identifies what the status message is.

            value (str): Identifies additional data, which differs depending on the key.

        """

        raise NotImplementedError

Variables

TYPE_CHECKING

Classes

StatusHandler

class StatusHandler(
    gpg: 'GPG'
)

The base class for handling status messages from gpg.

View Source
class StatusHandler:

    """

    The base class for handling status messages from `gpg`.

    """

    def __init__(self, gpg: GPG) -> None:

        """

        Initialize an instance.

        Args:

            gpg (GPG): The :class:`GPG` instance in use.

        """

        self.gpg = gpg

        self.data: str | None = None

    def handle_status(self, key: str, value: str) -> NoReturn:

        """

        Handle status messages from the `gpg` child process. These are lines of the format

            [GNUPG:] <key> <value>

        Args:

            key (str): Identifies what the status message is.

            value (str): Identifies additional data, which differs depending on the key.

        """

        raise NotImplementedError

Descendants

  • gnupg.handlers.add_subkey_handler.AddSubkeyHandler
  • gnupg.handlers.auto_locate_key_handler.AutoLocateKeyHandler
  • gnupg.handlers.verify_handler.VerifyHandler
  • gnupg.handlers.delete_result_handler.DeleteResultHandler
  • gnupg.handlers.gen_key_handler.GenKeyHandler
  • gnupg.handlers.import_result_handler.ImportResultHandler
  • gnupg.handlers.search_keys_handler.SearchKeysHandler
  • gnupg.handlers.send_result_handler.SendResultHandler
  • gnupg.handlers.sign_handler.SignHandler

Methods

handle_status

def handle_status(
    self,
    key: 'str',
    value: 'str'
) -> 'NoReturn'

Handle status messages from the gpg child process. These are lines of the format

[GNUPG:]

Parameters:

Name Type Description Default
key str Identifies what the status message is. None
value str Identifies additional data, which differs depending on the key. None
View Source
    def handle_status(self, key: str, value: str) -> NoReturn:

        """

        Handle status messages from the `gpg` child process. These are lines of the format

            [GNUPG:] <key> <value>

        Args:

            key (str): Identifies what the status message is.

            value (str): Identifies additional data, which differs depending on the key.

        """

        raise NotImplementedError