prospector.yaml

strictness: high
inherits:
  - strictness_high

doc-warnings: true
member-warnings: true
test-warnings: true

autodetect: false
output-format: grouped

ignore-paths:
  - spicerack/tests/fixtures/cookbook/cookbooks/group3/invalid_syntax.py
  - spicerack/tests/fixtures/cookbook/cookbooks/group3/invalid_subgroup/__init__.py
  - doc/source/conf.py
  - build/
  - dist/
  - logs/

# To be removed once we rename pep8 and pep257 to the new names, removing backward compatibility with prospector<1.7.0
profile-validator:
  disable:
    - deprecated-tool-code

pep8:
  full: true
  options:
    max-line-length: 120
  disable:
    - E203  # Apparently not PEP8 compliant, clashes with black, see https://github.com/psf/black/issues/315

pep257:
  explain: true
  source: true
  disable:
    - D203  # 1 blank line required before class docstring, D211 (after) is enforce instead
    - D213  # Multi-line docstring summary should start at the second line, D212 (first line) is enforced instead
    - D406  # Section name should end with a newline, incompatible with Google Style Python Docstrings
    - D407  # Missing dashed underline after section, incompatible with Google Style Python Docstrings

pylint:
  disable:
    - pointless-string-statement  # used as documentation for class attributes
    - unspecified-encoding  # Can create issues only on Windows, that is not supported
    # the following two from https://github.com/psf/black/blob/master/docs/compatible_configs.md#pylint
    - C0330  # Wrong hanging indentation
    - C0326  # Bad whitespace
    - C0302  # Too many lines in the module
  options:
    good-names: handleError  # From logging.Handler, inline disable doesn't work, used in test_log.py
    ignore: vulture_whitelist.py
    max-line-length: 120
    max-args: 7
    max-positional-arguments: 6
    max-attributes: 14
    max-locals: 16
    include-naming-hint: true
    const-rgx: (([A-Z_][A-Z0-9_]*)|(__.*__)|(logger))$  # Add 'logger' as a valid module-scope name
    variable-rgx: (([a-z][a-z0-9_]{0,30})|(_[a-z0-9_]*))$
    variable-name-hint: (([a-z][a-z0-9_]{0,30})|(_[a-z0-9_]*))$

pyroma:
  run: true

vulture:
  run: true