Skip to content

docs: Specify how the recursive argument to directory() works #1448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 16, 2025
Merged

docs: Specify how the recursive argument to directory() works #1448

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/pyinfra/operations/files.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1569,6 +1569,12 @@ def directory(
+ force_backup: set to ``False`` to remove any existing non-file when ``force=True``
+ force_backup_dir: directory to move any backup to when ``force=True``

``recursive``:
Mode is only applied recursively if the base directory mode does not match
the specified value. User and group are both applied recursively if the
base directory does not match either one; otherwise they are unchanged for
the whole tree.

**Examples:**

.. code:: python
Expand Down