refactor: split long functions into smaller functions (#318)

* refactor: split long functions/methods into smaller functions

* Use TokenInfo objects directly instead of tuples with attributes from TokenInfo objects.
* Move non-formatting functions to other modules.
* Add functions to determine number of blank lines after docstring for modules, classes, functions, and attributes.
* Add function to update the token indices after removing unnecessary blank lines.
* Add method to insert appropriate number of blank lines after each type of docstring.

* refactor: add new module with functions for classifying docstring types

* refactor: add new module with constant values

* refactor: add new module with functions for detecting various types of patterns

* refactor: add new module with functions for wrapping various elements

* refactor: move string manipulation functions from syntax module

* refactor: add function to have field lists take precedence over URL strings

* chore: add copyright info for new maintainer

* refactor: rename attributes

* chore: add integration test mark

* test: update and add tests for format module

* test: update and add tests for encoding module

* test: update and add tests for string module

* test: update and add tests for utility module

* test: update and add tests for configuration module

* test: update and add tests for docformatter end-to-end

* test: add tests for classify module

* test: add tests for classify module

* test: add tests for wrapper package

* test: update end-to-end tests

* test: update expected value for all Python versions

Author: weibullguy

poetry.lock

@@ -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"
@@ -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.",
 ]
 
@@ -216,6 +218,7 @@ deps =
     mock
     pytest
     pytest-cov
+    pytest-order
     tomli
     untokenize
 setenv =
@@ -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 \

pyproject.toml

@@ -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
@@ -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

src/docformatter/__init__.py

@@ -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
@@ -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.

src/docformatter/__main__.py

@@ -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
@@ -23,4 +26,5 @@
 # SOFTWARE.
 """Package information for docformatter."""
 
+
 __version__ = "1.7.7"