Skip to content

metadata-to-variable.md

Latest commit

 

History

History
43 lines (36 loc) · 2.15 KB

metadata-to-variable.md

File metadata and controls

43 lines (36 loc) · 2.15 KB
Raw

metadata-to-variable

  • accepts: seppl.AnyData
  • generates: seppl.AnyData
  • alias(es): metadata-to-placeholder

Sets the variable with the value from the meta-data passing through.

usage: metadata-to-variable [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
                            [-N LOGGER_NAME] [--skip] [-k METADATA_KEY] -V
                            VARIABLE

Sets the variable with the value from the meta-data passing through.

options:
  -h, --help            show this help message and exit
  -l {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --logging_level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                        The logging level to use. (default: WARN)
  -N LOGGER_NAME, --logger_name LOGGER_NAME
                        The custom name to use for the logger, uses the plugin
                        name by default (default: None)
  --skip                Disables the plugin, removing it from the pipeline.
                        (default: False)
  -k METADATA_KEY, --metadata_key METADATA_KEY
                        The key in the meta-data to get the value for the
                        variable from. (default: None)
  -V VARIABLE, -p VARIABLE, --variable VARIABLE, --placeholder VARIABLE
                        The name of the variable, without curly brackets.
                        (default: None)

Available variables:

  • {HOME}: The home directory of the current user.
  • {CWD}: The current working directory.
  • {TMP}: The temp directory.
  • {INPUT_PATH}: The directory part of the current input, i.e., /some/where of input /some/where/file.txt.
  • {INPUT_NAMEEXT}: The name (incl extension) of the current input, i.e., file.txt of input /some/where/file.txt.
  • {INPUT_NAMENOEXT}: The name (excl extension) of the current input, i.e., file of input /some/where/file.txt.
  • {INPUT_EXT}: The extension of the current input (incl dot), i.e., .txt of input /some/where/file.txt.
  • {INPUT_PARENT_PATH}: The directory part of the parent directory of the current input, i.e., /some of input /some/where/file.txt.
  • {INPUT_PARENT_NAME}: The name of the parent directory of the current input, i.e., where of input /some/where/file.txt.