|
| 1 | +# Sample Vermin Configuration |
| 2 | +# |
| 3 | +# It contains all config options with default values commented out. |
| 4 | +# The file is typically renamed as "vermin.ini" when copied into a project. |
| 5 | + |
| 6 | +[vermin] |
| 7 | +### Quiet mode ### |
| 8 | +# It only prints the final versions verdict. |
| 9 | +# |
| 10 | +#quiet = no |
| 11 | + |
| 12 | +### Verbosity ### |
| 13 | +# Verbosity level 1 to 4. -v, -vv, -vvv, and -vvvv shows increasingly more information. Turned off |
| 14 | +# at level 0. |
| 15 | +# |
| 16 | +verbose = 3 |
| 17 | + |
| 18 | +### Dump AST node visits ### |
| 19 | +# Only for debugging. |
| 20 | +# |
| 21 | +#print_visits = no |
| 22 | + |
| 23 | +### Matching target versions ### |
| 24 | +# Target version that files must abide by. Can be specified once or twice. |
| 25 | +# A '-' can be appended to match target version or smaller, like '3.5-'. |
| 26 | +# If not met Vermin will exit with code 1. |
| 27 | +# Note that the amount of target versions must match the amount of minimum required versions |
| 28 | +# detected. |
| 29 | +# |
| 30 | +# Examples: |
| 31 | +targets = 3.6 |
| 32 | + |
| 33 | +### Concurrent processing ### |
| 34 | +# Use N concurrent processes to detect and analyze files. Defaults to 0, meaning all cores |
| 35 | +# available. |
| 36 | +# |
| 37 | +#processes = 0 |
| 38 | + |
| 39 | +### Ignore incompatible versions and warnings ### |
| 40 | +# However, if no compatible versions are found then incompatible versions will be shown in the end |
| 41 | +# to not have an absence of results. |
| 42 | +# |
| 43 | +#ignore_incomp = no |
| 44 | + |
| 45 | +### Lax mode ### |
| 46 | +# It ignores conditionals (if, ternary, for, async for, while, with, try, bool op) on AST traversal, |
| 47 | +# which can be useful when minimum versions are detected in conditionals that it is known does not |
| 48 | +# affect the results. |
| 49 | +# |
| 50 | +# Note: It is better to use excludes or `# novermin`/`# novm` in the source code instead. |
| 51 | +# |
| 52 | +#lax = no |
| 53 | + |
| 54 | +### Hidden analysis ### |
| 55 | +# Analyze 'hidden' files and folders starting with '.' (ignored by default when not specified |
| 56 | +# directly). |
| 57 | +# |
| 58 | +analyze_hidden = yes |
| 59 | + |
| 60 | +### Tips ### |
| 61 | +# Possibly show helpful tips at the end, like those relating to backports or lax mode. |
| 62 | +# |
| 63 | +#show_tips = yes |
| 64 | + |
| 65 | +### Pessimistic mode ### |
| 66 | +# Syntax errors are interpreted as the major Python version in use being incompatible. |
| 67 | +# |
| 68 | +pessimistic = yes |
| 69 | + |
| 70 | +### Exclusions ### |
| 71 | +# Exclude full names, like 'email.parser.FeedParser', from analysis. Useful to ignore conditional |
| 72 | +# logic that can trigger incompatible results. It's more fine grained than lax mode. |
| 73 | +# |
| 74 | +# Exclude 'foo.bar.baz' module/member: foo.bar.baz |
| 75 | +# Exclude 'foo' kwarg: somemodule.func(foo) |
| 76 | +# Exclude 'bar' codecs error handler: ceh=bar |
| 77 | +# Exclude 'baz' codecs encoding: ce=baz |
| 78 | +# |
| 79 | +# Example exclusions: |
| 80 | +#exclusions = |
| 81 | +# email.parser.FeedParser |
| 82 | +# argparse.ArgumentParser(allow_abbrev) |
| 83 | + |
| 84 | +### Backports ### |
| 85 | +# Some features are sometimes backported into packages, in repositories such as PyPi, that are |
| 86 | +# widely used but aren't in the standard language. If such a backport is specified as being used, |
| 87 | +# the results will reflect that instead. |
| 88 | +# |
| 89 | +# Get full list via `--help`. |
| 90 | +# |
| 91 | +# Example backports: |
| 92 | +backports = |
| 93 | + typing |
| 94 | + |
| 95 | +### Features ### |
| 96 | +# Some features are disabled by default due to being unstable but can be enabled explicitly. |
| 97 | +# |
| 98 | +# Get full list via `--help`. |
| 99 | +# |
| 100 | +# Example features: |
| 101 | +features = |
| 102 | + fstring-self-doc |
| 103 | + |
| 104 | +### Format ### |
| 105 | +# Format to show results and output in. |
| 106 | +# |
| 107 | +# Get full list via `--help`. |
| 108 | +# |
| 109 | +#format = default |
| 110 | + |
| 111 | +### Annotations evaluation ### |
| 112 | +# Instructs parser that annotations will be manually evaluated in code, which changes minimum |
| 113 | +# versions in certain cases. Otherwise, function and variable annotations are not evaluated at |
| 114 | +# definition time. Apply this argument if code uses `typing.get_type_hints` or |
| 115 | +# `eval(obj.__annotations__)` or otherwise forces evaluation of annotations. |
| 116 | +# |
| 117 | +eval_annotations = yes |
| 118 | + |
| 119 | +### Violations ### |
| 120 | +# |
| 121 | +only_show_violations = yes |
0 commit comments