Skip to content

Commit c334ad7

Browse files
committed
Updated config ref
1 parent 1c42832 commit c334ad7

File tree

1 file changed

+82
-72
lines changed

1 file changed

+82
-72
lines changed

docs/config.md

Lines changed: 82 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -297,87 +297,97 @@ Must be one of the following:
297297

298298
## `logging`
299299

300-
Type _object_.
301-
Logging configuration. For details refer to the [dictionary schema](https://docs.python.org/3/library/logging.config.html#logging-config-dictschema) of the Python module `logging.config`.
302-
The key `version` is required.
303-
304-
* `version`:
305-
Logging schema version.
306-
Its value is `1`.
300+
Logging configuration.
301+
Must be one of the following:
307302

308-
* `formatters`:
309-
Type _object_.
310-
Formatter definitions. Each key is a formatter id and each value is an object describing how to configure the corresponding formatter.
311-
The object's values are of type _object_.
312-
Formatter configuration.
313-
314-
* `format`:
315-
Type _string_.
316-
Format string in the given `style`.
317-
Defaults to `"%(message)s"`.
318-
319-
* `datefmt`:
320-
Type _string_.
321-
Format string in the given `style` for the date/time portion.
322-
Defaults to `"%Y-%m-%d %H:%M:%S,uuu"`.
323-
324-
* `style`:
325-
Determines how the format string will be merged with its data.
326-
Must be one of `"%", "{", "$"`.
303+
* Type _boolean_.
304+
Shortform that enables logging to the console using log level `"INFO"`.
327305

328-
* `filters`:
329-
Type _object_.
330-
Filter definitions. Each key is a filter id and each value is a dict describing how to configure the corresponding filter.
331-
The object's values are of type _object_.
332-
Filter configuration.
306+
* Shortform that enables logging to the console using the specified log level.
307+
Must be one of `"CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "NOTSET"`.
333308

334-
* `handlers`:
335-
Type _object_.
336-
Handler definitions. Each key is a handler id and each value is an object describing how to configure the corresponding handler.
337-
The object's values are of type _object_.
338-
Handler configuration. All keys other than the following are passed through as keyword arguments to the handler's constructor.
339-
The key `class` is required.
340-
341-
* `class`:
342-
Type _string_.
343-
The fully qualified name of the handler class. See [logging handlers](https://docs.python.org/3/library/logging.handlers.html).
344-
345-
* `level`:
346-
The level of the handler.
347-
Must be one of `"CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "NOTSET"`.
348-
349-
* `formatter `:
350-
Type _string_.
351-
The id of the formatter for this handler.
352-
353-
* `filters`:
354-
Type _array_.
355-
A list of ids of the filters for this logger.
356-
The items of the array are of type _string_.
357-
358-
* `loggers`:
359-
Type _object_.
360-
Logger definitions. Each key is a logger name and each value is an object describing how to configure the corresponding logger. The tool's logger has the id `'zappend'`.
361-
The object's values are of type _object_.
362-
Logger configuration.
309+
* Type _object_.
310+
Detailed logging configuration. For details refer to the [dictionary schema](https://docs.python.org/3/library/logging.config.html#logging-config-dictschema) of the Python module `logging.config`.
311+
The key `version` is required.
363312

364-
* `level`:
365-
The level of the logger.
366-
Must be one of `"CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "NOTSET"`.
313+
* `version`:
314+
Logging schema version.
315+
Its value is `1`.
367316

368-
* `propagate `:
369-
Type _boolean_.
370-
The propagation setting of the logger.
317+
* `formatters`:
318+
Type _object_.
319+
Formatter definitions. Each key is a formatter id and each value is an object describing how to configure the corresponding formatter.
320+
The object's values are of type _object_.
321+
Formatter configuration.
322+
323+
* `format`:
324+
Type _string_.
325+
Format string in the given `style`.
326+
Defaults to `"%(message)s"`.
327+
328+
* `datefmt`:
329+
Type _string_.
330+
Format string in the given `style` for the date/time portion.
331+
Defaults to `"%Y-%m-%d %H:%M:%S,uuu"`.
332+
333+
* `style`:
334+
Determines how the format string will be merged with its data.
335+
Must be one of `"%", "{", "$"`.
371336

372337
* `filters`:
373-
Type _array_.
374-
A list of ids of the filters for this logger.
375-
The items of the array are of type _string_.
338+
Type _object_.
339+
Filter definitions. Each key is a filter id and each value is a dict describing how to configure the corresponding filter.
340+
The object's values are of type _object_.
341+
Filter configuration.
376342

377343
* `handlers`:
378-
Type _array_.
379-
A list of ids of the handlers for this logger.
380-
The items of the array are of type _string_.
344+
Type _object_.
345+
Handler definitions. Each key is a handler id and each value is an object describing how to configure the corresponding handler.
346+
The object's values are of type _object_.
347+
Handler configuration. All keys other than the following are passed through as keyword arguments to the handler's constructor.
348+
The key `class` is required.
349+
350+
* `class`:
351+
Type _string_.
352+
The fully qualified name of the handler class. See [logging handlers](https://docs.python.org/3/library/logging.handlers.html).
353+
354+
* `level`:
355+
The level of the handler.
356+
Must be one of `"CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "NOTSET"`.
357+
358+
* `formatter `:
359+
Type _string_.
360+
The id of the formatter for this handler.
361+
362+
* `filters`:
363+
Type _array_.
364+
A list of ids of the filters for this logger.
365+
The items of the array are of type _string_.
366+
367+
* `loggers`:
368+
Type _object_.
369+
Logger definitions. Each key is a logger name and each value is an object describing how to configure the corresponding logger. The tool's logger has the id `'zappend'`.
370+
The object's values are of type _object_.
371+
Logger configuration.
372+
373+
* `level`:
374+
The level of the logger.
375+
Must be one of `"CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "NOTSET"`.
376+
377+
* `propagate `:
378+
Type _boolean_.
379+
The propagation setting of the logger.
380+
381+
* `filters`:
382+
Type _array_.
383+
A list of ids of the filters for this logger.
384+
The items of the array are of type _string_.
385+
386+
* `handlers`:
387+
Type _array_.
388+
A list of ids of the handlers for this logger.
389+
The items of the array are of type _string_.
390+
381391

382392
## `dry_run`
383393

0 commit comments

Comments
 (0)