Skip to content

Commit 1f18f5c

Browse files
authored
Update README.md (#348)
1 parent 172dc1a commit 1f18f5c

1 file changed

Lines changed: 16 additions & 9 deletions

File tree

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -158,11 +158,17 @@ Only command line args that have a long version (eg. one that starts with '--')
158158
can be set in a config file. For example, "--color" can be set by putting
159159
"color=green" in a config file. The config file syntax depends on the constructor
160160
arg: `config_file_parser_class` which can be set to one of the provided
161-
classes: `DefaultConfigFileParser`, `YAMLConfigFileParser`,
162-
`ConfigparserConfigFileParser` or to your own subclass of the
163-
`ConfigFileParser` abstract class.
161+
classes:
162+
- `DefaultConfigFileParser`
163+
- `YAMLConfigFileParser`
164+
- `ConfigparserConfigFileParser`
165+
- `IniConfigParser`
166+
- `TomlConfigParser`
167+
- `CompositeConfigParser`
168+
169+
or to your own subclass of the `ConfigFileParser` abstract class.
164170

165-
*DefaultConfigFileParser* - the full range of valid syntax is:
171+
#### *DefaultConfigFileParser* - the full range of valid syntax is:
166172

167173
```yaml
168174
# this is a comment
@@ -187,7 +193,7 @@ fruit = [apple, orange, lemon]
187193
indexes = [1, 12, 35 , 40]
188194
```
189195

190-
*YAMLConfigFileParser* - allows a subset of YAML syntax (http://goo.gl/VgT2DU)
196+
#### *YAMLConfigFileParser* - allows a subset of YAML syntax (http://goo.gl/VgT2DU)
191197

192198
```yaml
193199
# a comment
@@ -202,7 +208,8 @@ colors:
202208
- blue
203209
```
204210
205-
*ConfigparserConfigFileParser* - allows a subset of python's configparser
211+
#### *ConfigparserConfigFileParser* - allows a subset of python's configparser
212+
206213
module syntax (https://docs.python.org/3.7/library/configparser.html). In
207214
particular the following configparser options are set:
208215
@@ -253,7 +260,7 @@ parser.add_argument('--system1_settings', type=yaml.safe_load)
253260
args = parser.parse_args() # now args.system1 is a valid python dict
254261
```
255262

256-
*IniConfigParser* - INI parser with support for sections.
263+
#### *IniConfigParser* - INI parser with support for sections.
257264

258265
This parser somewhat resembles `ConfigparserConfigFileParser`. It uses configparser and applies the same kind of processing to
259266
values written with python list syntax.
@@ -321,7 +328,7 @@ parser = configargparse.ArgParser(
321328
...
322329
```
323330

324-
*TomlConfigParser* - TOML parser with support for sections.
331+
#### *TomlConfigParser* - TOML parser with support for sections.
325332

326333
[TOML](https://github.com/toml-lang/toml/blob/main/toml.md) parser. This config parser can be used to integrate with `pyproject.toml` files.
327334

@@ -358,7 +365,7 @@ parser = configargparse.ArgParser(
358365
...
359366
```
360367

361-
*CompositeConfigParser* - Create a config parser to understand multiple formats.
368+
#### *CompositeConfigParser* - parses more than one config file format.
362369

363370
This parser will successively try to parse the file with each parser, until it succeeds,
364371
else fail showing all encountered error messages.

0 commit comments

Comments
 (0)