Skip to content

Commit 89e37e1

Browse files
authored
Merge pull request #69 from jon-edward/main
Add lists of values to module documentation
2 parents dc5200a + 3fe4002 commit 89e37e1

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

argparse_dataclass.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,20 @@
118118
>>> print(parser.parse_args(["--name", "john doe"]))
119119
Options(name='John Doe')
120120
121+
Parsing a list of values:
122+
123+
.. code-block:: pycon
124+
125+
>>> from dataclasses import dataclass, field
126+
>>> from argparse_dataclass import ArgumentParser
127+
>>> @dataclass
128+
... class Options:
129+
... names: list[str] = field(metadata=dict(type=str, nargs="+"))
130+
...
131+
>>> parser = ArgumentParser(Options)
132+
>>> print(parser.parse_args(["--names", "john", "jane"]))
133+
Options(names=['john', 'jane'])
134+
121135
Configuring a flag to have a default value of True:
122136
123137
.. code-block:: pycon

0 commit comments

Comments
 (0)