certbot.compat.misc module
This compat module handles various platform specific calls that do not fall into one particular category.
- certbot.compat.misc.raise_for_non_administrative_windows_rights() None[source]
On Windows, raise if current shell does not have the administrative rights. Do nothing on Linux.
- Raises:
.errors.Error – If the current shell does not have administrative rights on Windows.
- certbot.compat.misc.prepare_virtual_console() None[source]
On Windows, ensure that Console Virtual Terminal Sequences are enabled.
- certbot.compat.misc.readline_with_timeout(timeout: float, prompt: str | None) str[source]
Read user input to return the first line entered, or raise after specified timeout.
- certbot.compat.misc.get_default_folder(folder_type: str) str[source]
Return the relevant default folder for the current OS
- certbot.compat.misc.underscores_for_unsupported_characters_in_path(path: str) str[source]
Replace unsupported characters in path for current OS by underscores. :param str path: the path to normalize :return: the normalized path :rtype: str
- certbot.compat.misc.execute_command_status(cmd_name: str, shell_cmd: str, env: dict | None = None) Tuple[int, str, str][source]
- Run a command:
on Linux command will be run by the standard shell selected with subprocess.run(shell=True)
on Windows command will be run in a Powershell shell
This function returns the exit code, and does not log the result and output of the command.