.flake8

[flake8]
ignore =
    # https://black.readthedocs.io/en/latest/guides/using_black_with_other_tools.html#pycodestyle
    E203,
    E501,
    E701,
    E704,
    W503,

    # Refers to "necessary dict call - rewrite as a literal".
    C408,

    # To be addressed:
    # Missing docstring in public module
    D100,
    # Missing docstring in public class
    D101,
    # Missing docstring in public function
    D103,
    # Missing docstring in public package
    D104,
    # Missing docstring in magic method
    D105,
    # Missing docstring in __init__
    D107,
    # One-line docstring should fit on one line with quotes
    D200,
    # No blank lines allowed after function docstring
    D202,
    # 1 blank line required between summary line and description
    D205,
    # Multi-line docstring closing quotes should be on a separate line
    D209,
    # First line should end with a period
    D400,
    # First line should be in imperative mood
    D401,
    # First line should not be the function's "signature"
    D402,

    # see https://github.com/PyCQA/flake8-bugbear/issues/278
    # abstract base class without abstract methods
    B024

per-file-ignores =
    # F401: Ignore "imported but unused" errors in __init__ files, as those
    # imports are there to expose submodule functions so they can be imported
    # directly from that module
    # F403: Ignore * imports in these files
    # D102: Missing docstring in public method
    web_poet/__init__.py:F401,F403
    web_poet/page_inputs/__init__.py:F401,F403
    web_poet/serialization/__init__.py:F401,F403
    web_poet/testing/__init__.py:F401,F403
    web_poet/testing/pytest.py:D102
    tests/*:D102

    # the suggestion makes the code worse
    tests/test_serialization.py:B028

    # Documentation examples may miss docstrings and include undefined, example
    # names.
    docs/*:D102,F821