Index

A

abstract (pyinfra.api.facts.FactBase attribute) activate_host() (pyinfra.api.state.State method) add_callback_handler() (pyinfra.api.state.State method) add_deploy() (in module pyinfra.api.deploy) add_op() (in module pyinfra.api.operation) all_global_arguments() (in module pyinfra.api.arguments)

AllArguments (class in pyinfra.api.arguments) args (pyinfra.api.state.StateOperationMeta attribute) ArgumentMeta (class in pyinfra.api.arguments) arguments() (pyinfra.api.host.Host method) ArgumentTypeError attach_args() (in module pyinfra.api.operation)

B

BaseStateCallback (class in pyinfra.api.state)

C

cache_key (pyinfra.api.util.get_file_io property) changed (pyinfra.api.operation.OperationMeta property) check_can_rsync() (pyinfra.api.host.Host method) check_for_changes (pyinfra.api.state.State attribute) check_pyinfra_version() (in module pyinfra.api.config) check_require_packages() (in module pyinfra.api.config) command (pyinfra.api.facts.FactBase attribute) command_generator (pyinfra.api.state.StateOperationHostData attribute) Config (class in pyinfra.api.config) config (pyinfra.api.state.State attribute) ConfigDefaults (class in pyinfra.api.config) Connect (pyinfra.api.state.StateStage attribute) connect() (pyinfra.api.host.Host method) connect_all() (in module pyinfra.api.connect) CONNECT_TIMEOUT (pyinfra.api.config.ConfigDefaults attribute) connected (pyinfra.api.host.Host attribute) ConnectError connector (pyinfra.api.host.Host attribute) connector_arguments (pyinfra.api.command.PyinfraCommand attribute)

connector_cls (pyinfra.api.host.Host attribute) connector_data (pyinfra.api.host.Host attribute) ConnectorArguments (class in pyinfra.api.arguments) ConnectorDataTypeError container (class in pyinfra.context) ContextManager (class in pyinfra.context) ContextObject (class in pyinfra.context) copy() (pyinfra.api.config.Config method) current_deploy_data (pyinfra.api.host.Host attribute) current_deploy_filename (pyinfra.api.state.State attribute) current_deploy_kwargs (pyinfra.api.host.Host attribute) current_deploy_name (pyinfra.api.host.Host attribute) current_exec_filename (pyinfra.api.state.State attribute) current_op_deploy_data (pyinfra.api.host.Host attribute) current_op_file_number (pyinfra.api.state.State attribute) current_op_global_arguments (pyinfra.api.host.Host attribute) current_op_hash (pyinfra.api.host.Host attribute) current_stage (pyinfra.api.state.State attribute) cwd (pyinfra.api.state.State attribute)

D

default (pyinfra.api.arguments.ArgumentMeta attribute) default() (pyinfra.api.facts.FactBase static method) DEFAULT_TEMP_DIR (pyinfra.api.config.ConfigDefaults attribute) deploy() (in module pyinfra.api.deploy) (pyinfra.api.host.Host method) DeployError description (pyinfra.api.arguments.ArgumentMeta attribute) dict() (pyinfra.api.host.HostData method)

did_change() (pyinfra.api.operation.OperationMeta method) did_error() (pyinfra.api.operation.OperationMeta method) did_not_change() (pyinfra.api.operation.OperationMeta method) did_succeed() (pyinfra.api.operation.OperationMeta method) Disconnect (pyinfra.api.state.StateStage attribute) disconnect() (pyinfra.api.host.Host method) disconnect_all() (in module pyinfra.api.connect) DOAS (pyinfra.api.config.ConfigDefaults attribute) DOAS_USER (pyinfra.api.config.ConfigDefaults attribute)

E

empty() (pyinfra.api.inventory.Inventory static method) ensure_shared_op_meta() (in module pyinfra.api.operation) error_ops (pyinfra.api.state.StateHostResults attribute) Execute (pyinfra.api.state.StateStage attribute) execute() (pyinfra.api.command.FileDownloadCommand method) (pyinfra.api.command.FileUploadCommand method) (pyinfra.api.command.FunctionCommand method) (pyinfra.api.command.PyinfraCommand method) (pyinfra.api.command.RsyncCommand method) (pyinfra.api.command.StringCommand method)

execute_immediately() (in module pyinfra.api.operation) executed (pyinfra.api.operation.OperationMeta property) executing_op_hash (pyinfra.api.host.Host attribute) ExecutionArguments (class in pyinfra.api.arguments) extract_callable_datas() (in module pyinfra.api.host) extract_name_data() (in module pyinfra.api.inventory)

F

fact (pyinfra.api.facts.ShortFactBase attribute) FactBase (class in pyinfra.api.facts) FactError FactTypeError FactValueError fail_hosts() (pyinfra.api.state.State method)

FAIL_PERCENT (pyinfra.api.config.ConfigDefaults attribute) FileDownloadCommand (class in pyinfra.api.command) filename_or_io (pyinfra.api.util.get_file_io attribute) FileUploadCommand (class in pyinfra.api.command) format_exception() (in module pyinfra.api.util) FunctionCommand (class in pyinfra.api.command)

G

generate_env() (in module pyinfra.api.arguments) generate_operation_name() (in module pyinfra.api.operation) get() (pyinfra.api.host.HostData method) (pyinfra.context.ContextManager method) get_all_connectors() (in module pyinfra.api.connectors) get_call_location() (in module pyinfra.api.util) get_caller_frameinfo() (in module pyinfra.api.util) get_current_state() (pyinfra.api.config.Config method) get_data() (pyinfra.api.inventory.Inventory method) get_deploy_data() (pyinfra.api.host.Host method) get_execution_connector() (in module pyinfra.api.connectors) get_execution_connectors() (in module pyinfra.api.connectors) get_fact() (in module pyinfra.api.facts) (pyinfra.api.host.Host method) get_facts() (in module pyinfra.api.facts) get_file() (pyinfra.api.host.Host method) get_file_io (class in pyinfra.api.util) get_file_path() (in module pyinfra.api.util) get_file_sha1() (in module pyinfra.api.util) get_group() (pyinfra.api.inventory.Inventory method) get_group_data() (pyinfra.api.inventory.Inventory method) get_groups_data() (pyinfra.api.inventory.Inventory method)

get_host() (pyinfra.api.inventory.Inventory method) get_host_data() (pyinfra.api.inventory.Inventory method) get_host_fact() (in module pyinfra.api.facts) get_kwargs_str() (in module pyinfra.api.util) get_masked_value() (pyinfra.api.command.StringCommand method) get_meta_for_host() (pyinfra.api.state.State method) get_op_data_for_host() (pyinfra.api.state.State method) get_op_meta() (pyinfra.api.state.State method) get_op_order() (pyinfra.api.state.State method) get_operation_name_from_func() (in module pyinfra.api.operation) get_operation_order_from_stack() (in module pyinfra.api.util) get_override_data() (pyinfra.api.inventory.Inventory method) get_path_permissions_mode() (in module pyinfra.api.util) get_raw_value() (pyinfra.api.command.StringCommand method) get_results_for_host() (pyinfra.api.state.State method) get_short_facts() (in module pyinfra.api.facts) get_temp_filename() (pyinfra.api.host.Host method) get_template() (in module pyinfra.api.util) get_warning_counter() (pyinfra.api.state.State method) global_arguments (pyinfra.api.state.StateOperationHostData attribute) (pyinfra.api.state.StateOperationMeta attribute) group_data (pyinfra.api.host.Host property)

H

handler (pyinfra.api.arguments.ArgumentMeta attribute) Host (class in pyinfra.api.host) host_before_connect() (pyinfra.api.state.BaseStateCallback static method) host_connect() (pyinfra.api.state.BaseStateCallback static method)

host_connect_error() (pyinfra.api.state.BaseStateCallback static method) host_data (pyinfra.api.host.Host property) host_disconnect() (pyinfra.api.state.BaseStateCallback static method) HostData (class in pyinfra.api.host)

I

IGNORE_ERRORS (pyinfra.api.config.ConfigDefaults attribute) ignored_error_ops (pyinfra.api.state.StateHostResults attribute) in_callback_op (pyinfra.api.host.Host attribute) in_deploy (pyinfra.api.host.Host attribute) in_op (pyinfra.api.host.Host attribute) include() (in module pyinfra.local) increment_warning_counter() (pyinfra.api.state.State method) init() (pyinfra.api.host.Host method) (pyinfra.api.state.State method) init_base_classes() (in module pyinfra.context)

initialised (pyinfra.api.state.State attribute) Inventory (class in pyinfra.api.inventory) inventory (pyinfra.api.state.State attribute) InventoryError is_complete() (pyinfra.api.operation.OperationMeta method) is_executing (pyinfra.api.state.State attribute) is_host_in_limit() (pyinfra.api.state.State method) isset() (pyinfra.context.ContextManager method) iter_activated_hosts() (pyinfra.api.inventory.Inventory method) iter_active_hosts() (pyinfra.api.inventory.Inventory method)

L

len_activated_hosts() (pyinfra.api.inventory.Inventory method) len_active_hosts() (pyinfra.api.inventory.Inventory method) LocalContextObject (class in pyinfra.context) lock_current_state() (pyinfra.api.config.Config method) log() (pyinfra.api.host.Host method)

log_error_or_warning() (in module pyinfra.api.util) log_host_command_error() (in module pyinfra.api.util) log_operation_start() (in module pyinfra.api.util) log_styled() (pyinfra.api.host.Host method) loop() (pyinfra.api.host.Host method) loop_position (pyinfra.api.host.Host attribute)

M

make_formatted_string_command() (in module pyinfra.api.command) make_hash() (in module pyinfra.api.util) make_hosts_and_groups() (pyinfra.api.inventory.Inventory method) MaskString (class in pyinfra.api.command) memoize() (in module pyinfra.api.util) MetaArguments (class in pyinfra.api.arguments) mode (pyinfra.api.util.get_file_io attribute) module pyinfra.api.arguments pyinfra.api.arguments_typed pyinfra.api.command pyinfra.api.config pyinfra.api.connect pyinfra.api.connectors pyinfra.api.deploy pyinfra.api.exceptions pyinfra.api.facts pyinfra.api.host pyinfra.api.inventory pyinfra.api.operation pyinfra.api.operations pyinfra.api.state pyinfra.api.util pyinfra.context pyinfra.local pyinfra.progress pyinfra.version

module (pyinfra.context.container attribute)

N

name (pyinfra.api.arguments.AllArguments attribute) (pyinfra.api.arguments.MetaArguments attribute) (pyinfra.api.facts.FactBase attribute) (pyinfra.api.facts.ShortFactBase attribute) names (pyinfra.api.state.StateOperationMeta attribute)

nested_executing_op_hash (pyinfra.api.host.Host attribute) NoConnectorError NoGroupError NoHostError noop() (pyinfra.api.host.Host method)

O

obj (pyinfra.api.command.QuoteString attribute) op_hashes (pyinfra.api.state.StateHostMeta attribute) op_order (pyinfra.api.state.StateOperationMeta attribute) operation() (in module pyinfra.api.operation) operation_end() (pyinfra.api.state.BaseStateCallback static method) operation_host_error() (pyinfra.api.state.BaseStateCallback static method) operation_host_start() (pyinfra.api.state.BaseStateCallback static method) operation_host_success() (pyinfra.api.state.BaseStateCallback static method) operation_meta (pyinfra.api.state.StateOperationHostData attribute)

operation_start() (pyinfra.api.state.BaseStateCallback static method) OperationError OperationMeta (class in pyinfra.api.operation) OperationTypeError OperationValueError ops (pyinfra.api.state.StateHostMeta attribute) (pyinfra.api.state.StateHostResults attribute) ops_change (pyinfra.api.state.StateHostMeta attribute) ops_no_change (pyinfra.api.state.StateHostMeta attribute) override_datas (pyinfra.api.host.HostData attribute)

P

PARALLEL (pyinfra.api.config.ConfigDefaults attribute) parent_op_hash (pyinfra.api.state.StateOperationHostData attribute) partial_ops (pyinfra.api.state.StateHostResults attribute) pool (pyinfra.api.state.State attribute) pop_global_arguments() (in module pyinfra.api.arguments) Prepare (pyinfra.api.state.StateStage attribute) PRESERVE_SU_ENV (pyinfra.api.config.ConfigDefaults attribute) PRESERVE_SUDO_ENV (pyinfra.api.config.ConfigDefaults attribute) print_fact_info (pyinfra.api.state.State attribute) print_fact_input (pyinfra.api.state.State attribute) print_fact_output (pyinfra.api.state.State attribute) print_host_combined_output() (in module pyinfra.api.util) print_input (pyinfra.api.state.State attribute) print_noop_info (pyinfra.api.state.State attribute) print_output (pyinfra.api.state.State attribute) print_prefix (pyinfra.api.host.Host property) process() (pyinfra.api.facts.FactBase method) process_data() (pyinfra.api.facts.ShortFactBase method) process_pipeline() (pyinfra.api.facts.FactBase method) progress_spinner() (in module pyinfra.progress) put_file() (pyinfra.api.host.Host method) pyinfra.api.arguments module pyinfra.api.arguments_typed module pyinfra.api.command module pyinfra.api.config module pyinfra.api.connect module

pyinfra.api.connectors module pyinfra.api.deploy module pyinfra.api.exceptions module pyinfra.api.facts module pyinfra.api.host module pyinfra.api.inventory module pyinfra.api.operation module pyinfra.api.operations module pyinfra.api.state module pyinfra.api.util module pyinfra.context module pyinfra.local module pyinfra.progress module pyinfra.version module PyinfraCommand (class in pyinfra.api.command) PyinfraError PyinfraOperation (class in pyinfra.api.arguments_typed)

Q

QuoteString (class in pyinfra.api.command)

R

raise_if_bad_type() (in module pyinfra.api.util) REQUIRE_PACKAGES (pyinfra.api.config.ConfigDefaults attribute) REQUIRE_PYINFRA_VERSION (pyinfra.api.config.ConfigDefaults attribute) requires_command() (pyinfra.api.facts.FactBase method) reset() (pyinfra.context.ContextManager method)

reset_locked_state() (pyinfra.api.config.Config method) rsync() (pyinfra.api.host.Host method) RsyncCommand (class in pyinfra.api.command) run_host_op() (in module pyinfra.api.operations) run_ops() (in module pyinfra.api.operations) run_shell_command() (pyinfra.api.host.Host method)

S

set() (pyinfra.context.ContextManager method) set_base() (pyinfra.context.ContextManager method) set_complete() (pyinfra.api.operation.OperationMeta method) set_current_state() (pyinfra.api.config.Config method) set_op_data_for_host() (pyinfra.api.state.State method) set_stage() (pyinfra.api.state.State method) Setup (pyinfra.api.state.StateStage attribute) sha1_hash() (in module pyinfra.api.util) SHELL (pyinfra.api.config.ConfigDefaults attribute) shell() (in module pyinfra.local) shell_executable (pyinfra.api.facts.FactBase attribute) ShortFactBase (class in pyinfra.api.facts) should_check_for_changes() (pyinfra.api.state.State method) should_raise_failed_hosts (pyinfra.api.state.State attribute) solve_operation_consistency() (in module pyinfra.api.operation) stage_warnings (pyinfra.api.state.State attribute) State (class in pyinfra.api.state) state (pyinfra.api.host.Host attribute) (pyinfra.api.inventory.Inventory attribute)

StateHostMeta (class in pyinfra.api.state) StateHostResults (class in pyinfra.api.state) StateOperationHostData (class in pyinfra.api.state) StateOperationMeta (class in pyinfra.api.state) StateStage (class in pyinfra.api.state) stderr (pyinfra.api.operation.OperationMeta property) stderr_lines (pyinfra.api.operation.OperationMeta property) stdout (pyinfra.api.operation.OperationMeta property) stdout_lines (pyinfra.api.operation.OperationMeta property) StringCommand (class in pyinfra.api.command) style_print_prefix() (pyinfra.api.host.Host method) SU_SHELL (pyinfra.api.config.ConfigDefaults attribute) SU_USER (pyinfra.api.config.ConfigDefaults attribute) success_ops (pyinfra.api.state.StateHostResults attribute) SUDO (pyinfra.api.config.ConfigDefaults attribute) SUDO_PASSWORD (pyinfra.api.config.ConfigDefaults attribute) SUDO_USER (pyinfra.api.config.ConfigDefaults attribute)

T

T (pyinfra.api.host.Host attribute) TEMP_DIR (pyinfra.api.config.ConfigDefaults attribute)

trigger_callbacks() (pyinfra.api.state.State method) try_int() (in module pyinfra.api.util)

U

use() (pyinfra.context.ContextManager method)

USE_SU_LOGIN (pyinfra.api.config.ConfigDefaults attribute) USE_SUDO_LOGIN (pyinfra.api.config.ConfigDefaults attribute)

W

when() (pyinfra.api.host.Host method)

will_change (pyinfra.api.operation.OperationMeta property)