Argument Formatting

Argument Formatters

class slurmjobs.args.Argument

The base-class for all argument formatters. If you want to provide a new argument formatter, just override this class and change either the:

• format_arg method that is used to format positional and key-value pairs, or

• format_value (which is called in format_arg) to format python values as a string. This is often some form of quoted repr or json formatting.

classmethod get(key='fire', *a, **kw)

Return an instance of an argument formatter, based on its name.

format_arg(k, v=Ellipsis)

Format a key-value pair for the command-line.

If it is a positional argument, the value will be in key and the value will be ....

Parameters

• k – The key (or value, for positional arguments).

• v – The value. If it’s a positional argument, it will be v=...

format_value(v)

Format a value for the command-line.

class slurmjobs.args.FireArgument

Argument formatting for Python Fire.

Example: python script.py a b --arg1 c --arg2 d

• Docs: https://google.github.io/python-fire/guide/

• Github: https://github.com/google/python-fire

format_arg(k, v=Ellipsis)

Format a key-value pair for the command-line.

If it is a positional argument, the value will be in key and the value will be ....

Parameters

• k – The key (or value, for positional arguments).

• v – The value. If it’s a positional argument, it will be v=...

class slurmjobs.args.ArgparseArgument

Argument formatting for Python’s builtin argparse.

Example: python script.py a b --arg1 c --arg2 d

• Docs: https://docs.python.org/3/library/argparse.html

format_arg(k, v=Ellipsis)

Format a key-value pair for the command-line.

If it is a positional argument, the value will be in key and the value will be ....

Parameters

• k – The key (or value, for positional arguments).

• v – The value. If it’s a positional argument, it will be v=...

class slurmjobs.args.SacredArgument

Formatting for sacred.

Example: python script.py with arg1=a arg2=b

• Docs: https://sacred.readthedocs.io/en/stable/

• Github: https://github.com/IDSIA/sacred

class slurmjobs.args.HydraArgument(default_prefix='+', **kw)

Formatting for hydra.

Example: python script.py  db.user=root db.pass=1234

• Docs: https://hydra.cc/docs/intro/

• Github: https://github.com/facebookresearch/hydra

format_arg(k, v=Ellipsis)

Format a key-value pair for the command-line.

If it is a positional argument, the value will be in key and the value will be ....

Parameters

• k – The key (or value, for positional arguments).

• v – The value. If it’s a positional argument, it will be v=...