setup.cfg

# All configuration for plugins and other utils is defined here.
# Read more about `setup.cfg`:
# https://docs.python.org/3/distutils/configfile.html


[flake8]
# flake8 configuration:
# https://flake8.pycqa.org/en/latest/user/configuration.html
format = wemake
show-source = true
statistics = false
doctests = true
enable-extensions = G

# darglint configuration:
# https://github.com/terrencepreilly/darglint
strictness = long
docstring-style = numpy

# Flake plugins:
max-line-length = 80
max-complexity = 6
max-imports = 14

# Excluding some directories:
exclude = .git,__pycache__,.venv,.eggs,*.egg,frontend,landing

# Disable some pydocstyle checks:
ignore = D100, D104, D106, D401, X100, W504, RST303, RST304, DAR103, DAR203

# Docs: https://github.com/snoack/flake8-per-file-ignores
# You can completely or partially disable our custom checks,
# to do so you have to ignore `WPS` letters for all python files:
per-file-ignores =
  # Allow upper-case constants in classes, because it is settings:
  server/common/django/types.py: WPS115
  # Allow `__init__.py` with logic for configuration:
  server/settings/*.py: WPS226, WPS407, WPS412, WPS432
  # Allow to have magic numbers and wrong module names inside migrations:
  server/*/migrations/*.py: WPS102, WPS114, WPS432
  # Tests have some more freedom:
  tests/*.py: S101, WPS201, WPS202, WPS218, WPS226, WPS436, WPS442


[isort]
# isort configuration:
# https://github.com/PyCQA/isort/wiki/isort-Settings
profile = wemake


[tool:pytest]
# pytest configuration:
# https://docs.pytest.org/en/stable/customize.html

# pytest-django configuration:
# https://pytest-django.readthedocs.io/en/latest/
DJANGO_SETTINGS_MODULE = server.settings

# Timeout for tests, so they can not take longer
# than this amount of seconds.
# You should adjust this value to be as low as possible.
# Configuration:
# https://pypi.org/project/pytest-timeout/
timeout = 5

# Strict `@xfail` by default:
xfail_strict = true

# Directories that are not visited by pytest collector:
norecursedirs = *.egg .eggs dist build docs .tox .git __pycache__ frontend landing

# You will need to measure your tests speed with `-n auto` and without it,
# so you can see whether it gives you any performance gain, or just gives
# you an overhead. See `docs/template/development-process.rst`.
addopts =
  --strict-markers
  --strict-config
  --doctest-modules
  --fail-on-template-vars
  # Output:
  --tb=short
  # Parallelism:
  # -n auto
  # --boxed
  # Coverage:
  --cov=server
  --cov=tests
  --cov-branch
  --cov-report=term-missing:skip-covered
  --cov-report=html
  --cov-report=xml
  --cov-fail-under=0

filterwarnings =
  # TODO: get rid of these warnings in our code:
  ignore::django.utils.deprecation.RemovedInDjango50Warning
  ignore::django.utils.deprecation.RemovedInDjango51Warning
  # Some dependencies have deprecation warnings, we don't want to see them,
  # but, we want to list them here:
  ignore::DeprecationWarning:password_reset.*:
  ignore::DeprecationWarning:pytest_freezegun:


[coverage:run]
# Coverage configuration:
# https://coverage.readthedocs.io/en/latest/config.html
plugins =
  # Docs: https://github.com/nedbat/django_coverage_plugin
  django_coverage_plugin
  # Docs: https://pypi.org/project/covdefaults
  covdefaults

omit =
  # Is not reported, because is imported during setup:
  server/settings/components/logging.py


[mypy]
# Mypy configuration:
# https://mypy.readthedocs.io/en/latest/config_file.html
enable_error_code =
  truthy-bool,
  truthy-iterable,
  redundant-expr,
  unused-awaitable,
  ignore-without-code,
  possibly-undefined,
  redundant-self,

extra_checks = true

disable_error_code =
  literal-required,

enable_incomplete_feature =
  Unpack,

allow_redefinition = false
check_untyped_defs = true
disallow_untyped_decorators = true
disallow_any_explicit = false
disallow_any_generics = true
disallow_untyped_calls = true
disallow_incomplete_defs = true
explicit_package_bases = true
ignore_errors = false
ignore_missing_imports = true
implicit_reexport = false
local_partial_types = true
strict_optional = true
strict_equality = true
no_implicit_optional = true
warn_unused_ignores = true
warn_redundant_casts = true
warn_unused_configs = true
warn_unreachable = true
warn_no_return = true

plugins =
  mypy_django_plugin.main,
  pydantic.mypy

[mypy-server.apps.*.migrations.*]
# Django migrations should not produce any errors (they are tested anyway):
ignore_errors = true

[mypy.plugins.django-stubs]
# Docs: https://github.com/typeddjango/django-stubs
django_settings_module = server.settings
strict_settings = false


[doc8]
# doc8 configuration:
# https://github.com/pycqa/doc8
ignore-path = docs/_build
max-line-length = 80
sphinx = true