pyinfra.api.config module

class pyinfra.api.config.Config(**kwargs)

Bases: ConfigDefaults

The default/base configuration options for a pyinfra deploy.

copy() Config
get_current_state()
lock_current_state()
reset_locked_state()
set_current_state(config_state)
class pyinfra.api.config.ConfigDefaults

Bases: object

CONNECT_TIMEOUT: int = 10
DEFAULT_TEMP_DIR: str = '/tmp'
DOAS: bool = False
DOAS_USER: str | None = None
FAIL_PERCENT: int | None = None
IGNORE_ERRORS: bool = False
PARALLEL: int = 0
PRESERVE_SUDO_ENV: bool = False
PRESERVE_SU_ENV: bool = False
REQUIRE_PACKAGES: str | None = None
REQUIRE_PYINFRA_VERSION: str | None = None
SHELL: str = 'sh'
SUDO: bool = False
SUDO_PASSWORD: str | None = None
SUDO_USER: str | None = None
SU_SHELL: bool = False
SU_USER: str | None = None
TEMP_DIR: str | None = None
USE_SUDO_LOGIN: bool = False
USE_SU_LOGIN: bool = False
pyinfra.api.config.check_pyinfra_version(version: str)
pyinfra.api.config.check_require_packages(requirements_config)