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]
# Base flake8 configuration:
# https://flake8.pycqa.org/en/latest/user/configuration.html
format = wemake
show-source = True
statistics = False
doctests = True

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

# Plugins:
max-complexity = 6
max-line-length = 80

# wemake-python-styleguide settings:
i-control-code = False

# Disable some pydocstyle checks:
# Exclude some pydoctest checks globally:
ignore = D100, D104, D106, D401, W504, X100, RST303, RST304, DAR103, DAR203,
    WPS305, WPS237, WPS110, WPS226, WPS323, WPS337, WPS111, W503, WPS428

# Excluding some directories:
exclude =
    .git
    __pycache__
    .venv
    .eggs
    *.egg
    tests/fixtures/**
    tests/**/snapshots/**
    .history/**
    sandbox.py

# Ignoring some errors in some files:
per-file-ignores =
    # Enable `assert` keyword and magic numbers for tests:
    tests/*.py: S101, WPS226, WPS432
    # otherwise requires docstrings for empty __init__.py
    */__init__.py: D104

# add on custom
inline-quotes = double
max-line-complexity = 23
max-local-variables = 9
max-methods = 8

[isort]
# isort configuration:
# https://github.com/timothycrosley/isort/wiki/isort-Settings
include_trailing_comma = true
use_parentheses = true
# See https://github.com/timothycrosley/isort#multi-line-output-modes
multi_line_output = 3
line_length = 80


[tool:pytest]
# Directories that are not visited by pytest collector:
norecursedirs =
    *.egg .eggs dist build docs .tox .git __pycache__ .history sandbox.py

# Extra options:
addopts =
    --strict-markers
    --strict-config
    --tb=short
    --doctest-modules
    --cov=wsl_pathlib
    --cov-report=term:skip-covered
    --cov-report=html
    --cov-report=xml
    --cov-branch
    # necessary to combine the different runs of gh action's matrix
    --cov-append
    # breaks vscode test discovery: https://github.com/microsoft/vscode-python/issues/11729
    # --cov-fail-under=100

[mypy]
# mypy configurations: http://bit.ly/2zEl9WI
allow_redefinition = False
check_untyped_defs = True
disallow_any_explicit = True
disallow_any_generics = True
disallow_untyped_calls = 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_no_return = True
warn_unused_ignores = True
warn_redundant_casts = True
warn_unused_configs = True
warn_unreachable = True


[doc8]
# doc8 configuration: https://pypi.org/project/doc8/
ignore-path = docs/_build
max-line-length = 80
sphinx = True
# carriage return issue when running on gh matrix: windows
# cf: https://github.com/vscode-restructuredtext/vscode-restructuredtext/issues/84
ignore = D004