.flake8

[flake8]
ignore =
    # Do not use mutable data structures for argument defaults. They are created during function definition time.
    #  \ All calls to the function reuse this one instance of that data structure, persisting changes between them.
    B006
    # Unsed variable -> sometimes we need to ignore this for debugging purposes
    B007
    # 1 blank line required between summary line and description
    B008
    # Function definition does not bind loop variabl
    B023
    # Unnecessary use of map - use a list comprehension instead.
    C417
    # Unnecessary dict comprehension - rewrite using dict().
    C416
    # Unnecessary dict call - rewrite as a literal.
    C408
    # line break before a binary operator -> black does not adhere to PEP8
    W503
    # line break occured after a binary operator -> black does not adhere to PEP8
    W504
    # line too long -> we accept long comment lines; black gets rid of long code lines
    E501
    # whitespace before : -> black does not adhere to PEP8
    E203
    # missing whitespace after ,', ';', or ':' -> black does not adhere to PEP8
    E231
    # continuation line over-indented for hanging indent -> black does not adhere to PEP8
    E126
    # too many leading '#' for block comment -> this is fine for indicating sections
    E262
    # Do not assign a lambda expression, use a def -> lambda expression assignments are convenient
    E731
    # allow I, O, l as variable names -> I is the identity matrix
    E741
    # Missing docstring in public package
    D104
    # Missing docstring in public module
    D100
    # Missing docstring in __init__
    D107
    # Missing docstring in magic method
    D105
    # format string does contain unindexed parameters
    P101
    # first line should end with a period [Bug: doesn't work with single-line docstrings]
    D400
    # First line should be in imperative mood; try rephrasing
    D401
    # Missing docstring in public method
    D102
    # Missing docstring in public function
    D103
    # One-line docstring should fit on one line with quotes
    D200
    # D403 First word of the first line should be properly capitalized
    D403
    # Section has no content
    D414
    # RST213 Inline emphasis start-string without end-string.
    RST213
    # Unnecessary list comprehension passed to all()
    C419

exclude =
    .git,
    __pycache__,
    build,
    docs/_build,
    dist,
    experiments,
per-file-ignores =
    tests/*: D
    */__init__.py: F401
extend-immutable-calls =
    # Add functions returning immutable values here to avoid B008
    pathlib.Path
    Path
rst-roles =
    class,
    func,
    ref,
    meth,
    doc,
    py:class,
    method,
    attr,
    cite:p,
    cite:t,
rst-directives =
    envvar,
    exception,
rst-substitutions =
    version,
extend-ignore =
    RST307,RST210,RST201,RST203,RST301