Skip to content
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

Add ignore_for_cache docstring to decorators. Fixes #2875 #2877

Merged
merged 2 commits into from
Sep 15, 2023
Merged

Add ignore_for_cache docstring to decorators. Fixes #2875 #2877

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aae9a9d
Add ignore_for_cache docstring to decorators. Fixes #2875
benclifford Sep 14, 2023
025cdc7
Merge branch 'master' into issue2875-docstring
benclifford Sep 15, 2023
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
7 changes: 7 additions & 0 deletions parsl/app/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ def __init__(self, func, data_flow_kernel=None, executors='all', cache=False, ig
after calling :meth:`parsl.dataflow.dflow.DataFlowKernelLoader.load`.
- executors (str|list) : Labels of the executors that this app can execute over. Default is 'all'.
- cache (Bool) : Enable caching of this app ?
- ignore_for_cache (list|None): Names of arguments which will be ignored by the caching mechanism.

Returns:
- App object.
Expand Down Expand Up @@ -90,6 +91,8 @@ def python_app(function=None,
Labels of the executors that this app can execute over. Default is 'all'.
cache : bool
Enable caching of the app call. Default is False.
ignore_for_cache : (list|None)
Names of arguments which will be ignored by the caching mechanism.
"""
from parsl.app.python import PythonApp

Expand Down Expand Up @@ -126,6 +129,8 @@ def join_app(function=None,
be omitted only after calling :meth:`parsl.dataflow.dflow.DataFlowKernelLoader.load`. Default is None.
cache : bool
Enable caching of the app call. Default is False.
ignore_for_cache : (list|None)
Names of arguments which will be ignored by the caching mechanism.
"""
from parsl.app.python import PythonApp

Expand Down Expand Up @@ -167,6 +172,8 @@ def bash_app(function=None,
Labels of the executors that this app can execute over. Default is 'all'.
cache : bool
Enable caching of the app call. Default is False.
ignore_for_cache : (list|None)
Names of arguments which will be ignored by the caching mechanism.
"""
from parsl.app.bash import BashApp

Expand Down