python.dags.Argument Class Reference

Public Member Functions
	__post_init__ (self)
	arg_basename (self)
	vars (self, basename=False)
	files (self, basename=False)
	remaps (self)

Public Attributes
	condor_name = self.name.replace("-", "_")
	arg_basename

Static Public Attributes
Union	argument [int, float, str, List]
Optional	track = True
Optional	remap = True
Optional	suppress = False
Optional	suppress_with_remap = False

Detailed Description

Defines a command-line argument (positional).

    This provides some extra functionality over defining command line
    argument explicitly, in addition to some extra parameters which
    sets how condor interprets how to handle them within the DAG
    and within submit descriptions.

    Parameters
    ----------
    name
        The option name. Since this is a positional argument, it is not
        used explicitly in the command, but is needed to define
        variable names within jobs.
    argument
        The positional argument value(s) used in a command.
    track
        Whether to track files defined here and used externally within
        jobs to determine parent-child relationships when nodes specify
        this option as an input or output. On by default.
    remap
        Whether to allow remapping of output files being transferred.
        If set, output files will be moved to their target directories
        after files are transferred back. This is done to avoid issues
        where the target directories are available on the submit node
        but not on the exectute node. On by default.
    suppress
        Whether to hide this option. Used externally within jobs to
        determine whether to define job arguments. This is typically used
        when you want to track file I/O used by a job but isn't directly
        specified in their commands. Off by default.
    suppress_with_remap
        Same as suppress but allowing transfer remaps to still occur.
        Used when you want to track file output which is not directly
        specified in their command but whose file locations changed
        compared to their inputs. Off by default.

    Examples
    ________
    >>> Argument("command", "run").vars()
    'run'

    >>> files = ["input_1.txt", "input_2.txt"]
    >>> Argument("input-files", files).vars()
    'input_1.txt input_2.txt'

Definition at line 199 of file __init__.py.

Member Function Documentation

__post_init__()

python.dags.Argument.__post_init__

(

self

)

Definition at line 253 of file __init__.py.

arg_basename()

python.dags.Argument.arg_basename

(

self

)

Definition at line 271 of file __init__.py.

files()

python.dags.Argument.files	(		self,
			basename = False )

Definition at line 290 of file __init__.py.

remaps()

python.dags.Argument.remaps

(

self

)

Definition at line 293 of file __init__.py.

vars()

python.dags.Argument.vars	(		self,
			basename = False )

Definition at line 274 of file __init__.py.

Member Data Documentation

arg_basename

python.dags.Argument.arg_basename

Definition at line 286 of file __init__.py.

argument

python.dags.Argument.argument [int, float, str, List]

static

Definition at line 247 of file __init__.py.

condor_name

python.dags.Argument.condor_name = self.name.replace("-", "_")

Definition at line 256 of file __init__.py.

remap

Optional python.dags.Argument.remap = True

static

Definition at line 249 of file __init__.py.

suppress

Optional python.dags.Argument.suppress = False

static

Definition at line 250 of file __init__.py.

suppress_with_remap

Optional python.dags.Argument.suppress_with_remap = False

static

Definition at line 251 of file __init__.py.

track

Optional python.dags.Argument.track = True

static

Definition at line 248 of file __init__.py.

---

The documentation for this class was generated from the following file:

• /home/abuild/rpmbuild/BUILD/gstlal-1.13.0-build/build_python313/python/dags/__init__.py