Arg::action

action

since 0.1.0

Specify how to react to an argument when parsing it.

Examples

Example 1

Spec

TOML

name = "prog"
[args]
flag = { long = "flag", action = "append" }

YAML

name: prog
args:
  flag:
    long: flag
    action: append

JSON

{
  "name": "prog",
  "args": {
    "flag": {
      "long": "flag",
      "action": "append"
    }
  }
}

Input

prog --flag value1 --flag value2

Output

claptrap_flag=('value1' 'value2')

Example 2

Spec

TOML

name = "prog"
[args]
flag = { long = "flag", action = "count" }

YAML

name: prog
args:
  flag:
    long: flag
    action: count

JSON

{
  "name": "prog",
  "args": {
    "flag": {
      "long": "flag",
      "action": "count"
    }
  }
}

Input

prog --flag --flag

Output

claptrap_flag='2'

Example 3

Spec

TOML

name = "prog"
[args]
flag = { long = "flag", action = "help" }

YAML

name: prog
args:
  flag:
    long: flag
    action: help

JSON

{
  "name": "prog",
  "args": {
    "flag": {
      "long": "flag",
      "action": "help"
    }
  }
}

Input

prog -h

Output

Usage: prog

Options:
      --flag
  -h, --help  Print help

Example 4

Spec

TOML

name = "prog"
[args]
flag = { long = "flag", action = "help-long" }

YAML

name: prog
args:
  flag:
    long: flag
    action: help-long

JSON

{
  "name": "prog",
  "args": {
    "flag": {
      "long": "flag",
      "action": "help-long"
    }
  }
}

Input

prog -h

Output

Usage: prog

Options:
      --flag
  -h, --help  Print help

Example 5

Spec

TOML

name = "prog"
[args]
flag = { long = "flag", action = "help-short" }

YAML

name: prog
args:
  flag:
    long: flag
    action: help-short

JSON

{
  "name": "prog",
  "args": {
    "flag": {
      "long": "flag",
      "action": "help-short"
    }
  }
}

Input

prog -h

Output

Usage: prog

Options:
      --flag
  -h, --help  Print help

Example 6

Spec

TOML

name = "prog"
[args]
flag = { long = "flag", action = "set" }

YAML

name: prog
args:
  flag:
    long: flag
    action: set

JSON

{
  "name": "prog",
  "args": {
    "flag": {
      "long": "flag",
      "action": "set"
    }
  }
}

Input

prog --flag value

Output

claptrap_flag='value'

Example 7

Spec

TOML

name = "prog"
[args]
flag = { long = "flag", action = "set-false" }

YAML

name: prog
args:
  flag:
    long: flag
    action: set-false

JSON

{
  "name": "prog",
  "args": {
    "flag": {
      "long": "flag",
      "action": "set-false"
    }
  }
}

Input

prog --flag

Output

claptrap_flag='false'

Example 8

Spec

TOML

name = "prog"
[args]
flag = { long = "flag", action = "set-true" }

YAML

name: prog
args:
  flag:
    long: flag
    action: set-true

JSON

{
  "name": "prog",
  "args": {
    "flag": {
      "long": "flag",
      "action": "set-true"
    }
  }
}

Input

prog --flag

Output

claptrap_flag='true'

Example 9

Spec

TOML

name = "prog"
version = "1.0.0"
[args]
flag = { long = "flag", action = "version" }

YAML

name: prog
version: 1.0.0
args:
  flag:
    long: flag
    action: version

JSON

{
  "name": "prog",
  "version": "1.0.0",
  "args": {
    "flag": {
      "long": "flag",
      "action": "version"
    }
  }
}

Input

prog --version

Output

prog 1.0.0