Format codebase with FinalPeriodFormatter

Author: DanielNoord

pydocstringformatter/__init__.py

@@ -12,7 +12,7 @@
 
 
 def run_docstring_formatter(argv: Union[List[str], None] = None) -> None:
-    """Run the formatter"""
+    """Run the formatter."""
     from pydocstringformatter.run import _Run
 
     _Run(argv or sys.argv[1:])

pydocstringformatter/formatting/formatter.py

@@ -5,7 +5,7 @@
 
 
 class BeginningQuotesFormatter(StringFormatter):
-    """Fix the position of the opening quotes"""
+    """Fix the position of the opening quotes."""
 
     name = "beginning-quotes"
 
@@ -17,12 +17,12 @@ def _treat_string(self, tokeninfo: tokenize.TokenInfo) -> str:
 
 
 class ClosingQuotesFormatter(StringFormatter):
-    """Fix the position of the closing quotes"""
+    """Fix the position of the closing quotes."""
 
     name = "closing-quotes"
 
     def _treat_string(self, tokeninfo: tokenize.TokenInfo) -> str:
-        """Fix the position of end quotes for multi-line docstrings"""
+        """Fix the position of end quotes for multi-line docstrings."""
         new_string = tokeninfo.string
         if "\n" not in new_string:
             # Not a multiline docstring, nothing to do

pydocstringformatter/run.py

@@ -1,5 +1,5 @@
 # pylint: disable=too-few-public-methods, protected-access
-"""Run class"""
+"""Run class."""
 
 import argparse
 import os
@@ -12,7 +12,7 @@
 
 
 class _Run:
-    """Main class that represent a run of the program"""
+    """Main class that represent a run of the program."""
 
     def __init__(self, argv: Union[List[str], None]) -> None:
         self.arg_parser = utils._register_arguments(__version__)
@@ -27,12 +27,12 @@ def __init__(self, argv: Union[List[str], None]) -> None:
             self.arg_parser.print_help()
 
     def _check_files(self, arguments: List[str]) -> None:
-        """Find all files and perform the formatting"""
+        """Find all files and perform the formatting."""
         filepaths = utils._find_python_files(arguments)
         self._format_files(filepaths)
 
     def _format_file(self, filename: Path) -> bool:
-        """Format a file"""
+        """Format a file."""
         changed_tokens: List[tokenize.TokenInfo] = []
         is_changed = False
 
@@ -78,7 +78,7 @@ def _format_file(self, filename: Path) -> bool:
         return is_changed
 
     def _format_files(self, filepaths: List[Path]) -> None:
-        """Format a list of files"""
+        """Format a list of files."""
         is_changed = False
 
         for file in filepaths:

pydocstringformatter/utils/argument_parsing.py

@@ -12,12 +12,12 @@
 def _parse_command_line_arguments(
     parser: argparse.ArgumentParser, args: List[str], namespace: argparse.Namespace
 ) -> None:
-    """Parse all arguments on the provided argument parser"""
+    """Parse all arguments on the provided argument parser."""
     parser.parse_known_args(args, namespace)
 
 
 def _register_arguments(version: str) -> argparse.ArgumentParser:
-    """Create an argument parser and add all supported arguments"""
+    """Create an argument parser and add all supported arguments."""
     parser = argparse.ArgumentParser(prog="pydocstringformatter")
 
     parser.add_argument("files", nargs="*", type=str)
@@ -41,7 +41,7 @@ def _register_arguments(version: str) -> argparse.ArgumentParser:
 
 
 def _get_toml_file() -> Optional[Dict[str, Any]]:
-    """See if there is a pyproject.toml and extract the correct section if it exists"""
+    """See if there is a pyproject.toml and extract the correct section if it exists."""
     if os.path.isfile("pyproject.toml"):
         with open("pyproject.toml", "rb") as file:
             try:
@@ -56,7 +56,7 @@ def _get_toml_file() -> Optional[Dict[str, Any]]:
 
 
 def _parse_toml_option(opt: str, value: Any) -> List[str]:
-    """Parse an options value in the correct argument type for argparse"""
+    """Parse an options value in the correct argument type for argparse."""
     try:
         action = OPTIONS_TYPES[opt]
     except KeyError as exc:
@@ -72,7 +72,7 @@ def _parse_toml_option(opt: str, value: Any) -> List[str]:
 def _parse_toml_file(
     parser: argparse.ArgumentParser, namespace: argparse.Namespace
 ) -> None:
-    """Get and parse the relevant section form a pyproject.toml file"""
+    """Get and parse the relevant section form a pyproject.toml file."""
     if toml_sect := _get_toml_file():
         arguments: List[str] = []
 

pydocstringformatter/utils/exceptions.py

@@ -1,14 +1,14 @@
 class PydocstringFormatterError(Exception):
-    """Base class to inherit all exceptions from"""
+    """Base class to inherit all exceptions from."""
 
 
 class ParsingError(PydocstringFormatterError):
-    """Raised when we the parsing of a file failed"""
+    """Raised when we the parsing of a file failed."""
 
 
 class UnrecognizedOption(PydocstringFormatterError):
-    """Raised when an option is encountered that is not recognized"""
+    """Raised when an option is encountered that is not recognized."""
 
 
 class TomlParsingError(PydocstringFormatterError):
-    """Raised when there are errors with the parsing of the toml file"""
+    """Raised when there are errors with the parsing of the toml file."""

pydocstringformatter/utils/find_docstrings.py

@@ -7,7 +7,7 @@
 def _is_docstring(
     tokeninfo: tokenize.TokenInfo, previous_token: tokenize.TokenInfo
 ) -> bool:
-    """Check if a token represents a docstring"""
+    """Check if a token represents a docstring."""
     if (
         tokeninfo.type == token.STRING
         and (

pydocstringformatter/utils/find_python_file.py

@@ -4,12 +4,12 @@
 
 
 def _is_python_file(filename: str) -> bool:
-    """Check if file is a Python file"""
+    """Check if file is a Python file."""
     return filename.endswith(".py")
 
 
 def _find_python_files(filenames: List[str], recursive: bool = True) -> List[Path]:
-    """Find all python files for a list of potential file and directory names"""
+    """Find all python files for a list of potential file and directory names."""
     pathnames: List[Path] = []
 
     for name in filenames: