pylintrc

# -*- mode: conf -*-
[GENERAL]
init-hook='import sys; sys.path.append("/usr/src/app")'

[BASIC]
# Good variable names which should always be accepted, separated by a comma
# i,j,k = loop control vars, sq=search query, fn=function/lambda, fh=file handle, ts=timestamp, rx=regular expression
good-names=_,__,___,e,i,j,k,sq,fn,fh,js,ts,rx,logger

## Bad variable names which should always be refused, separated by a comma
# balls/qballs is specific to one of the guys
bad-names=foo,bar,baz,toto,tata,tutu,coucou

class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{1,40}|(__.*__))$
function-rgx=[a-z_][a-z0-9_]{2,50}$
method-rgx=[a-z_][a-z0-9_]{2,50}$

[MESSAGE CONTROL]
# CHANGED:
# C0111: Missing docstring
# E0602: Undefined variable %r
# I0011: Locally disabled messages
# I0012: Locally enabled messages
# R0801: Similar lines in files
# R0903: Too few public methods
# W0141: Bad-builtins
# W0142: Use of * or ** magic
# W0223: Abstract method not overridden
# W0603: Using the global statement
# W1202: Logging with '{}' formating instead of '%'
# C0330: Wrong hanging indentation before block (add 4 spaces).
# "bad-continuation" is currently disabled because of that issue -> https://github.com/PyCQA/pylint/issues/289
disable=C0111,E0602,I0011,I0012,R0801,R0903,W0141,W0142,W0223,W0603,W1202,C0303,C0330,C0301,W0707

[DESIGN]
## Maximum number of arguments for function / method
max-args=8

## Maximum number of locals for function / method body
max-locals=10

## Maximum number of return / yield for function / method body
max-returns=10

## Maximum number of branch for function / method body
max-branchs=45

## Maximum number of statements in function / method body
max-statements=100

## Maximum number of public methods for a class (see R0904).
max-public-methods=30

max-attributes=15

[FORMAT]
max-line-length=80

## Maximum number of lines in a module
max-module-lines=1000

# String used as indentation unit. We found that two spaces is the best balance for readability, easy typing, etc.
indent-string='    '

[MISCELLANEOUS]
# List of note tags to take in consideration, separated by a comma. One of our guys uses qballs when he wants to flag something for himself.
notes=FIXME,NINJA