Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
75caaf3
refactor: split long functions/methods into smaller functions
weibullguy Jul 23, 2025
a31913c
refactor: add new module with functions for classifying docstring types
weibullguy Jul 23, 2025
86ffee2
refactor: add new module with constant values
weibullguy Jul 23, 2025
9f45b29
refactor: add new module with functions for detecting various types o…
weibullguy Jul 23, 2025
3e931a1
refactor: add new module with functions for wrapping various elements
weibullguy Jul 23, 2025
b9585ad
refactor: move string manipulation functions from syntax module
weibullguy Jul 23, 2025
f2e8b9b
refactor: add function to have field lists take precedence over URL s…
weibullguy Jul 23, 2025
b3b1fef
chore: add copyright info for new maintainer
weibullguy Jul 23, 2025
b0cefed
refactor: rename attributes
weibullguy Jul 23, 2025
13c63d2
chore: add integration test mark
weibullguy Jul 23, 2025
745df98
test: update and add tests for format module
weibullguy Jul 23, 2025
b48500f
test: update and add tests for encoding module
weibullguy Jul 23, 2025
f603911
test: update and add tests for string module
weibullguy Jul 23, 2025
11bfcef
test: update and add tests for utility module
weibullguy Jul 23, 2025
334e63a
test: update and add tests for configuration module
weibullguy Jul 23, 2025
31234bf
test: update and add tests for docformatter end-to-end
weibullguy Jul 23, 2025
913fb68
test: add tests for classify module
weibullguy Jul 23, 2025
4e35da7
test: add tests for classify module
weibullguy Jul 23, 2025
134e559
test: add tests for wrapper package
weibullguy Jul 23, 2025
0067592
test: update end-to-end tests
weibullguy Jul 23, 2025
a3d760d
test: update expected value for all Python versions
weibullguy Jul 23, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
246 changes: 132 additions & 114 deletions poetry.lock

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ coverage = {extras = ["toml"], version = "^6.4.0"}
mock = "^4.0.0"
pytest = "^7.1.0"
pytest-cov = "^4.0.0"
pytest-order = "^1.3.0"

[tool.poetry.group.linting.dependencies]
autopep8 = "^2.0.0"
Expand Down Expand Up @@ -107,6 +108,7 @@ convention = "pep257"
[tool.pytest.ini_options]
markers = [
"unit: mark the test as a unit test.",
"integration: mark the test as an integration test.",
"system: mark the test as a system test.",
]

Expand Down Expand Up @@ -216,6 +218,7 @@ deps =
mock
pytest
pytest-cov
pytest-order
tomli
untokenize
setenv =
Expand All @@ -230,6 +233,13 @@ commands =
--cov-config={toxinidir}/pyproject.toml \
--cov-branch \
{toxinidir}/tests/
pytest -s -x -c {toxinidir}/pyproject.toml \
-m integration \
--cache-clear \
--cov=docformatter \
--cov-config={toxinidir}/pyproject.toml \
--cov-branch \
{toxinidir}/tests/
pytest -s -x -c {toxinidir}/pyproject.toml \
-m system \
--cache-clear \
Expand Down
11 changes: 9 additions & 2 deletions src/docformatter/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
#!/usr/bin/env python
#
# docformatter.__init__.py is part of the docformatter project
#
# Copyright (C) 2012-2023 Steven Myint
# Copyright (C) 2023-2025 Doyle "weibullguy" Rowland
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
Expand All @@ -23,15 +26,19 @@
# SOFTWARE.
"""This is the docformatter package."""


__all__ = ["__version__"]

# docformatter Local Imports
from .__pkginfo__ import __version__
from .classify import * # noqa F403
from .format import FormatResult # noqa F403
from .format import Formatter # noqa F401
from .patterns import * # noqa F403
from .strings import * # noqa F403
from .syntax import * # noqa F403
from .util import * # noqa F403
from .wrappers import * # noqa F403

# Have isort skip these they require the functions above.
from .configuration import Configurater # isort: skip # noqa F401
from .encode import Encoder # isort: skip # noqa F401
from .format import Formatter, FormatResult # isort: skip # noqa F401
5 changes: 4 additions & 1 deletion src/docformatter/__main__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
#!/usr/bin/env python
#
# docformatter.__main__.py is part of the docformatter project
#
# Copyright (C) 2012-2023 Steven Myint
# Copyright (C) 2023-2025 Doyle "weibullguy" Rowland
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
Expand Down Expand Up @@ -135,7 +138,7 @@ def _main(argv, standard_out, standard_error, standard_in):


def main():
"""Run main entry point."""
"""Run the main entry point."""
# SIGPIPE is not available on Windows.
with contextlib.suppress(AttributeError):
# Exit on broken pipe.
Expand Down
4 changes: 4 additions & 0 deletions src/docformatter/__pkginfo__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
#!/usr/bin/env python
#
# docformatter.patterns.__pkginfo__.py is part of the docformatter project
#
# Copyright (C) 2012-2023 Steven Myint
# Copyright (C) 2023-2025 Doyle "weibullguy" Rowlans
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
Expand All @@ -23,4 +26,5 @@
# SOFTWARE.
"""Package information for docformatter."""


__version__ = "1.7.7"
Loading
Loading