vim-eof-comment 0.5.3__py3-none-any.whl → 0.6.0__py3-none-any.whl

vim_eof_comment/args/completion.py

@@ -8,7 +8,7 @@ Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 __all__ = ["complete_parser", "complete_validator"]
 
 from argparse import ArgumentParser
-from typing import List, NoReturn
+from typing import List
 
 from argcomplete import autocomplete
 
@@ -32,7 +32,7 @@ def complete_validator(completion_candidate: List[str], current_input: str) -> b
     return current_input in completion_candidate
 
 
-def complete_parser(parser: ArgumentParser, **kwargs) -> NoReturn:
+def complete_parser(parser: ArgumentParser, **kwargs) -> None:
     """
     Complete the script argument parser.
 

vim_eof_comment/args/completion.pyi

@@ -1,5 +1,4 @@
 from argparse import ArgumentParser
-from typing import NoReturn
 
 __all__ = ['complete_parser', 'complete_validator']
 
@@ -19,7 +18,7 @@ def complete_validator(completion_candidate: list[str], current_input: str) -> b
     bool
         Whether the current input fits the completion candidates pool.
     """
-def complete_parser(parser: ArgumentParser, **kwargs) -> NoReturn:
+def complete_parser(parser: ArgumentParser, **kwargs) -> None:
     """
     Complete the script argument parser.
 

vim_eof_comment/args/parsing.py

@@ -51,9 +51,9 @@ def bootstrap_args(parser: ArgumentParser, specs: List[ParserSpec]) -> Namespace
         The generated ``argparse.Namespace`` object.
     """
     for spec in specs:
-        opts, kwargs = spec["opts"], spec["kwargs"]
-        if spec["completer"] is not None:
-            parser.add_argument(*opts, **kwargs).completer = spec["completer"]
+        opts, kwargs = spec.opts, spec.kwargs
+        if spec.completer is not None:
+            parser.add_argument(*opts, **kwargs).completer = spec.completer
         else:
             parser.add_argument(*opts, **kwargs)
 

vim_eof_comment/comments/generator.py

@@ -17,7 +17,7 @@ import json
 import os
 from io import TextIOWrapper
 from os.path import exists, isdir, realpath
-from typing import Dict, Iterator, List, NoReturn, Tuple
+from typing import Dict, Iterator, List, Tuple
 
 from colorama import Fore, Style
 from colorama import init as color_init
@@ -119,9 +119,9 @@ class Comments():
             if not (self.__is_available(lang)) or len(mapping) == 0:
                 continue
 
-            indent, expandtab = mapping["level"], True
+            indent, expandtab = mapping.level, True
             if len(mapping) > 1:
-                expandtab = mapping["expandtab"]
+                expandtab = mapping.expandtab
 
             langs[lang] = IndentMap(level=indent, expandtab=expandtab)
 
@@ -148,7 +148,7 @@ class Comments():
         """
         return lang in self.__DEFAULT.keys()
 
-    def __fill_langs(self, langs: Dict[str, IndentMap]) -> NoReturn:
+    def __fill_langs(self, langs: Dict[str, IndentMap]) -> None:
         """
         Fill languages dict.
 
@@ -242,7 +242,7 @@ def generate_list_items(ft: str, level: int, expandtab: str) -> str:
     return txt
 
 
-def list_filetypes() -> NoReturn:
+def list_filetypes() -> None:
     """List all available filetypes."""
     color_init()
 
@@ -262,7 +262,7 @@ def list_filetypes() -> NoReturn:
     die(*txt, code=0, sep="\n")
 
 
-def export_json() -> NoReturn:
+def export_json() -> None:
     """Export default vars to JSON."""
     if not (exists("./vim_eof_comment/comments") and isdir("./vim_eof_comment/comments")):
         return

vim_eof_comment/comments/generator.pyi

@@ -1,4 +1,4 @@
-from typing import Iterator, NoReturn
+from typing import Iterator
 
 from ..types import IndentMap
 
@@ -72,7 +72,7 @@ class Comments:
         bool
             Represents whether the file extension has been included in the defaults.
         """
-    def __fill_langs(self, langs: dict[str, IndentMap]) -> NoReturn:
+    def __fill_langs(self, langs: dict[str, IndentMap]) -> None:
         """
         Fill languages dict.
 
@@ -132,9 +132,9 @@ def generate_list_items(ft: str, level: int, expandtab: str) -> str:
     str
         The generated string.
     '''
-def list_filetypes() -> NoReturn:
+def list_filetypes() -> None:
     """List all available filetypes."""
-def export_json() -> NoReturn:
+def export_json() -> None:
     """Export default vars to JSON."""
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

vim_eof_comment/eof.py

@@ -9,7 +9,7 @@ Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 __all__ = ["append_eof_comment", "eof_comment_search", "main"]
 
 from io import TextIOWrapper
-from typing import Dict, List, NoReturn, Tuple
+from typing import Dict, List, Tuple
 
 from colorama import Fore, Style
 from colorama import init as color_init
@@ -67,17 +67,17 @@ def eof_comment_search(
 
     verbose_print(f"{_RESET}Analyzing files...\n", verbose=verbose)
     for path, file in files.items():
-        file_obj: TextIOWrapper = file["file"]
-        ext: str = file["ft_ext"]
+        file_obj: TextIOWrapper = file.file
+        ext: str = file.ft_ext
 
         wrapper = get_last_line(file_obj)
-        last_line, had_nwl, crlf = wrapper["line"], wrapper["had_nwl"], wrapper["crlf"]
+        last_line, had_nwl, crlf = wrapper.line, wrapper.had_nwl, wrapper.crlf
 
         verbose_print(f"{_RESET} - {path} ==> ", verbose=verbose, end="", sep="")
         if last_line != comment_map[ext] or (newline and not had_nwl):
             verbose_print(f"{_BRIGHT}{_RED}CHANGED", verbose=verbose)
             result[path] = EOFCommentSearch(
-                state=IOWrapperBool(file=open(path, "r"), had_nwl=had_nwl),
+                state=IOWrapperBool(file=open(path, "r"), had_nwl=had_nwl, crlf=crlf),
                 lang=ext,
                 match=matches(last_line)
             )
@@ -92,7 +92,7 @@ def append_eof_comment(
     comments: Comments,
     newline: bool,
     crlf: bool
-) -> NoReturn:
+) -> None:
     """
     Append a Vim EOF comment to files missing it.
 
@@ -109,10 +109,10 @@ def append_eof_comment(
     """
     comment_map = comments.generate()
     for path, file in files.items():
-        file_obj = file["state"]["file"]
-        had_nwl = file["state"]["had_nwl"]
-        matching = file["match"]
-        ext = file["lang"]
+        file_obj = file.state.file
+        had_nwl = file.state.had_nwl
+        matching = file.match
+        ext = file.lang
 
         txt = modify_file(
             file_obj,

vim_eof_comment/eof.pyi

@@ -1,5 +1,3 @@
-from typing import NoReturn
-
 from .comments.generator import Comments
 from .types import BatchPathDict, EOFCommentSearch
 
@@ -30,7 +28,7 @@ def eof_comment_search(files: dict[str, BatchPathDict], comments: Comments, **kw
     vim_eof_comment.types.EOFCommentSearch
         The object type for the returning dictionary values.
     """
-def append_eof_comment(files: dict[str, EOFCommentSearch], comments: Comments, newline: bool, crlf: bool) -> NoReturn:
+def append_eof_comment(files: dict[str, EOFCommentSearch], comments: Comments, newline: bool, crlf: bool) -> None:
     """
     Append a Vim EOF comment to files missing it.
 

vim_eof_comment/file.py

@@ -6,6 +6,7 @@ File management utilities.
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
 __all__ = [
+    "EXCLUDED_DIRS",
     "bootstrap_paths",
     "get_last_line",
     "modify_file",
@@ -108,7 +109,7 @@ def open_batch_paths(paths: List[BatchPairDict]) -> Dict[str, BatchPathDict]:
     """
     result: Dict[str, BatchPathDict] = dict()
     for path in paths:
-        fpath, ext = path["fpath"], path["ft_ext"]
+        fpath, ext = path.fpath, path.ft_ext
         if not try_open(fpath):
             continue
 

vim_eof_comment/file.pyi

@@ -2,7 +2,9 @@ from io import TextIOWrapper
 
 from .types import BatchPairDict, BatchPathDict, LineBool
 
-__all__ = ['bootstrap_paths', 'get_last_line', 'modify_file', 'open_batch_paths', 'try_open']
+__all__ = ['EXCLUDED_DIRS', 'bootstrap_paths', 'get_last_line', 'modify_file', 'open_batch_paths', 'try_open']
+
+EXCLUDED_DIRS: list[str]
 
 def try_open(fpath: str) -> bool:
     """

vim_eof_comment/types.py

@@ -23,7 +23,7 @@ from typing import Any, Dict, List, TextIO, Tuple, TypedDict
 import argcomplete
 
 
-class VersionInfo():
+class VersionInfo:
     """
     A ``sys.version_info``-like object type.
 
@@ -142,7 +142,6 @@ class VersionInfo():
         if not isinstance(b, VersionInfo):
             return False
 
-        b: VersionInfo = b
         return self.major == b.major and self.minor == b.minor and self.patch == b.patch
 
     def get_current_version(self) -> Tuple[int, int, int]:
@@ -189,11 +188,18 @@ class VersionInfo():
         return result
 
 
-class ParserSpec(TypedDict):
+class ParserSpec:
     """
     Stores the spec for ``argparse`` operations in a constant value.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    opts : List[str]
+        A list containing all the relevant iterations of the same option.
+    kwargs : Dict[str, Any]
+        Extra arguments for ``argparse.ArgumentParser``.
+    completer : argcomplete.DirectoriesCompleter
+        An ``argcomplete`` completer object.
 
     Attributes
     ----------
@@ -209,12 +215,40 @@ class ParserSpec(TypedDict):
     kwargs: Dict[str, Any]
     completer: argcomplete.DirectoriesCompleter
 
+    def __init__(
+        self,
+        opts: List[str],
+        kwargs: Dict[str, Any],
+        completer: argcomplete.DirectoriesCompleter
+    ):
+        self.opts = opts
+        self.kwargs = kwargs
+        self.completer = completer
+
+    def __iterables(self) -> Tuple[List[str], Dict[str, Any], argcomplete.DirectoriesCompleter]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[List[str], Dict[str, Any], argcomplete.DirectoriesCompleter]
+            The ``opts``, ``kwargs`` and ``completer`` attributes.
+        """
+        return (self.opts, self.kwargs, self.completer)
+
+    def __iter__(self):
+        """Iterate over objects."""
+        yield from self.__iterables()
 
-class CommentMap(TypedDict):
+
+class CommentMap:
     """
-    Stores a dict with a ``level`` key.
+    An object containing ``level``.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    level : int
+        The indentation level.
 
     Attributes
     ----------
@@ -224,12 +258,28 @@ class CommentMap(TypedDict):
 
     level: int
 
+    def __init__(self, level: int):
+        self.level = level
+
+    def __iterables(self) -> Tuple[int]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[int]
+            The ``opts`` attribute (inside a tuple).
+        """
+        return (self.level,)
+
+    def __iter__(self):
+        """Iterate over objects."""
+        yield from self.__iterables()
+
 
 class IndentMap(TypedDict):
     """
-    A dict containing ``level`` and ``expandtab`` as keys.
-
-    This is a ``TypedDict``-like object.
+    An object containing ``level`` and ``expandtab``.
 
     Attributes
     ----------
@@ -243,11 +293,18 @@ class IndentMap(TypedDict):
     expandtab: bool
 
 
-class IndentHandler(TypedDict):
+class IndentHandler:
     """
-    A dict containing ``ft_ext``, ``level`` and ``expandtab`` as keys.
+    An object containing ``ft_ext``, ``level`` and ``expandtab``.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    ft_ext : str
+        The file-extension/file-type.
+    level : str
+        The string representation of the indent level.
+    expandtab : bool
+        Whether to expand tabs or not.
 
     Attributes
     ----------
@@ -263,12 +320,39 @@ class IndentHandler(TypedDict):
     level: str
     expandtab: bool
 
+    def __init__(self, ft_ext: str, level: str, expandtab: bool):
+        self.ft_ext = ft_ext
+        self.level = level
+        self.expandtab = expandtab
+
+    def __iterables(self) -> Tuple[str, str, bool]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[str, str, bool]
+            The ``ft_ext``, ``level`` and ``expandtab`` attributes.
+        """
+        return (self.ft_ext, self.level, self.expandtab)
+
+    def __iter__(self):
+        """Iterate over objects."""
+        yield from self.__iterables()
 
-class IOWrapperBool(TypedDict):
+
+class IOWrapperBool:
     """
-    A dict containing ``file``, ``had_nwl`` and ``crlf`` as keys.
+    An object containing ``file``, ``had_nwl`` and ``crlf``.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    file : TextIO
+        The opened file as a ``TextIO`` wrapper.
+    had_nwl : bool
+        Whether the file has a newline or not.
+    crlf : bool
+        Whether the file is CRLF-terminated.
 
     Attributes
     ----------
@@ -284,12 +368,39 @@ class IOWrapperBool(TypedDict):
     had_nwl: bool
     crlf: bool
 
+    def __init__(self, file: TextIO, had_nwl: bool, crlf: bool):
+        self.file = file
+        self.had_nwl = had_nwl
+        self.crlf = crlf
+
+    def __iterables(self) -> Tuple[TextIO, bool, bool]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[TextIO, bool, bool]
+            The ``file``, ``had_nwl`` and ``crlf`` attributes.
+        """
+        return (self.file, self.had_nwl, self.crlf)
+
+    def __iter__(self):
+        """Iterate over objects."""
+        yield from self.__iterables()
+
 
-class LineBool(TypedDict):
+class LineBool:
     """
-    A dict containing ``line``, ``had_nwl`` and ``crlf`` as keys.
+    An object containing ``line``, ``had_nwl`` and ``crlf``.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    line : str
+        The last line of the target file.
+    had_nwl : bool
+        Whether the file has a newline or not.
+    crlf : bool
+        Whether the file is CRLF-terminated.
 
     Attributes
     ----------
@@ -305,12 +416,37 @@ class LineBool(TypedDict):
     had_nwl: bool
     crlf: bool
 
+    def __init__(self, line: str, had_nwl: bool, crlf: bool):
+        self.line = line
+        self.had_nwl = had_nwl
+        self.crlf = crlf
+
+    def __iterables(self) -> Tuple[str, bool, bool]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[str, bool, bool]
+            The ``line``, ``had_nwl`` and ``crlf`` attributes.
+        """
+        return (self.line, self.had_nwl, self.crlf)
+
+    def __iter__(self):
+        """Iterate over objects."""
+        yield from self.__iterables()
 
-class BatchPathDict(TypedDict):
+
+class BatchPathDict:
     """
-    A dict containing ``file`` and ``ft_ext`` as keys.
+    An object containing ``file`` and ``ft_ext``.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    file : TextIO
+        The opened file as a ``TextIO`` wrapper.
+    ft_ext : str
+        The file-type/file-extension.
 
     Attributes
     ----------
@@ -323,12 +459,36 @@ class BatchPathDict(TypedDict):
     file: TextIO
     ft_ext: str
 
+    def __init__(self, file: TextIO, ft_ext: str):
+        self.file = file
+        self.ft_ext = ft_ext
+
+    def __iterables(self) -> Tuple[TextIO, str]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[TextIO, str]
+            The ``file`` and ``ft_ext`` attributes.
+        """
+        return (self.file, self.ft_ext)
+
+    def __iter__(self):
+        """Iterate over objects."""
+        yield from self.__iterables()
+
 
-class BatchPairDict(TypedDict):
+class BatchPairDict:
     """
-    A dict containing ``fpath`` and ``ft_ext`` as keys.
+    An object containing ``fpath`` and ``ft_ext``.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    fpath : str
+        The target file's path.
+    ft_ext : str
+        The file-type/file-extension.
 
     Attributes
     ----------
@@ -341,13 +501,41 @@ class BatchPairDict(TypedDict):
     fpath: str
     ft_ext: str
 
+    def __init__(self, fpath: str, ft_ext: str):
+        self.fpath = fpath
+        self.ft_ext = ft_ext
+
+    def __iterables(self) -> Tuple[str, str]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[str, str]
+            The ``fpath`` and ``ft_ext`` attributes.
+        """
+        return (self.fpath, self.ft_ext)
+
+    def __iter__(self):
+        """Iterate over objects."""
+        yield from self.__iterables()
 
-class EOFCommentSearch(TypedDict):
+
+class EOFCommentSearch:
     """
     A dict containing ``state``, ``lang`` and ``match`` as keys.
 
     This is a ``TypedDict``-like object.
 
+    Parameters
+    ----------
+    state : IOWrapperBool
+        The target ``IOWrapperBool`` object.
+    lang : str
+        The file language.
+    match : bool
+        Whether it has a variation of an EOF comment at the end.
+
     Attributes
     ----------
     state : IOWrapperBool
@@ -362,4 +550,24 @@ class EOFCommentSearch(TypedDict):
     lang: str
     match: bool
 
+    def __init__(self, state: IOWrapperBool, lang: str, match: bool):
+        self.state = state
+        self.lang = lang
+        self.match = match
+
+    def __iterables(self) -> Tuple[IOWrapperBool, str, bool]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[IOWrapperBool, str, bool]
+            The ``state``, ``lang`` and ``match`` attributes.
+        """
+        return (self.state, self.lang, self.match)
+
+    def __iter__(self):
+        """Iterate over objects."""
+        yield from self.__iterables()
+
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

vim_eof_comment/types.pyi

@@ -139,11 +139,18 @@ class VersionInfo:
         0.0.3 (latest)
         """
 
-class ParserSpec(TypedDict):
+class ParserSpec:
     """
     Stores the spec for ``argparse`` operations in a constant value.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    opts : List[str]
+        A list containing all the relevant iterations of the same option.
+    kwargs : Dict[str, Any]
+        Extra arguments for ``argparse.ArgumentParser``.
+    completer : argcomplete.DirectoriesCompleter
+        An ``argcomplete`` completer object.
 
     Attributes
     ----------
@@ -157,12 +164,27 @@ class ParserSpec(TypedDict):
     opts: list[str]
     kwargs: dict[str, Any]
     completer: argcomplete.DirectoriesCompleter
+    def __init__(self, opts: list[str], kwargs: dict[str, Any], completer: argcomplete.DirectoriesCompleter) -> None: ...
+    def __iterables(self) -> tuple[list[str], dict[str, Any], argcomplete.DirectoriesCompleter]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[List[str], Dict[str, Any], argcomplete.DirectoriesCompleter]
+            The ``opts``, ``kwargs`` and ``completer`` attributes.
+        """
+    def __iter__(self):
+        """Iterate over objects."""
 
-class CommentMap(TypedDict):
+class CommentMap:
     """
-    Stores a dict with a ``level`` key.
+    An object containing ``level``.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    level : int
+        The indentation level.
 
     Attributes
     ----------
@@ -170,12 +192,22 @@ class CommentMap(TypedDict):
         The indentation level.
     """
     level: int
+    def __init__(self, level: int) -> None: ...
+    def __iterables(self) -> tuple[int]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[int]
+            The ``opts`` attribute (inside a tuple).
+        """
+    def __iter__(self):
+        """Iterate over objects."""
 
 class IndentMap(TypedDict):
     """
-    A dict containing ``level`` and ``expandtab`` as keys.
-
-    This is a ``TypedDict``-like object.
+    An object containing ``level`` and ``expandtab``.
 
     Attributes
     ----------
@@ -187,11 +219,18 @@ class IndentMap(TypedDict):
     level: int
     expandtab: bool
 
-class IndentHandler(TypedDict):
+class IndentHandler:
     """
-    A dict containing ``ft_ext``, ``level`` and ``expandtab`` as keys.
+    An object containing ``ft_ext``, ``level`` and ``expandtab``.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    ft_ext : str
+        The file-extension/file-type.
+    level : str
+        The string representation of the indent level.
+    expandtab : bool
+        Whether to expand tabs or not.
 
     Attributes
     ----------
@@ -205,12 +244,31 @@ class IndentHandler(TypedDict):
     ft_ext: str
     level: str
     expandtab: bool
+    def __init__(self, ft_ext: str, level: str, expandtab: bool) -> None: ...
+    def __iterables(self) -> tuple[str, str, bool]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[str, str, bool]
+            The ``ft_ext``, ``level`` and ``expandtab`` attributes.
+        """
+    def __iter__(self):
+        """Iterate over objects."""
 
-class IOWrapperBool(TypedDict):
+class IOWrapperBool:
     """
-    A dict containing ``file``, ``had_nwl`` and ``crlf`` as keys.
+    An object containing ``file``, ``had_nwl`` and ``crlf``.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    file : TextIO
+        The opened file as a ``TextIO`` wrapper.
+    had_nwl : bool
+        Whether the file has a newline or not.
+    crlf : bool
+        Whether the file is CRLF-terminated.
 
     Attributes
     ----------
@@ -224,12 +282,31 @@ class IOWrapperBool(TypedDict):
     file: TextIO
     had_nwl: bool
     crlf: bool
+    def __init__(self, file: TextIO, had_nwl: bool, crlf: bool) -> None: ...
+    def __iterables(self) -> tuple[TextIO, bool, bool]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[TextIO, bool, bool]
+            The ``file``, ``had_nwl`` and ``crlf`` attributes.
+        """
+    def __iter__(self):
+        """Iterate over objects."""
 
-class LineBool(TypedDict):
+class LineBool:
     """
-    A dict containing ``line``, ``had_nwl`` and ``crlf`` as keys.
+    An object containing ``line``, ``had_nwl`` and ``crlf``.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    line : str
+        The last line of the target file.
+    had_nwl : bool
+        Whether the file has a newline or not.
+    crlf : bool
+        Whether the file is CRLF-terminated.
 
     Attributes
     ----------
@@ -243,12 +320,29 @@ class LineBool(TypedDict):
     line: str
     had_nwl: bool
     crlf: bool
+    def __init__(self, line: str, had_nwl: bool, crlf: bool) -> None: ...
+    def __iterables(self) -> tuple[str, bool, bool]:
+        """
+        Generate iterables.
 
-class BatchPathDict(TypedDict):
+        Returns
+        -------
+        Tuple[str, bool, bool]
+            The ``line``, ``had_nwl`` and ``crlf`` attributes.
+        """
+    def __iter__(self):
+        """Iterate over objects."""
+
+class BatchPathDict:
     """
-    A dict containing ``file`` and ``ft_ext`` as keys.
+    An object containing ``file`` and ``ft_ext``.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    file : TextIO
+        The opened file as a ``TextIO`` wrapper.
+    ft_ext : str
+        The file-type/file-extension.
 
     Attributes
     ----------
@@ -259,12 +353,29 @@ class BatchPathDict(TypedDict):
     """
     file: TextIO
     ft_ext: str
+    def __init__(self, file: TextIO, ft_ext: str) -> None: ...
+    def __iterables(self) -> tuple[TextIO, str]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[TextIO, str]
+            The ``file`` and ``ft_ext`` attributes.
+        """
+    def __iter__(self):
+        """Iterate over objects."""
 
-class BatchPairDict(TypedDict):
+class BatchPairDict:
     """
-    A dict containing ``fpath`` and ``ft_ext`` as keys.
+    An object containing ``fpath`` and ``ft_ext``.
 
-    This is a ``TypedDict``-like object.
+    Parameters
+    ----------
+    fpath : str
+        The target file's path.
+    ft_ext : str
+        The file-type/file-extension.
 
     Attributes
     ----------
@@ -275,13 +386,34 @@ class BatchPairDict(TypedDict):
     """
     fpath: str
     ft_ext: str
+    def __init__(self, fpath: str, ft_ext: str) -> None: ...
+    def __iterables(self) -> tuple[str, str]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[str, str]
+            The ``fpath`` and ``ft_ext`` attributes.
+        """
+    def __iter__(self):
+        """Iterate over objects."""
 
-class EOFCommentSearch(TypedDict):
+class EOFCommentSearch:
     """
     A dict containing ``state``, ``lang`` and ``match`` as keys.
 
     This is a ``TypedDict``-like object.
 
+    Parameters
+    ----------
+    state : IOWrapperBool
+        The target ``IOWrapperBool`` object.
+    lang : str
+        The file language.
+    match : bool
+        Whether it has a variation of an EOF comment at the end.
+
     Attributes
     ----------
     state : IOWrapperBool
@@ -294,5 +426,17 @@ class EOFCommentSearch(TypedDict):
     state: IOWrapperBool
     lang: str
     match: bool
+    def __init__(self, state: IOWrapperBool, lang: str, match: bool) -> None: ...
+    def __iterables(self) -> tuple[IOWrapperBool, str, bool]:
+        """
+        Generate iterables.
+
+        Returns
+        -------
+        Tuple[IOWrapperBool, str, bool]
+            The ``state``, ``lang`` and ``match`` attributes.
+        """
+    def __iter__(self):
+        """Iterate over objects."""
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

vim_eof_comment/util.py

@@ -14,12 +14,12 @@ __all__ = [
 
 from sys import exit as Exit
 from sys import stderr, stdout
-from typing import Callable, Dict, List, NoReturn, TextIO
+from typing import Callable, Dict, List, TextIO
 
 from .types import IndentHandler, IndentMap
 
 
-def error(*msg, **kwargs) -> NoReturn:
+def error(*msg, **kwargs) -> None:
     """
     Print to stderr.
 
@@ -40,7 +40,7 @@ def error(*msg, **kwargs) -> NoReturn:
     print(*msg, file=stderr, end=end, sep=sep, flush=flush)
 
 
-def die(*msg, code: int = 0, func: Callable[[TextIO], None] | None = None, **kwargs) -> NoReturn:
+def die(*msg, code: int = 0, func: Callable[[TextIO], None] | None = None, **kwargs) -> None:
     """
     Kill the program execution.
 
@@ -98,7 +98,7 @@ def die(*msg, code: int = 0, func: Callable[[TextIO], None] | None = None, **kwa
     Exit(code)
 
 
-def verbose_print(*msg, verbose: bool | None = None, **kwargs) -> NoReturn:
+def verbose_print(*msg, verbose: bool | None = None, **kwargs) -> None:
     """
     Only prints the given data if verbose mode is activated.
 
@@ -153,14 +153,14 @@ def gen_indent_maps(maps: List[IndentHandler]) -> Dict[str, IndentMap] | None:
         if mapping_len <= 1:
             raise ValueError(f"One of the custom mappings is not formatted properly! (`{mapping}`)")
 
-        ext, level = mapping["ft_ext"], mapping["level"]
+        ext, level = mapping.ft_ext, mapping.level
         if ext in map_d.keys():
             continue
 
         mapping_len = mapping_len if mapping_len <= 3 else 3
         map_d[ext] = IndentMap(
             level=level,
-            expandtab=True if mapping_len == 2 else mapping["expandtab"]
+            expandtab=True if mapping_len == 2 else mapping.expandtab
         )
 
     return map_d

vim_eof_comment/util.pyi

@@ -1,10 +1,10 @@
-from typing import Callable, NoReturn, TextIO
+from typing import Callable, TextIO
 
 from .types import IndentHandler, IndentMap
 
 __all__ = ['die', 'error', 'gen_indent_maps', 'verbose_print']
 
-def error(*msg, **kwargs) -> NoReturn:
+def error(*msg, **kwargs) -> None:
     """
     Print to stderr.
 
@@ -19,7 +19,7 @@ def error(*msg, **kwargs) -> NoReturn:
     --------
     print : This function is essentially being wrapped around here.
     """
-def die(*msg, code: int = 0, func: Callable[[TextIO], None] | None = None, **kwargs) -> NoReturn:
+def die(*msg, code: int = 0, func: Callable[[TextIO], None] | None = None, **kwargs) -> None:
     '''
     Kill the program execution.
 
@@ -60,7 +60,7 @@ def die(*msg, code: int = 0, func: Callable[[TextIO], None] | None = None, **kwa
     >>> die("foo", "bar")
     foo bar
     '''
-def verbose_print(*msg, verbose: bool | None = None, **kwargs) -> NoReturn:
+def verbose_print(*msg, verbose: bool | None = None, **kwargs) -> None:
     """
     Only prints the given data if verbose mode is activated.
 

vim_eof_comment/version.py

@@ -7,8 +7,6 @@ Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
 __all__ = ["VersionInfo", "list_versions", "version_info", "version_print", "__version__"]
 
-from typing import NoReturn
-
 from .types import VersionInfo
 from .util import die
 
@@ -84,17 +82,18 @@ version_info = VersionInfo([
     (0, 5, 1),
     (0, 5, 2),
     (0, 5, 3),
+    (0, 6, 0),
 ])
 
 __version__: str = str(version_info)
 
 
-def list_versions() -> NoReturn:
+def list_versions() -> None:
     """List all versions."""
     die(version_info.get_all_versions(), code=0)
 
 
-def version_print(version: str) -> NoReturn:
+def version_print(version: str) -> None:
     """
     Print project version, then exit.
 

vim_eof_comment/version.pyi

@@ -1,5 +1,3 @@
-from typing import NoReturn
-
 from _typeshed import Incomplete
 
 from .types import VersionInfo as VersionInfo
@@ -9,9 +7,9 @@ __all__ = ['VersionInfo', 'list_versions', 'version_info', 'version_print', '__v
 version_info: Incomplete
 __version__: str
 
-def list_versions() -> NoReturn:
+def list_versions() -> None:
     """List all versions."""
-def version_print(version: str) -> NoReturn:
+def version_print(version: str) -> None:
     """
     Print project version, then exit.
 

{vim_eof_comment-0.5.3.dist-info → vim_eof_comment-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vim-eof-comment
-Version: 0.5.3
+Version: 0.6.0
 Summary: Adds Vim EOF modeline comments for given filetypes in given directories
 Author-email: Guennadi Maximov C <g.maxc.fox@protonmail.com>
 Maintainer-email: Guennadi Maximov C <g.maxc.fox@protonmail.com>

vim_eof_comment-0.6.0.dist-info/RECORD

@@ -0,0 +1,39 @@
+docs/Makefile,sha256=1rYkueTz6GC8AAF0rtOIJIv7sX-hMxVQBumHEqvbFEI,684
+docs/make.bat,sha256=0qjrzODegavKd7LLwmr9ADhaYftiTnBgqOVAL9kApyo,769
+docs/source/conf.py,sha256=nqU9B3qBpI-hZ8-L2oJuh2xY4Ob-GCD3nN00JiZbRHg,1729
+docs/source/functions.rst,sha256=erouYhzblZATxkA5yB6aUvF8baSvBcPQ9HwySWATTdI,20
+docs/source/index.rst,sha256=q7DKNrR1ztwLflzGbZDnIhFwkUTcjInqZV8uRqSq2N0,457
+docs/source/installation.rst,sha256=PkiS3E_ujNTWeKXicZ7aBPch2l1R0TsRRL6pFj_oMJI,276
+vim_eof_comment/__init__.py,sha256=ESbmhca9mTst3TYMer8zFw73IRsJvn5EESci_RpfLbQ,487
+vim_eof_comment/__init__.pyi,sha256=Eh8FQwE_F9TrQEiT7CR1mdGHBT6fHUzfV6VP8uSN33g,478
+vim_eof_comment/__main__.py,sha256=0AFVSkz8RuxSuPbJJWycyxs6u5Yypl8FKUMR3ZVLJbk,343
+vim_eof_comment/eof.py,sha256=rGKPqO6JbDzdJcsp20Ma9LLdyNHuUjC9ddU9F5nZqDE,5259
+vim_eof_comment/eof.pyi,sha256=xmAMsxOyiKQs4BqZP8h8rqP4a-ONifnb491sAzbu2Y8,1839
+vim_eof_comment/file.py,sha256=k1pX1RMZYtUkTXqTrAPsamn86Owl_OZ86XKHvV-q1Qo,5410
+vim_eof_comment/file.pyi,sha256=yqZh8ipC4X0GpMLVTUsw1UyiQ0JO6dY-_-0qGzJ3HF4,2317
+vim_eof_comment/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+vim_eof_comment/regex.py,sha256=48oxUO3YDdM30U0qAsqyH_AycYCrcnaQ6cghy3NXHrw,903
+vim_eof_comment/regex.pyi,sha256=W0ZX_J9mLRckCdBNE-Bl09hsQ61VFqjuLwDlevEeeUM,336
+vim_eof_comment/types.py,sha256=9DP25oIFcLwf1rbv1d8PCoL1J6bY_NOjFWjJyL4DA_I,13621
+vim_eof_comment/types.pyi,sha256=bBq_Jzl1HlczAG8ayFYS57Es_PcgU4cM-vuf-05VS60,11332
+vim_eof_comment/util.py,sha256=rgYlXi1epsNxFEFSElUG4zCoGb6WQoguH7uphcI0Y9Y,4256
+vim_eof_comment/util.pyi,sha256=twD4qk_fIL4ftQGbaGYmTSbKqE-RycAs5WTYBZ-HZsc,2653
+vim_eof_comment/version.py,sha256=XdpssUzLL8mKqe37XDXTnWKapxkyBiTVal2uanbjgNw,1906
+vim_eof_comment/version.pyi,sha256=aiA3TyTJOk5eZFt7glPNzRBvVgCwSJDlOFSUqoMPFG4,488
+vim_eof_comment/args/__init__.py,sha256=Hyqun15456NVFLAJ3cpdtuNEz5XaFH93vfVlbC-aeuc,318
+vim_eof_comment/args/__init__.pyi,sha256=cXK7nEpYBveD4kxtVTe2x8oUxT9mhENS5r3wK3AAX2U,151
+vim_eof_comment/args/completion.py,sha256=X2O-02QHeKBNF6alJHM9qka0l3-aY5TUTAqnHLY0bSY,1256
+vim_eof_comment/args/completion.pyi,sha256=nrKI8BYBe3cEXGOwkBDkeWgofjQpdGYL8mJR6ts1c9U,859
+vim_eof_comment/args/parsing.py,sha256=Clp23emNb1X0KVbnwIY1egA4G1BJjMHiOPkoaNMdq2E,6593
+vim_eof_comment/args/parsing.pyi,sha256=wJMDnW_dtIlv8NfTvf_JyTB7qwk_ZwLvCizp3GkFWhw,1741
+vim_eof_comment/comments/__init__.py,sha256=KIFAbugEKa8arCASaf7pKNHdzUC99N_T18D1CfaCOQs,292
+vim_eof_comment/comments/__init__.pyi,sha256=cecbbrShh0If8btwJ8zKYpBt9dIsMwrDXbdaBQqwUus,104
+vim_eof_comment/comments/filetypes.json,sha256=JpSrnBNO2AivLYi-C5--8yVocyBwye3IkMesNIz1uHA,2973
+vim_eof_comment/comments/generator.py,sha256=pCv6FFVCo4GscsB7-cbh-C8Ds19gYZ9dZAX2li9IZkc,7786
+vim_eof_comment/comments/generator.pyi,sha256=MAT7N0bPQE2IswSWOyiELnldbsBcjVsnIwSj4ltkI4g,3665
+vim_eof_comment-0.6.0.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
+vim_eof_comment-0.6.0.dist-info/METADATA,sha256=UuN2LfHn7DksUxHDDXT6QHkX72m5qHEOEP8r3YN6n2o,2826
+vim_eof_comment-0.6.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+vim_eof_comment-0.6.0.dist-info/entry_points.txt,sha256=vm47g4hoUbow4elcHr9yylYfj6IvAs10wSFKqwqTu6E,61
+vim_eof_comment-0.6.0.dist-info/top_level.txt,sha256=TkaQ5vuhVzXaJnfUdcLJCQ81ILK2V6OtvX5-hIMZAc0,21
+vim_eof_comment-0.6.0.dist-info/RECORD,,

{vim_eof_comment-0.5.3.dist-info → vim_eof_comment-0.6.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.10.1)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

vim_eof_comment-0.5.3.dist-info/RECORD

@@ -1,39 +0,0 @@
-docs/Makefile,sha256=1rYkueTz6GC8AAF0rtOIJIv7sX-hMxVQBumHEqvbFEI,684
-docs/make.bat,sha256=0qjrzODegavKd7LLwmr9ADhaYftiTnBgqOVAL9kApyo,769
-docs/source/conf.py,sha256=nqU9B3qBpI-hZ8-L2oJuh2xY4Ob-GCD3nN00JiZbRHg,1729
-docs/source/functions.rst,sha256=erouYhzblZATxkA5yB6aUvF8baSvBcPQ9HwySWATTdI,20
-docs/source/index.rst,sha256=q7DKNrR1ztwLflzGbZDnIhFwkUTcjInqZV8uRqSq2N0,457
-docs/source/installation.rst,sha256=PkiS3E_ujNTWeKXicZ7aBPch2l1R0TsRRL6pFj_oMJI,276
-vim_eof_comment/__init__.py,sha256=ESbmhca9mTst3TYMer8zFw73IRsJvn5EESci_RpfLbQ,487
-vim_eof_comment/__init__.pyi,sha256=Eh8FQwE_F9TrQEiT7CR1mdGHBT6fHUzfV6VP8uSN33g,478
-vim_eof_comment/__main__.py,sha256=0AFVSkz8RuxSuPbJJWycyxs6u5Yypl8FKUMR3ZVLJbk,343
-vim_eof_comment/eof.py,sha256=gWq0mVc0PcRNW4R41BBRlDw3B2etCvv0qXUSHOiH72Q,5295
-vim_eof_comment/eof.pyi,sha256=eFaIkPQ3ZXS3CE6QpTEA9QCQmJpmG_5N3Kb3_Iz_tOo,1872
-vim_eof_comment/file.py,sha256=jR3VBVZ_yT9bMbi0SXQKMGexYgtWrvWkJEtodAIksrg,5395
-vim_eof_comment/file.pyi,sha256=XOYsJnW72i7Zt9N0jSLpscls-ggzL08aQKXpxrLFiwY,2274
-vim_eof_comment/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vim_eof_comment/regex.py,sha256=48oxUO3YDdM30U0qAsqyH_AycYCrcnaQ6cghy3NXHrw,903
-vim_eof_comment/regex.pyi,sha256=W0ZX_J9mLRckCdBNE-Bl09hsQ61VFqjuLwDlevEeeUM,336
-vim_eof_comment/types.py,sha256=kujXMK19J0Nngf6eoHyg04ZfD-WKAB_Cdna7uRVJTKQ,8367
-vim_eof_comment/types.pyi,sha256=OnXme5rgPq9vt8LHTRCSeOpkBAuc2J_7pcwcXFHOk1A,7255
-vim_eof_comment/util.py,sha256=MHLt-FJz4uhsa56J2sug74uqk6W3S0mVLugvz7KNRUU,4287
-vim_eof_comment/util.pyi,sha256=5RQukLgpVZTwbALhBOtd1NqFkiqC-V6JEWeT1_B9-2k,2675
-vim_eof_comment/version.py,sha256=bP9IxYQS_QivEBpnNsL4Cl70-Q3Y0cP591byW2XmQYQ,1928
-vim_eof_comment/version.pyi,sha256=P90IRWMKlsG_YU8G8a1e1eyTd8rC-6fUGvQrD3zjwbE,525
-vim_eof_comment/args/__init__.py,sha256=Hyqun15456NVFLAJ3cpdtuNEz5XaFH93vfVlbC-aeuc,318
-vim_eof_comment/args/__init__.pyi,sha256=cXK7nEpYBveD4kxtVTe2x8oUxT9mhENS5r3wK3AAX2U,151
-vim_eof_comment/args/completion.py,sha256=xpfMKeo1-LBMeU-5icO1Jh5ixml55sK5ExHbi5sSXKg,1270
-vim_eof_comment/args/completion.pyi,sha256=bEMpcLKYUZEGj3V9yiYifpLxfuNC69etdIf-gdsdtJc,891
-vim_eof_comment/args/parsing.py,sha256=Zp1u4--4t4lfQF8RZLhCFfE6Khlc5rcG7gHcPXaPthw,6605
-vim_eof_comment/args/parsing.pyi,sha256=wJMDnW_dtIlv8NfTvf_JyTB7qwk_ZwLvCizp3GkFWhw,1741
-vim_eof_comment/comments/__init__.py,sha256=KIFAbugEKa8arCASaf7pKNHdzUC99N_T18D1CfaCOQs,292
-vim_eof_comment/comments/__init__.pyi,sha256=cecbbrShh0If8btwJ8zKYpBt9dIsMwrDXbdaBQqwUus,104
-vim_eof_comment/comments/filetypes.json,sha256=JpSrnBNO2AivLYi-C5--8yVocyBwye3IkMesNIz1uHA,2973
-vim_eof_comment/comments/generator.py,sha256=yuRvTuVd6qQ1ei496w8NQ0c1MR1e3qJHf1pOTalXlv8,7814
-vim_eof_comment/comments/generator.pyi,sha256=ue8oMa7yEoKfgQDJbeTzx0Qm5Wck2gHrDb_wF00xIyo,3687
-vim_eof_comment-0.5.3.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
-vim_eof_comment-0.5.3.dist-info/METADATA,sha256=lexJQiJJA7rL5pP1DRU_VkQvRFXLy5nSbIXAk-pwP3I,2826
-vim_eof_comment-0.5.3.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
-vim_eof_comment-0.5.3.dist-info/entry_points.txt,sha256=vm47g4hoUbow4elcHr9yylYfj6IvAs10wSFKqwqTu6E,61
-vim_eof_comment-0.5.3.dist-info/top_level.txt,sha256=TkaQ5vuhVzXaJnfUdcLJCQ81ILK2V6OtvX5-hIMZAc0,21
-vim_eof_comment-0.5.3.dist-info/RECORD,,