pyinfra-dev/pyinfra v3.0

on GitHub

Welcome to pyinfra v3! This version is the biggest overhaul of pyinfra since it was created back in 2015. Most v2 deployment code should be automatically compatible, but as always be aware. Major changes:

Runtime operation execution

pyinfra now executes operations at runtime, rather than pre-generating commands. Although the change isn't noticeable this fixes an entire class of bugs and confusion. See the limitations section in the v2 docs. All of those issues are now a thing of the past.

This represents a huge overhaul of pyinfra's internals and should be a huge improvement for users.

Care has been taken to reduce the overhead of this change which still supports the same diffs and change proposal mechanism.

CLI flow & prompts

The pyinfra CLI will now prompt (instead of ignore, or immediately exit) when problems are encountered, allowing the user to choose to continue. Additionally an approval step is added before executing changes (this can be skipped with -y or setting the PYINFRA_YES environment variable).

Extendable connectors API, typing overhaul

v3 of pyinfra includes for the first time a (mostly) typed internal API with proper support for IDE linting. There's a whole new connectors API that provides a framework for building new connectors.

Breaking changes

• Rename _use_sudo_password argument to _sudo_password
• Remove winrm connector and windows* operations/facts, moving to pyinfra-windows
• The deploy decorator must now be called, ie used as @deploy(), and is now typed
• Remove broken Ansible inventory connector

Operations & Facts

• Add docker.container, docker.image, docker.volume, docker.network & docker.prune operations (@apecnascimento)
• Add runit.service operation and RunitStatus fact (@lemmi)
• Add TmpDir fact
• Add services argument to systemd facts for filtering
• Add type hints for all the operations (@stone-w4tch3r)
• Lowercase pip packages properly (PEP-0426)
• Rename postgresql -> postgres operations & facts (old ones still work)
• Improve IP/MAC parsing in NetworkDevices fact (@sudoBash418)
• Enable getting Home fact for other users (@matthijskooijman)
• Use users correct home directory in server.user_authorized_keys operation (@matthijskooijman)
• Fix destination/not_destination arguments in iptables.rule operation
• Fix remote dirs when executing from Windows in files.sync operation (@Renerick)
• Fix quoting of systemd unit names (@martenlienen)

Other Changes

• Add new _if global argument to control operation execution at runtime
• Add --debug-all flag to set debug logging for all packages
• Retry SSH connections on failure (configurable, see SSH connector) (@fwiesel)
• Documentation typo fixes (@szepeviktor, @sudoBash418)
• Fix handling of binary files in Docker connector (@matthijskooijman)
• Add will_change attribute and did_change context manager to OperationMeta
• Replace use of pkg_resources with importlib.metadata (@diazona)
• Fix identifying Python inventory files as modules (@martenlienen)
• Fix typed arguments order (@cdleonard)
• Check that fact commands don't take global arguments (@martenlienen)