Arg::num_args

num_args

since 0.1.0

Specifies the number of arguments parsed per occurrence.

Examples

Example 1

Spec

TOML

name = "prog"
[args]
mode = { long = "mode", default-missing-value = "slow", default-value = "plaid", num-args = "optional" }

YAML

name: prog
args:
  mode:
    long: mode
    default-missing-value: slow
    default-value: plaid
    num-args: optional

JSON

{
  "name": "prog",
  "args": {
    "mode": {
      "long": "mode",
      "default-missing-value": "slow",
      "default-value": "plaid",
      "num-args": "optional"
    }
  }
}

Input

prog --mode fast

Output

claptrap_mode='fast'

Example 2

Spec

TOML

name = "prog"
[args]
mode = { long = "mode", default-missing-value = "slow", default-value = "plaid", num-args = "optional" }

YAML

name: prog
args:
  mode:
    long: mode
    default-missing-value: slow
    default-value: plaid
    num-args: optional

JSON

{
  "name": "prog",
  "args": {
    "mode": {
      "long": "mode",
      "default-missing-value": "slow",
      "default-value": "plaid",
      "num-args": "optional"
    }
  }
}

Input

prog --mode

Output

claptrap_mode='slow'

Example 3

Spec

TOML

name = "prog"
[args]
mode = { long = "mode", default-missing-value = "slow", default-value = "plaid", num-args = "optional" }

YAML

name: prog
args:
  mode:
    long: mode
    default-missing-value: slow
    default-value: plaid
    num-args: optional

JSON

{
  "name": "prog",
  "args": {
    "mode": {
      "long": "mode",
      "default-missing-value": "slow",
      "default-value": "plaid",
      "num-args": "optional"
    }
  }
}

Input

prog

Output

claptrap_mode='plaid'

Example 4

Spec

TOML

name = "prog"
[args]
file = { short = 'F', num-args = "..", action = "set" }
word = {}

YAML

name: prog
args:
  file:
    short: F
    num-args: ..
    action: set
  word: {}

JSON

{
  "name": "prog",
  "args": {
    "file": {
      "short": "F",
      "num-args": "..",
      "action": "set"
    },
    "word": {}
  }
}

Input

prog -F file1 file2 file3 word

Output

claptrap_file=('file1' 'file2' 'file3' 'word')

Example 5

Spec

TOML

name = "prog"
[args]
file = { short = 'F', num-args = "..", action = "set" }
word = {}

YAML

name: prog
args:
  file:
    short: F
    num-args: ..
    action: set
  word: {}

JSON

{
  "name": "prog",
  "args": {
    "file": {
      "short": "F",
      "num-args": "..",
      "action": "set"
    },
    "word": {}
  }
}

Input

prog word -F file1 file2 file3

Output

claptrap_word='word'
claptrap_file=('file1' 'file2' 'file3')

Example 6

Spec

TOML

name = "prog"
[args]
file = { short = 'F', action = "append" }
word = {}

YAML

name: prog
args:
  file:
    short: F
    action: append
  word: {}

JSON

{
  "name": "prog",
  "args": {
    "file": {
      "short": "F",
      "action": "append"
    },
    "word": {}
  }
}

Input

prog -F file1 -F file2 -F file3 word

Output

claptrap_file=('file1' 'file2' 'file3')
claptrap_word='word'

Example 7

Spec

TOML

name = "prog"
[args]
file = { short = 'F', num-args = 2, action = "set" }

YAML

name: prog
args:
  file:
    short: F
    num-args: 2
    action: set

JSON

{
  "name": "prog",
  "args": {
    "file": {
      "short": "F",
      "num-args": 2,
      "action": "set"
    }
  }
}

Input

prog -F in-file out-file

Output

claptrap_file=('in-file' 'out-file')

Example 8

Spec

TOML

name = "prog"
[args]
file = { short = 'F', num-args = 2, action = "set" }

YAML

name: prog
args:
  file:
    short: F
    num-args: 2
    action: set

JSON

{
  "name": "prog",
  "args": {
    "file": {
      "short": "F",
      "num-args": 2,
      "action": "set"
    }
  }
}

Input

prog -F file1

Output

error: 2 values required for '-F <file> <file>' but 1 was provided

Usage: prog [OPTIONS]

For more information, try '--help'.

Example 9

Spec

TOML

name = "prog"
[args]
mode = { long = "mode", num-args = 1 }

YAML

name: prog
args:
  mode:
    long: mode
    num-args: 1

JSON

{
  "name": "prog",
  "args": {
    "mode": {
      "long": "mode",
      "num-args": 1
    }
  }
}

Input

prog --mode fast

Output

claptrap_mode='fast'