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) add_will_add_user() (pyinfra.api.state.State method) append_groups_to_host() (in module pyinfra.api.connectors.ansible)

B

BaseStateCallback (class in pyinfra.api.state)

C

cache_key() (pyinfra.api.util.get_file_io property) check_can_rsync() (in module pyinfra.api.connectors.local) (in module pyinfra.api.connectors.ssh) (pyinfra.api.host.Host method) close (pyinfra.api.util.get_file_io attribute) Config (class in pyinfra.api.config) config (pyinfra.api.state.State attribute) connect() (in module pyinfra.api.connectors.chroot) (in module pyinfra.api.connectors.docker) (in module pyinfra.api.connectors.dockerssh) (in module pyinfra.api.connectors.local) (in module pyinfra.api.connectors.ssh) (in module pyinfra.api.connectors.winrm) (pyinfra.api.connectors.sshuserclient.client.SSHClient method) (pyinfra.api.host.Host method)

connect_all() (in module pyinfra.api.connect) CONNECT_TIMEOUT (pyinfra.api.config.Config attribute) connected() (pyinfra.api.host.Host property) ConnectError connection (pyinfra.api.host.Host attribute) create_fact() (pyinfra.api.host.Host method) create_host_fact() (in module pyinfra.api.facts) current_deploy_filename (pyinfra.api.state.State attribute) current_exec_filename (pyinfra.api.state.State attribute) current_op_global_kwargs (pyinfra.api.state.State attribute) current_op_hash (pyinfra.api.state.State attribute)

D

default() (pyinfra.api.facts.FactBase static method) delete_fact() (pyinfra.api.host.Host method) delete_host_fact() (in module pyinfra.api.facts) deploy() (in module pyinfra.api.deploy) (pyinfra.api.state.State method) deploy_data (pyinfra.api.state.State attribute) deploy_dir (pyinfra.api.state.State attribute) deploy_kwargs (pyinfra.api.state.State attribute) deploy_name (pyinfra.api.state.State attribute)

deploy_op_order (pyinfra.api.state.State attribute) DeployError deploying (pyinfra.api.state.State attribute) derive_shorthand() (pyinfra.api.connectors.sshuserclient.client.SSHClient method) dict() (pyinfra.api.util.FallbackDict method) disconnect() (in module pyinfra.api.connectors.docker) (in module pyinfra.api.connectors.dockerssh) (pyinfra.api.host.Host method) disconnect_all() (in module pyinfra.api.connect)

E

escape_unix_path() (in module pyinfra.api.connectors.util) 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)

extract_callable_datas() (in module pyinfra.api.util) extract_name_data() (in module pyinfra.api.inventory)

F

fact (pyinfra.api.facts.ShortFactBase attribute) (pyinfra.api.host.Host attribute) FactBase (class in pyinfra.api.facts) FactMeta (class in pyinfra.api.facts) fail_hosts() (pyinfra.api.state.State method)

FAIL_PERCENT (pyinfra.api.config.Config attribute) FallbackDict (class in pyinfra.api.util) FileDownloadCommand (class in pyinfra.api.command) FileUploadCommand (class in pyinfra.api.command) format_exception() (in module pyinfra.api.util) FunctionCommand (class in pyinfra.api.command)

G

gateway() (pyinfra.api.connectors.sshuserclient.client.SSHClient method) generate_env() (in module pyinfra.api.operation_kwargs) get_arg_value() (in module pyinfra.api.util) get_call_location() (in module pyinfra.api.util) get_caller_frameinfo() (in module pyinfra.api.util) get_data() (pyinfra.api.inventory.Inventory method) get_deploy_data() (pyinfra.api.inventory.Inventory method) get_execution_kwarg_keys() (in module pyinfra.api.operation_kwargs) get_executor_kwarg_keys() (in module pyinfra.api.operation_kwargs) get_fact() (pyinfra.api.host.Host method) get_fact_class() (in module pyinfra.api.facts) get_fact_names() (in module pyinfra.api.facts) get_facts() (in module pyinfra.api.facts) get_file() (in module pyinfra.api.connectors.chroot) (in module pyinfra.api.connectors.docker) (in module pyinfra.api.connectors.dockerssh) (in module pyinfra.api.connectors.local) (in module pyinfra.api.connectors.ssh) (in module pyinfra.api.connectors.winrm) (pyinfra.api.host.Host method) get_file_io (class in 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_mech_config() (in module pyinfra.api.connectors.mech) get_mech_options() (in module pyinfra.api.connectors.mech) get_op_data() (pyinfra.api.state.State method) get_op_meta() (pyinfra.api.state.State method) get_op_order() (pyinfra.api.state.State method) get_operation_names() (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_short_facts() (in module pyinfra.api.facts) get_ssh_config() (in module pyinfra.api.connectors.sshuserclient.client) get_sudo_password() (in module pyinfra.api.connectors.util) get_temp_filename() (pyinfra.api.state.State method) get_template() (in module pyinfra.api.util) get_vagrant_config() (in module pyinfra.api.connectors.vagrant) get_vagrant_options() (in module pyinfra.api.connectors.vagrant) group_data() (pyinfra.api.host.Host property)

H

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) HostFacts (class in pyinfra.api.host)

I

IGNORE_ERRORS (pyinfra.api.config.Config attribute) in_deploy (pyinfra.api.state.State attribute) in_op (pyinfra.api.state.State attribute) include() (in module pyinfra.local) init() (pyinfra.api.state.State method) init_base_classes() (in module pyinfra.pseudo_modules) initialised (pyinfra.api.state.State attribute) Inventory (class in pyinfra.api.inventory)

inventory (pyinfra.api.state.State attribute) InventoryError is_fact() (in module pyinfra.api.facts) is_host_in_limit() (pyinfra.api.state.State method) isset() (pyinfra.pseudo_modules.PseudoModule method) iter_activated_hosts() (pyinfra.api.inventory.Inventory method) iter_active_hosts() (pyinfra.api.inventory.Inventory method) iter_all_hosts() (pyinfra.api.inventory.Inventory method)

L

len_activated_hosts() (pyinfra.api.inventory.Inventory method) len_active_hosts() (pyinfra.api.inventory.Inventory method) len_all_hosts() (pyinfra.api.inventory.Inventory method) log_error_or_warning() (in module pyinfra.api.util)

log_host_command_error() (in module pyinfra.api.util) loop_counter (pyinfra.api.state.State attribute) loop_filename (pyinfra.api.state.State attribute) loop_line (pyinfra.api.state.State attribute)

M

make_hash() (in module pyinfra.api.util) make_hosts_and_groups() (pyinfra.api.inventory.Inventory method) make_names_data() (in module pyinfra.api.connectors.ansible) (in module pyinfra.api.connectors.chroot) (in module pyinfra.api.connectors.docker) (in module pyinfra.api.connectors.dockerssh) (in module pyinfra.api.connectors.local) (in module pyinfra.api.connectors.mech) (in module pyinfra.api.connectors.ssh) (in module pyinfra.api.connectors.vagrant) (in module pyinfra.api.connectors.winrm)

make_unix_command() (in module pyinfra.api.connectors.util) make_win_command() (in module pyinfra.api.connectors.util) MaskString (class in pyinfra.api.command) memoize() (in module pyinfra.api.util) MIN_PYINFRA_VERSION (pyinfra.api.config.Config attribute)

N

name (pyinfra.api.facts.ShortFactBase attribute) NoConnectorError

NoGroupError NoHostError noop() (pyinfra.api.host.Host method)

O

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_start() (pyinfra.api.state.BaseStateCallback static method) OperationError OperationMeta (class in pyinfra.api.operation) OperationTypeError OperationValueError override_datas (pyinfra.api.util.FallbackDict attribute)

P

PARALLEL (pyinfra.api.config.Config attribute) parse() (pyinfra.api.connectors.sshuserclient.config.SSHConfig method) parse_config() (pyinfra.api.connectors.sshuserclient.client.SSHClient method) parse_inventory() (in module pyinfra.api.connectors.ansible) parse_inventory_ini() (in module pyinfra.api.connectors.ansible) parse_inventory_tree() (in module pyinfra.api.connectors.ansible) pool (pyinfra.api.state.State attribute) pop_global_op_kwargs() (in module pyinfra.api.operation_kwargs) preserve_loop_order() (pyinfra.api.state.State method) PRESERVE_SU_ENV (pyinfra.api.config.Config attribute) PRESERVE_SUDO_ENV (pyinfra.api.config.Config 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 static method) process_pipeline() (pyinfra.api.facts.FactBase method) progress_spinner() (in module pyinfra.progress) PseudoModule (class in pyinfra.pseudo_modules) put_file() (in module pyinfra.api.connectors.chroot) (in module pyinfra.api.connectors.docker) (in module pyinfra.api.connectors.dockerssh) (in module pyinfra.api.connectors.local) (in module pyinfra.api.connectors.ssh) (in module pyinfra.api.connectors.winrm) (pyinfra.api.host.Host method) pyinfra.api.command (module) pyinfra.api.config (module) pyinfra.api.connect (module)

pyinfra.api.connectors (module) pyinfra.api.connectors.ansible (module) pyinfra.api.connectors.chroot (module) pyinfra.api.connectors.docker (module) pyinfra.api.connectors.dockerssh (module) pyinfra.api.connectors.local (module) pyinfra.api.connectors.mech (module) pyinfra.api.connectors.pyinfrawinrmsession (module) pyinfra.api.connectors.ssh (module) pyinfra.api.connectors.sshuserclient (module) pyinfra.api.connectors.sshuserclient.client (module) pyinfra.api.connectors.sshuserclient.config (module) pyinfra.api.connectors.util (module) pyinfra.api.connectors.vagrant (module) pyinfra.api.connectors.winrm (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.operation_kwargs (module) pyinfra.api.operations (module) pyinfra.api.state (module) pyinfra.api.util (module) pyinfra.local (module) pyinfra.modules (module) pyinfra.progress (module) pyinfra.pseudo_modules (module) pyinfra.version (module) PyinfraCommand (class in pyinfra.api.command) PyinfraError PyinfraWinrmSession (class in pyinfra.api.connectors.pyinfrawinrmsession)

Q

QuoteString (class in pyinfra.api.command)

R

read_buffer() (in module pyinfra.api.connectors.util) read_buffers_into_queue() (in module pyinfra.api.connectors.util) remote_remove() (in module pyinfra.api.connectors.dockerssh) remove_any_sudo_askpass_file() (in module pyinfra.api.connectors.util) REQUIRE_PACKAGES (pyinfra.api.config.Config attribute) REQUIRE_PYINFRA_VERSION (pyinfra.api.config.Config attribute) requires_command (pyinfra.api.facts.FactBase attribute) reset() (pyinfra.pseudo_modules.PseudoModule method) rsync() (in module pyinfra.api.connectors.local) (in module pyinfra.api.connectors.ssh) (pyinfra.api.host.Host method)

RsyncCommand (class in pyinfra.api.command) run_cmd() (pyinfra.api.connectors.pyinfrawinrmsession.PyinfraWinrmSession method) run_local_process() (in module pyinfra.api.connectors.util) run_ops() (in module pyinfra.api.operations) run_ps() (pyinfra.api.connectors.pyinfrawinrmsession.PyinfraWinrmSession method) run_shell_command() (in module pyinfra.api.connectors.chroot) (in module pyinfra.api.connectors.docker) (in module pyinfra.api.connectors.dockerssh) (in module pyinfra.api.connectors.local) (in module pyinfra.api.connectors.ssh) (in module pyinfra.api.connectors.winrm) (pyinfra.api.host.Host method)

S

set() (pyinfra.pseudo_modules.PseudoModule method) set_base() (pyinfra.pseudo_modules.PseudoModule method) sha1_hash() (in module pyinfra.api.util) SHELL (pyinfra.api.config.Config attribute) shell() (in module pyinfra.local) shell_executable (pyinfra.api.facts.FactBase attribute) ShortFactBase (class in pyinfra.api.facts) show_get_arg_value_warning() (in module pyinfra.api.util) show_pre_or_post_condition_warning() (in module pyinfra.api.operations) show_set_name_warning() (in module pyinfra.api.operation) show_state_host_arguments_warning() (in module pyinfra.api.deploy) (in module pyinfra.api.operation) show_warning() (in module pyinfra.api.connectors.ansible) (in module pyinfra.api.connectors.chroot) (in module pyinfra.api.connectors.dockerssh) (in module pyinfra.api.connectors.winrm)

split_combined_output() (in module pyinfra.api.connectors.util) SSHClient (class in pyinfra.api.connectors.sshuserclient.client) SSHConfig (class in pyinfra.api.connectors.sshuserclient.config) State (class in pyinfra.api.state) state (pyinfra.api.config.Config attribute) (pyinfra.api.host.Host attribute) (pyinfra.api.inventory.Inventory attribute) StringCommand (class in pyinfra.api.command) style_print_prefix() (pyinfra.api.host.Host method) SU_SHELL (pyinfra.api.config.Config attribute) SU_USER (pyinfra.api.config.Config attribute) SUDO (pyinfra.api.config.Config attribute) SUDO_USER (pyinfra.api.config.Config attribute)

T

TEMP_DIR (pyinfra.api.config.Config attribute) to_dict() (pyinfra.api.state.State method)

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

U

underscore() (in module pyinfra.api.util) unroll_generators() (in module pyinfra.api.util)

USE_SU_LOGIN (pyinfra.api.config.Config attribute) USE_SUDO_LOGIN (pyinfra.api.config.Config attribute) USE_SUDO_PASSWORD (pyinfra.api.config.Config attribute)

W

will_add_user() (pyinfra.api.state.State method)

write_stdin() (in module pyinfra.api.connectors.util)