File: debug.md

package info (click to toggle)
python-pyfunceble 4.3.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,144 kB
  • sloc: python: 27,918; sh: 142; makefile: 48
file content (60 lines) | stat: -rw-r--r-- 1,323 bytes parent folder | download | duplicates (2)
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# `debug`

PyFunceble provides a debug mode which outputs everything that is being done.
While this is helpful for troubleshooting, this is not adviced for everyone.

## Overview

```yaml title=".PyFunceble.overwrite.yaml"
debug:
  # Provides everything related to the debug mode.

  # Enable/Disable the debug mode.
  #
  # NOTE:
  #   When enabled, the output will be found inside the logs output directory.
  #   If you prefer to have the output to STDOUT, you should declare the
  #   following environment variable.
  #
  #     PYFUNCEBLE_DEBUG_ON_SCREEN=yes

  # Environment Variable: PYFUNCEBLE_DEBUG
  # CLI Switch: `--debug`
  active: no

  # Set the logging level.
  #
  # Available: info, error, debug, critical
  #
  # Environment Variables: PYFUNCEBLE_DEBUG_LVL | PYFUNCEBLE_LOGGING_LVL
  # CLI Switch: --logging-level
  level: info
```

## `active`

Enable or disable the debug mode.

**Type:** boolean

**Default Value:** `no`

**Available Values:** `yes`, `no`

**CLI Argument:** `--debug`

**Environment Variable:** `PYFUNCEBLE_DEBUG=yes`

## `level`

Set the minimal logging level.

**Type:** string

**Default Value:** `info`

**Available Values:** `info`, `error`, `debug`, `critical`

**CLI Argument:** `--logging-level`

**Environment Variable:** `PYFUNCEBLE_DEBUG_LVL=info` | `PYFUNCEBLE_LOGGING_LVL`