.flake8

# flake8 plugins: https://github.com/DmytroLitvinov/awesome-flake8-extensions
# TODO(amir): add flake8-annotations once the API refactor is completed
# TODO(amir): add flake8-annotations-coverage
# TODO(amir): investigate flake8-annotations-complexity
# TODO(amir): add docstring-convention = numpydoc once API refactor is done
# TODO(amir): investigate the tim to roll out https://peps.python.org/pep-0585/
# https://stackoverflow.com/questions/66738753/python-typing-deprecation
# TODO(amir): investigate https://peps.python.org/pep-0563/
[flake8]
max-line-length = 100

ignore = 
    # TODO(amir): E501 would ignore `max-line-length = 100` rule; we have cases that max-line-length
    # are > 100 which is mostly comments and some front-end codes in the code base
    # E501: Line too long
    E501,
    # E203: Whitespace before ':'
    E203,
    # E402: Module level import not at top of file
    E402,
    # W503: Line break occurred before a binary operator
    W503
    # ANN002: Missing type annotation for *args
    ANN002,
    # ANN003: Missing type annotation for **kwargs
    ANN003,
    # ANN101: Missing type annotation for self in method
    ANN101,
    # ANN102: Missing type annotation for cls in classmethod
    ANN102,
    # ANN202: Missing return type annotation for protected function
    ANN202,
    # ANN203: Missing return type annotation for secret function
    ANN203,
    # ANN204: Missing return type annotation for special method
    ANN204,
    # ANN401: Dynamically typed expressions (typing.Any) are disallowed.
    ANN401,
    # E800: Commented out code
    E800,
    # N806: Lowercase variable in a function
    N806,
    # N803: Lowercase argument name
    N803,
    # N802: Lowercase functionam name
    N802,
    # TC002: Third-party imports into type-checking block
    TC002,
    # TYP001: Guard import for type-checking
    TYP001,
    # C408: Dict calls
    C408,
    # C403: List calls
    C403,
    # SIM904: Dict initialization
    SIM904,
    # SIM113: Enumerate usage
    SIM113


exclude =
    .vscode
    .github
    .ipynb_checkpoints
    .git,
    __pycache__,
    docs/conf.py,
    old,
    build,
    dist,
    .venv/*,
    .pytest_cache,
    .tox,
    .python-version,
    .mypy_cache,
    htmlcov/*,
    xmlcov/*,
    .coverage,
    examples/