setup.cfg

# [catalyst]
# use_libjpeg_turbo = True


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


# flake8 configuration:
#  https://flake8.pycqa.org/en/latest/user/configuration.html
[flake8]
convention = google
doctests = True

# plugins:
max-complexity = 12
max-line-length = 79
max-doc-length = 79
docstring-quotes = double
inline-quotes = double
multiline-quotes = double

# darglint configuration:
#  https://github.com/terrencepreilly/darglint
strictness = short

# excluding some directories:
exclude =
  .git,
  __pycache__,
  .venv,
  .eggs,
  *.egg,
  dist

# exclude some pydoctest checks globally:
ignore =
  # D100: Missing docstring in public module
  D100,
  # D104: Missing docstring in public package
  D104,
  # D107: Missing docstring in __init__
  D107,
  # D205: 1 blank line required between summary line and description
  D205,
  # D301: Use r""" if any backslashes in a docstring
  D301,
  # D400: First line should end with a period
  D400,
  # D401: First line should be in imperative mood; try rephrasing
  D401,
  # RST201: Block quote ends without a blank line; unexpected unindent
  RST201,
  # RST203: Definition list ends without a blank line; unexpected unindent
  RST203,
  # RST210: Inline strong start-string without end-string
  RST210,
  # RST213 Inline emphasis start-string without end-string
  RST213,
  # RST301: Unexpected indentation
  RST301,
  # RST304: Unknown interpreted text role
  RST304,
  # N812: lowercase imported as non lowercase
  N812


# isort configuration:
#  https://github.com/timothycrosley/isort/wiki/isort-Settings
[isort]
multi_line_output = 5
case_sensitive = False
combine_as_imports = True
default_section = THIRDPARTY
force_grid_wrap = 0
force_sort_within_sections = True
include_trailing_comma = True
known_first_party = esrgan
line_length = 79
lines_between_types = 0
order_by_type = False
use_parentheses = True


# mypy configurations:
#  https://mypy.readthedocs.io/en/latest/config_file.html
[mypy]
allow_redefinition = True
check_untyped_defs = True
disallow_incomplete_defs = True
disallow_any_generics = True
ignore_missing_imports = True
implicit_reexport = False
strict_optional = True
strict_equality = True
show_error_codes = True
show_error_context = True
no_implicit_optional = True
warn_unused_ignores = True
warn_redundant_casts = True
warn_return_any = True
warn_unused_configs = True
warn_unreachable = True
warn_no_return = True


# doc8 configuration:
#  https://pypi.org/project/doc8/
[doc8]
ignore-path = docs/build
max-line-length = 119
sphinx = True


# py.test configuration:
#  http://doc.pytest.org/en/latest/customize.html
[tool:pytest]
# directories that are not visited by pytest collector:
norecursedirs = *.egg .eggs dist build docs .tox .git __pycache__
doctest_optionflags = NUMBER NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL
filterwarnings =
  ignore::DeprecationWarning
addopts =
  --strict-markers
  --doctest-modules