.prospector.yaml

output-format: grouped
strictness: veryhigh
doc-warnings: true
max-line-length: 160

# We run flake8 first and then prospector as a second-pass linter.
# Since flake8 already runs pyflakes, pep8 and mccabe, don't run them again
# with prospector.
mccabe:
  run: false
pep8:
  run: false
pep257:
  disable:
    - D203 # "1 blank line required before class docstring" conflicts with
           # another pep257 rule D211 "No blank lines allowed before class
           # docstring"!
    - D212 # "Multi-line docstring summary should start at the first line"
           # conflicts with another pep257 rule D213 "Multi-line docstring 
           # summary should start at the second line"
pyflakes:
  run: false

pylint:
  enable:
    - relative-import
  disable:
    - line-too-long  # PEP8 checks this and doesn't complain about
                     # unavoidable long lines (such as URLs).
    - missing-docstring  # The pep257 tool reports missing docstrings to us
                         # so we don't need pylint to do so.
    - too-few-public-methods
  options:
    # Some good names that pylint would otherwise reject:
    #
    # - _: placeholder
    # - i,j,k: counters
    # - k,v: dict iteration
    # - db,fn: common abbreviations
    # - fp: python idiom for file handles
    #
    # Some good "constant" names that pylint would otherwise reject:
    #
    # - log: common in "log = logging.getLogger(__name__)" pattern
    # - parser: common in modules that use argparse
    # - id: Commonly used as a class attribute / database column name in
    #       sqlalchemy model classes. Note that if you use id as the name of
    #       a local variable or parameter, pylint will still complain that
    #       you're shadowing the builtin.
    #
    good-names: _,i,j,k,v,e,db,fn,fp,log,parser,id,es
pyroma:
  run: true
ignore-paths:
  - gunicorn.conf.py
  - h/_version.py
  - h/migrations/
  - h/static/
  - node_modules/
  - versioneer.py
ignore-patterns:
  - '.*\.egg'
  - '.*conftest\.py'