.deepsource.toml
configuration specific to the python
analyzer. Please make sure to read the general configuration guide first.
name
meta
runtime_version
max_line_length
79
88
skip_doc_coverage
module
, magic
, init
and class
module
- Ignore module docstringsmagic
- Ignore docstrings of magic methods (except “init”)init
- Ignore docstrings of “init” methodsclass
- Ignore docstrings of class definitionsnonpublic
- Ignore docstrings for non-public classes and methodstype_checker
additional_builtins
cyclomatic_complexity_threshold
low
will flag all functions that have a cyclomatic complexity of more than 5
, while setting the threshold to critical
will not flag any function.low
, medium
, high
, very-high
and critical
Risk category | Cyclomatic complexity range | Recommended action |
---|---|---|
low | 1-5 | No action is needed. |
medium | 6-15 | Review and monitor. |
high | 16-25 | Review and refactor. Recommended to add detailed comments if the function absolutely needs to be kept as it is. |
very-high | 26-50 | Refactor to reduce the complexity. |
critical | >50 | Must refactor this. This can make the code untestable and very difficult to understand. |
medium
.coveragerc
:
tox.ini
for multiple Python versions:
autopep8
.deepsource.toml
configuration specific to the autopep8
transformer. Please make sure to read the general configuration guide first.
black
.deepsource.toml
configuration specific to the autopep8
transformer. Please make sure to read the general configuration guide first.
isort
.deepsource.toml
configuration specific to the isort
transformer. Please make sure to read the general configuration guide first.
.deepsource.toml
configuration specific to the ruff
transformer. Please make sure to read the general configuration guide first.
yapf
.deepsource.toml
configuration specific to the yapf
transformer. Please make sure to read the general configuration guide first.
Pipfile
Pipfile.lock
poetry.lock
pyproject.toml
(if containing a [tool.poetry]
or [tool.flit]
section)requirements.txt
setup.py
uv.lock