Make utils private

Author: DanielNoord

pydocstringformatter/__init__.py

@@ -3,7 +3,7 @@
 
 import sys
 
-from pydocstringformatter.utils.exceptions import (
+from pydocstringformatter._utils.exceptions import (
     ParsingError,
     PydocstringFormatterError,
 )

pydocstringformatter/_configuration/toml_parsing.py

@@ -6,7 +6,7 @@
 
 import tomli
 
-from pydocstringformatter.utils.exceptions import TomlParsingError, UnrecognizedOption
+from pydocstringformatter._utils.exceptions import TomlParsingError, UnrecognizedOption
 
 OPTIONS_TYPES: Final = {"write": "store_true", "exclude": "store"}
 

pydocstringformatter/_utils/__init__.py

@@ -0,0 +1,20 @@
+from pydocstringformatter._utils.exceptions import (
+    ParsingError,
+    PydocstringFormatterError,
+    TomlParsingError,
+)
+from pydocstringformatter._utils.file_diference import _generate_diff
+from pydocstringformatter._utils.find_docstrings import _is_docstring
+from pydocstringformatter._utils.find_python_file import _find_python_files
+from pydocstringformatter._utils.output import _print_to_console, _sys_exit
+
+__all__ = [
+    "_find_python_files",
+    "_generate_diff",
+    "_is_docstring",
+    "ParsingError",
+    "PydocstringFormatterError",
+    "TomlParsingError",
+    "_print_to_console",
+    "_sys_exit",
+]

pydocstringformatter/utils/exceptions.py renamed to pydocstringformatter/_utils/exceptions.py

@@ -7,7 +7,7 @@
 import tokenize
 from pathlib import Path
 
-from pydocstringformatter import __version__, formatting, utils
+from pydocstringformatter import __version__, _utils, formatting
 from pydocstringformatter._configuration.arguments_manager import ArgumentsManager
 
 
@@ -34,21 +34,21 @@ def __init__(self, argv: list[str] | None) -> None:
     # pylint: disable-next=inconsistent-return-statements
     def _check_files(self, files: list[str]) -> None:
         """Find all files and perform the formatting."""
-        filepaths = utils._find_python_files(files, self.config.exclude)
+        filepaths = _utils._find_python_files(files, self.config.exclude)
 
         is_changed = self._format_files(filepaths)
 
         if is_changed:  # pylint: disable=consider-using-assignment-expr
-            return utils._sys_exit(32, self.config.exit_code)
+            return _utils._sys_exit(32, self.config.exit_code)
 
         files_string = f"{len(filepaths)} "
         files_string += "files" if len(filepaths) != 1 else "file"
-        utils._print_to_console(
+        _utils._print_to_console(
             f"Nothing to do! All docstrings in {files_string} are correct 🎉\n",
             self.config.quiet,
         )
 
-        utils._sys_exit(0, self.config.exit_code)
+        _utils._sys_exit(0, self.config.exit_code)
 
     def _format_file(self, filename: Path) -> bool:
         """Format a file."""
@@ -59,7 +59,7 @@ def _format_file(self, filename: Path) -> bool:
             try:
                 tokens = list(tokenize.generate_tokens(file.readline))
             except tokenize.TokenError as exc:
-                raise utils.ParsingError(
+                raise _utils.ParsingError(
                     f"Can't parse {os.path.relpath(filename)}. Is it valid Python code?"
                 ) from exc
             # Record type of newlines so we can make sure to use
@@ -69,7 +69,7 @@ def _format_file(self, filename: Path) -> bool:
         for index, tokeninfo in enumerate(tokens):
             new_tokeninfo = tokeninfo
 
-            if utils._is_docstring(new_tokeninfo, tokens[index - 1]):
+            if _utils._is_docstring(new_tokeninfo, tokens[index - 1]):
                 for formatter in formatting.FORMATTERS:
                     if getattr(self.config, formatter.name):
                         new_tokeninfo = formatter.treat_token(new_tokeninfo)
@@ -96,12 +96,12 @@ def _format_file(self, filename: Path) -> bool:
                     )
                 with open(filename, "w", encoding="utf-8", newline=newlines) as file:
                     file.write(tokenize.untokenize(changed_tokens))
-                    utils._print_to_console(
+                    _utils._print_to_console(
                         f"Formatted {filename_str} 📖\n", self.config.quiet
                     )
             else:
                 sys.stdout.write(
-                    utils._generate_diff(
+                    _utils._generate_diff(
                         tokenize.untokenize(tokens),
                         tokenize.untokenize(changed_tokens),
                         filename_str,