Make formatting private

Author: DanielNoord

pydocstringformatter/_configuration/arguments_manager.py

@@ -8,7 +8,7 @@
     toml_parsing,
 )
 from pydocstringformatter._configuration.validators import VALIDATORS
-from pydocstringformatter.formatting.base import Formatter
+from pydocstringformatter._formatting.base import Formatter
 
 
 class ArgumentsManager:

pydocstringformatter/_configuration/formatter_options.py

@@ -5,7 +5,7 @@
 from pydocstringformatter._configuration.boolean_option_action import (
     BooleanOptionalAction,
 )
-from pydocstringformatter.formatting.base import Formatter
+from pydocstringformatter._formatting.base import Formatter
 
 
 def _register_arguments_formatters(

pydocstringformatter/formatting/__init__.py renamed to pydocstringformatter/_formatting/__init__.py

@@ -3,8 +3,8 @@
 __all__ = ["FORMATTERS", "Formatter"]
 
 
-from pydocstringformatter.formatting.base import Formatter
-from pydocstringformatter.formatting.formatter import (
+from pydocstringformatter._formatting.base import Formatter
+from pydocstringformatter._formatting.formatter import (
     BeginningQuotesFormatter,
     CapitalizeFirstLetterFormatter,
     ClosingQuotesFormatter,

pydocstringformatter/formatting/_utils.py renamed to pydocstringformatter/_formatting/_utils.py

@@ -5,8 +5,8 @@
 import tokenize
 from typing import Literal
 
-from pydocstringformatter.formatting import _utils
-from pydocstringformatter.formatting.base import (
+from pydocstringformatter._formatting import _utils
+from pydocstringformatter._formatting.base import (
     StringAndQuotesFormatter,
     StringFormatter,
     SummaryFormatter,

pydocstringformatter/formatting/base.py renamed to pydocstringformatter/_formatting/base.py

@@ -8,7 +8,7 @@
 import pytest
 
 from pydocstringformatter import run_docstring_formatter
-from pydocstringformatter.formatting import Formatter
+from pydocstringformatter._formatting import Formatter
 
 LOGGER = logging.getLogger(__name__)
 

pydocstringformatter/formatting/formatter.py renamed to pydocstringformatter/_formatting/formatter.py

@@ -7,7 +7,7 @@
 import tokenize
 from pathlib import Path
 
-from pydocstringformatter import __version__, _utils, formatting
+from pydocstringformatter import __version__, _formatting, _utils
 from pydocstringformatter._configuration.arguments_manager import ArgumentsManager
 
 
@@ -16,7 +16,7 @@ class _Run:
 
     def __init__(self, argv: list[str] | None) -> None:
         # Load ArgumentsManager and set its namespace as instance's config attribute
-        self._arguments_manager = ArgumentsManager(__version__, formatting.FORMATTERS)
+        self._arguments_manager = ArgumentsManager(__version__, _formatting.FORMATTERS)
         self.config = self._arguments_manager.namespace
 
         # Display help message if nothing is passed
@@ -26,7 +26,7 @@ def __init__(self, argv: list[str] | None) -> None:
 
         # Parse options and register on formatters
         self._arguments_manager.parse_options(argv)
-        for formatter in formatting.FORMATTERS:
+        for formatter in _formatting.FORMATTERS:
             formatter.set_config_namespace(self.config)
 
         self._check_files(self.config.files)
@@ -70,7 +70,7 @@ def _format_file(self, filename: Path) -> bool:
             new_tokeninfo = tokeninfo
 
             if _utils._is_docstring(new_tokeninfo, tokens[index - 1]):
-                for formatter in formatting.FORMATTERS:
+                for formatter in _formatting.FORMATTERS:
                     if getattr(self.config, formatter.name):
                         new_tokeninfo = formatter.treat_token(new_tokeninfo)
             changed_tokens.append(new_tokeninfo)

pydocstringformatter/_testutils/__init__.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from pydocstringformatter.formatting import FORMATTERS
+from pydocstringformatter._formatting import FORMATTERS
 
 
 def test_formatter_names() -> None:

pydocstringformatter/run.py

@@ -7,10 +7,10 @@
 import pytest
 
 import pydocstringformatter
+from pydocstringformatter._formatting import FORMATTERS
+from pydocstringformatter._formatting.base import StringFormatter
+from pydocstringformatter._formatting.formatter import SplitSummaryAndDocstringFormatter
 from pydocstringformatter._testutils import FormatterAsserter
-from pydocstringformatter.formatting import FORMATTERS
-from pydocstringformatter.formatting.base import StringFormatter
-from pydocstringformatter.formatting.formatter import SplitSummaryAndDocstringFormatter
 
 
 def test_no_arguments(capsys: pytest.CaptureFixture[str]) -> None: