prospector.yaml

---
# Ensure very detailed checking with no exclusions
strictness: veryhigh
doc-warnings: true
member-warnings: true
test-warnings: true

# Set maximum line length across linters to the agreed length
max-line-length: 100

pylint:
  options:
    # Regular expressions used to match various names
    # (we allow shorter and longer names than default)
    argument-rgx: "[a-z_][a-z0-9_]*$"
    attr-rgx: "[a-z_][a-z0-9_]*$"
    function-rgx: "[a-z_][a-z0-9_]*$"
    method-rgx: "[a-z_][a-z0-9_]*$"
    variable-rgx: "[a-z_][a-z0-9_]*$"
  disable:
    # Disable annoying too many and too few checks
    - too-many-ancestors
    - too-many-instance-attributes
    - too-few-public-methods
    - too-many-public-methods
    - too-many-return-statements
    - too-many-branches
    - too-many-arguments
    - too-many-locals
    - too-many-statements
    - too-many-lines

    # Disable line continuation checking as it is buggy and covered by flake8 anyway.
    # See https://github.com/PyCQA/pylint/issues/289) for further information.
    # Note that this is also disabled by prospector by default but I left it here for clarity.
    - bad-continuation

    # Disable checking that method could be a function in classes
    - no-self-use

    # Similar lines in files
    - duplicate-code

    # Disable unnecessary else after return as it complains when returning in an else statement
    # which is often more readable
    - no-else-return

mccabe:
  run: false

pep257:
  run: false