Skip to content

Fix wrong example operation using forbidden argument 'name' #1315

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
Fizzadar merged 1 commit into from
Mar 27, 2025
Merged

Fix wrong example operation using forbidden argument 'name' #1315

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
12 changes: 6 additions & 6 deletions docs/api/operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,25 +56,25 @@ from pyinfra.api import operation
from pyinfra.facts.files import File

@operation()
def file(name, present=True):
def file(path, present=True):
'''
Manage the state of files.

+ name: name/path of the remote file
+ path: name/path of the remote file
+ present: whether the file should exist
'''

info = host.get_fact(File, path=name)
info = host.get_fact(File, path=path)

# Not a file?!
if info is False:
raise OperationError("{0} exists and is not a file".format(name))
raise OperationError("{0} exists and is not a file".format(path))

# Doesn't exist & we want it
if info is None and present:
yield "touch {0}".format(name)
yield "touch {0}".format(path)

# It exists and we don't want it
elif info and not present:
yield "rm -f {0}".format(name)
yield "rm -f {0}".format(path)
```