Arg::requires_ifs

requires_ifs

since 0.1.0

Allows multiple conditional requirements.

Examples

Example 1

Spec

TOML

name = "prog"
[args]
config = { long = "config", action = "set", requires-ifs = [{ arg = "opt", value = "special.conf" }, { arg = "other", value = "other.conf" }] }
opt = { long = "option", action = "set" }
other = {}

YAML

name: prog
args:
  config:
    long: config
    action: set
    requires-ifs:
    - arg: opt
      value: special.conf
    - arg: other
      value: other.conf
  opt:
    long: option
    action: set
  other: {}

JSON

{
  "name": "prog",
  "args": {
    "config": {
      "long": "config",
      "action": "set",
      "requires-ifs": [
        {
          "arg": "opt",
          "value": "special.conf"
        },
        {
          "arg": "other",
          "value": "other.conf"
        }
      ]
    },
    "opt": {
      "long": "option",
      "action": "set"
    },
    "other": {}
  }
}

Input

prog --config other.conf

Output

error: the following required arguments were not provided:
  <other>

Usage: prog --config <config> <other>

For more information, try '--help'.

Example 2

Spec

TOML

name = "prog"
[args]
config = { long = "config", action = "set", requires-ifs = [{ arg = "opt", value = "special.conf" }, { arg = "other", value = "other.conf" }] }
opt = { long = "option", action = "set" }
other = {}

YAML

name: prog
args:
  config:
    long: config
    action: set
    requires-ifs:
    - arg: opt
      value: special.conf
    - arg: other
      value: other.conf
  opt:
    long: option
    action: set
  other: {}

JSON

{
  "name": "prog",
  "args": {
    "config": {
      "long": "config",
      "action": "set",
      "requires-ifs": [
        {
          "arg": "opt",
          "value": "special.conf"
        },
        {
          "arg": "other",
          "value": "other.conf"
        }
      ]
    },
    "opt": {
      "long": "option",
      "action": "set"
    },
    "other": {}
  }
}

Input

prog --config special.conf

Output

error: the following required arguments were not provided:
  --option <opt>

Usage: prog --option <opt> --config <config> [other]

For more information, try '--help'.

Example 3

Spec

TOML

name = "prog"
[args]
config = { long = "config", action = "set", requires-ifs = [{ arg = "input" }, { arg = "output" }] }
input = {}
output = {}

YAML

name: prog
args:
  config:
    long: config
    action: set
    requires-ifs:
    - arg: input
    - arg: output
  input: {}
  output: {}

JSON

{
  "name": "prog",
  "args": {
    "config": {
      "long": "config",
      "action": "set",
      "requires-ifs": [
        {
          "arg": "input"
        },
        {
          "arg": "output"
        }
      ]
    },
    "input": {},
    "output": {}
  }
}

Input

prog --config file.conf in.txt out.txt

Output

claptrap_config='file.conf'
claptrap_input='in.txt'
claptrap_output='out.txt'

Example 4

Spec

TOML

name = "prog"
[args]
config = { long = "config", action = "set", requires-ifs = [{ arg = "input" }, { arg = "output" }] }
input = {}
output = {}

YAML

name: prog
args:
  config:
    long: config
    action: set
    requires-ifs:
    - arg: input
    - arg: output
  input: {}
  output: {}

JSON

{
  "name": "prog",
  "args": {
    "config": {
      "long": "config",
      "action": "set",
      "requires-ifs": [
        {
          "arg": "input"
        },
        {
          "arg": "output"
        }
      ]
    },
    "input": {},
    "output": {}
  }
}

Input

prog --config file.conf in.txt

Output

error: the following required arguments were not provided:
  <output>

Usage: prog --config <config> <input> <output>

For more information, try '--help'.