Delete docstrings

src/screener/__main__.py

@@ -1,5 +1,3 @@
-"""Screener entry-point script."""
-
 import sys
 from argparse import ArgumentParser
 from pathlib import Path
@@ -10,7 +8,6 @@
 
 
 def init_argparse() -> ArgumentParser:
-    """Create argument parser for system args."""
     parser = ArgumentParser(
         prog="screener",
         usage="%(prog)s [OPTION] [FILE]...",
@@ -27,7 +24,6 @@ def init_argparse() -> ArgumentParser:
 
 
 def check_file(file: Path) -> Checker:
-    """Check file."""
     checker = Checker(file)
     match extension := file.suffix:
         case ".epub":
@@ -43,7 +39,6 @@ def check_file(file: Path) -> Checker:
 
 
 def main() -> None:
-    """Read system args and check e-book files."""
     parser = init_argparse()
     args = parser.parse_args()
     if not args.files:

src/screener/checker.py

@@ -1,5 +1,3 @@
-"""Checker class for checking the data."""
-
 from dataclasses import dataclass, field
 from pathlib import Path
 
@@ -8,7 +6,5 @@
 
 @dataclass
 class Checker:
-    """Checker class for checking the data."""
-
     file_path: Path
     diagnostics: list[Diagnostic] = field(default_factory=list)

src/screener/diagnostic.py

@@ -1,23 +1,16 @@
-"""Diagnostic information about a file."""
-
 from dataclasses import dataclass
 
 
 @dataclass
 class Diagnostic:
-    """Diagnostic information about a file."""
-
     file_name: str
 
 
 @dataclass
 class JavaScriptDiagnostic(Diagnostic):
-    """Diagnostic information about a file with JavaScript."""
-
     culprit: str
 
     def __str__(self) -> str:
-        """Return a string representation of the diagnostic."""
         return (
             f"JavaScript found in {self.file_name}: {self.culprit}"
             if self.culprit
@@ -27,12 +20,9 @@ def __str__(self) -> str:
 
 @dataclass
 class ExternalImageDiagnostic(Diagnostic):
-    """Diagnostic information about a file with external images."""
-
     culprit: str
 
     def __str__(self) -> str:
-        """Return a string representation of the diagnostic."""
         return (
             f"External images found in {self.file_name}: {self.culprit}"
             if self.culprit
@@ -42,6 +32,4 @@ def __str__(self) -> str:
 
 @dataclass
 class ParseErrorDiagnostic(Diagnostic):
-    """Diagnostic information about a file that could not be parsed."""
-
     msg: str

src/screener/parser/__init__.py

@@ -1,5 +1,3 @@
-"""Parse ebook files in different formats."""
-
 from .epub import parse_epub
 from .kindle import parse_kindle
 

src/screener/parser/epub.py

@@ -1,5 +1,3 @@
-"""Parse epub file to check that it is safe."""
-
 from pathlib import Path
 
 from ebooklib import ITEM_DOCUMENT
@@ -16,10 +14,6 @@ def parse_epub(
     checker: Checker,
     path_to_epub: Path,
 ) -> None:
-    """Parse epub to check that it is safe.
-
-    Mutates the checker object to add diagnostics.
-    """
     with EpubFileReader(path_to_epub) as epub:
         for item in epub.book.get_items_of_type(ITEM_DOCUMENT):
             content = item.get_content()

src/screener/parser/kindle.py

@@ -1,5 +1,3 @@
-"""Parse kindle files."""
-
 from pathlib import Path
 
 from screener.checker import Checker
@@ -12,7 +10,6 @@ def parse_kindle(
     checker: Checker,
     path_to_kindle: Path | None,
 ) -> None:
-    """Parse kindle to check that it is safe."""
     if path_to_kindle is None:
         msg = "path_to_kindle cannot be None"
         raise ValueError(msg)

src/screener/reader/__init__.py

@@ -1,5 +1,3 @@
-"""Read epub files."""
-
 from .epub import EpubFileReader
 from .kindle import KindleFileReader
 

src/screener/reader/abstract.py

@@ -1,5 +1,3 @@
-"""Abstract reader class."""
-
 from __future__ import annotations
 
 from typing import TYPE_CHECKING
@@ -10,20 +8,15 @@
 
 
 class AbstractReader:
-    """Abstract class for reader classes."""
-
     def __init__(self: AbstractReader, file_path: Path) -> None:
-        """Initialize the class."""
         self.file_path = file_path
 
     def __enter__(self: AbstractReader) -> AbstractReader:
-        """Virtual method to be overridden by subclasses."""
         raise NotImplementedError
 
     def __exit__(
         self: AbstractReader,
         exc_type: type[BaseException] | None,
         exc_val: BaseException | None,
         exc_tb: TracebackType | None,
-    ) -> None:
-        """Run on exit of runtime context."""
+    ) -> None: ...

src/screener/reader/epub.py

@@ -1,5 +1,3 @@
-"""Read epub files."""
-
 from __future__ import annotations
 
 import warnings
@@ -14,15 +12,11 @@
 
 
 class EpubFileReader(AbstractReader):
-    """Handle epub files."""
-
     def __init__(self: EpubFileReader, file_path: Path) -> None:
-        """Initialize the class."""
         super().__init__(file_path)
         self.book: epub.EpubBook
 
     def __enter__(self: EpubFileReader) -> EpubFileReader:
-        """Runtime context."""
         with warnings.catch_warnings():
             # Have to do this because of bug in ebooklib.
             warnings.simplefilter("ignore")

src/screener/reader/kindle.py

@@ -1,5 +1,3 @@
-"""Contains methods to check a Kindle e-book file for security and privacy issues."""
-
 from __future__ import annotations
 
 import shutil
@@ -15,16 +13,12 @@
 
 
 class KindleFileReader(AbstractReader):
-    """Handle azw3 files."""
-
     def __init__(self: KindleFileReader, file_path: Path) -> None:
-        """Initialize the class."""
         super().__init__(file_path)
         self._temp_dir = None
         self.generated_translation = None
 
     def __enter__(self: KindleFileReader) -> KindleFileReader:
-        """Runtime context."""
         # The `mobi` library likes file paths as strings for whatever reason.
         self._temp_dir, self.generated_translation = extract(str(self.file_path))
         if self.generated_translation is None or self._temp_dir is None:
@@ -38,6 +32,5 @@ def __exit__(
         exc_val: BaseException | None,
         exc_tb: TracebackType | None,
     ) -> None:
-        """Delete temp files."""
         if self._temp_dir is not None:
             shutil.rmtree(self._temp_dir)

src/screener/utils.py

@@ -1,5 +1,3 @@
-"""Screener utility functions."""
-
 from bs4 import BeautifulSoup
 
 from screener.checker import Checker