From f4d5408e7ee0f4d3535c156bc761576df6203383 Mon Sep 17 00:00:00 2001 From: Ben Clifford Date: Fri, 15 Sep 2023 11:32:01 +0200 Subject: [PATCH] Add ignore_for_cache docstring to decorators. Fixes #2875 (#2877) --- parsl/app/app.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/parsl/app/app.py b/parsl/app/app.py index 77510a2863..07b2ef8198 100644 --- a/parsl/app/app.py +++ b/parsl/app/app.py @@ -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. @@ -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 @@ -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 @@ -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