SimpleParsing/examples/docstrings/docstrings_example.py at ce02fd1de3cf45a892deecb3b23f21ba47a3e689 · lebrice/SimpleParsing · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
"""A simple example to demonstrate the 'attribute docstrings' mechanism of simple-parsing."""
from dataclasses import dataclass

from simple_parsing import ArgumentParser

parser = ArgumentParser()


@dataclass
class DocStringsExample:
    """NOTE: This block of text is the class docstring, and it will show up under
    the name of the class in the --help group for this set of parameters.
    """

    attribute1: float = 1.0
    """Docstring below, When used, this always shows up in the --help text for this attribute."""

    # Comment above only: this shows up in the help text, since there is no docstring below.
    attribute2: float = 1.0

    attribute3: float = 1.0  # inline comment only (this shows up in the help text, since none of the two other options are present.)

    # comment above 42
    attribute4: float = 1.0  # inline comment
    """Docstring below (this appears in --help)"""

    # comment above (this appears in --help) 46
    attribute5: float = 1.0  # inline comment

    attribute6: float = 1.0  # inline comment (this appears in --help)

    attribute7: float = 1.0  # inline comment
    """Docstring below (this appears in --help)"""


parser.add_arguments(DocStringsExample, "example")
args = parser.parse_args()
ex = args.example
print(ex)
expected = """
DocStringsExample(attribute1=1.0, attribute2=1.0, attribute3=1.0, attribute4=1.0, attribute5=1.0, attribute6=1.0, attribute7=1.0)
"""