vim-eof-comment 0.4.1__tar.gz → 0.5.0__tar.gz

{vim_eof_comment-0.4.1 → vim_eof_comment-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vim-eof-comment
-Version: 0.4.1
+Version: 0.5.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>
@@ -20,6 +20,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python
 Classifier: Topic :: Text Processing :: Filters
 Classifier: Topic :: Utilities
@@ -30,8 +31,6 @@ License-File: LICENSE
 Requires-Dist: argcomplete
 Requires-Dist: argparse
 Requires-Dist: colorama
-Requires-Dist: setuptools
-Requires-Dist: wheel
 Dynamic: license-file
 
 # vim-eof-comment

{vim_eof_comment-0.4.1 → vim_eof_comment-0.5.0}/Pipfile

@@ -4,19 +4,16 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
-setuptools = "*"
-wheel = "*"
 argparse = "*"
-pyproject = "*"
 colorama = "*"
 argcomplete = "*"
-pynvim = "*"
 
 [dev-packages]
+pyproject = "*"
+setuptools = "*"
+wheel = "*"
 pynvim = "*"
 build = "*"
-pip = "*"
-pyproject = "*"
 twine = "*"
 pypi-attestations = "*"
 pre-commit = "*"
@@ -30,6 +27,7 @@ renku-sphinx-theme = "*"
 sphinxawesome-theme = "*"
 numpydoc = "*"
 vim-eof-comment = "*"
+pip = "*"
 
 [scripts]
 lint = "flake8 --statistics --show-source --color always --max-line-length 100 --docstring-convention numpy --ignore=D401 ."
@@ -41,4 +39,4 @@ install = "python3 -m pip install"
 stubs = "stubgen -p vim_eof_comment -o ."
 
 [requires]
-python_version = "3.13"
+python_version = "3.14"

{vim_eof_comment-0.4.1 → vim_eof_comment-0.5.0}/pyproject.toml

@@ -16,12 +16,13 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Programming Language :: Python",
     "Topic :: Text Processing :: Filters",
     "Topic :: Utilities",
     "Typing :: Typed",
 ]
-dependencies = ["argcomplete", "argparse", "colorama", "setuptools", "wheel"]
+dependencies = ["argcomplete", "argparse", "colorama"]
 description = "Adds Vim EOF modeline comments for given filetypes in given directories"
 keywords = [
     "eof comments",
@@ -39,7 +40,7 @@ maintainers = [{ name = "Guennadi Maximov C", email = "g.maxc.fox@protonmail.com
 name = "vim-eof-comment"
 readme = "README.md"
 requires-python = ">=3.10"
-version = "0.4.1"
+version = "0.5.0"
 
     [project.scripts]
     vim-eof-comment = "vim_eof_comment.eof:main"
@@ -62,6 +63,7 @@ exclude = [
     '__dict__$',
     '__eq__$',
     '__init__$',
+    '__ne__$',
     '__repr__$',
     '__str__$',
 ]

vim_eof_comment-0.5.0/requirements.txt

@@ -0,0 +1,4 @@
+-i https://pypi.org/simple
+argcomplete==3.6.3; python_version >= '3.8'
+argparse==1.4.0
+colorama==0.4.6; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6'

vim_eof_comment-0.5.0/version.txt

@@ -0,0 +1 @@
+0.5.0

{vim_eof_comment-0.4.1 → vim_eof_comment-0.5.0}/vim_eof_comment/args/completion.py

@@ -5,7 +5,7 @@ Argument parsing completion utilities for ``vim-eof-comment``.
 
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
-__all__ = ["complete_parser"]
+__all__ = ["complete_parser", "complete_validator"]
 
 from argparse import ArgumentParser
 from typing import List, NoReturn

vim_eof_comment-0.5.0/vim_eof_comment/args/completion.pyi

@@ -0,0 +1,34 @@
+from argparse import ArgumentParser
+from typing import NoReturn
+
+__all__ = ['complete_parser', 'complete_validator']
+
+def complete_validator(completion_candidate: list[str], current_input: str) -> bool:
+    """
+    Complete non-prefix substring matches.
+
+    Parameters
+    ----------
+    completion_candidate : List[str]
+        All the completion candidates.
+    current_input : str
+        The current input string.
+
+    Returns
+    -------
+    bool
+        Whether the current input fits the completion candidates pool.
+    """
+def complete_parser(parser: ArgumentParser, **kwargs) -> NoReturn:
+    """
+    Complete the script argument parser.
+
+    Parameters
+    ----------
+    parser : argparse.ArgumentParser
+        The ``ArgumentParser`` object.
+    **kwargs
+        Extra parameters to be passed to ``argcomplete.autocomplete()``.
+    """
+
+# vim: set ts=4 sts=4 sw=4 et ai si sta:

{vim_eof_comment-0.4.1 → vim_eof_comment-0.5.0}/vim_eof_comment/args/parsing.py

@@ -17,7 +17,7 @@ from ..util import die
 from .completion import complete_parser
 
 
-def gen_parser_specs(*specs) -> Tuple[ParserSpec]:
+def gen_parser_specs(*specs) -> List[ParserSpec]:
     """
     Generate a ``ParserSpec`` object.
 
@@ -28,13 +28,13 @@ def gen_parser_specs(*specs) -> Tuple[ParserSpec]:
 
     Returns
     -------
-    Tuple[ParserSpec]
-        The converted dictionaries inside a tuple.
+    List[ParserSpec]
+        The converted dictionaries inside a list.
     """
-    return tuple([ParserSpec(**d) for d in [*specs]])
+    return [ParserSpec(**d) for d in [*specs]]
 
 
-def bootstrap_args(parser: ArgumentParser, specs: Tuple[ParserSpec]) -> Namespace:
+def bootstrap_args(parser: ArgumentParser, specs: List[ParserSpec]) -> Namespace:
     """
     Bootstrap the program arguments.
 
@@ -92,7 +92,7 @@ def arg_parser_init(prog: str = "vim-eof-comment") -> Tuple[ArgumentParser, Name
         add_help=True,
         allow_abbrev=True
     )
-    spec: Tuple[ParserSpec] = gen_parser_specs(
+    spec: List[ParserSpec] = gen_parser_specs(
         {
             "opts": ["directories"],
             "kwargs": {

{vim_eof_comment-0.4.1 → vim_eof_comment-0.5.0}/vim_eof_comment/args/parsing.pyi

@@ -4,7 +4,7 @@ from ..types import IndentHandler, ParserSpec
 
 __all__ = ['gen_parser_specs', 'bootstrap_args', 'arg_parser_init', 'indent_handler']
 
-def gen_parser_specs(*specs) -> tuple[ParserSpec]:
+def gen_parser_specs(*specs) -> list[ParserSpec]:
     """
     Generate a ``ParserSpec`` object.
 
@@ -15,10 +15,10 @@ def gen_parser_specs(*specs) -> tuple[ParserSpec]:
 
     Returns
     -------
-    Tuple[ParserSpec]
-        The converted dictionaries inside a tuple.
+    List[ParserSpec]
+        The converted dictionaries inside a list.
     """
-def bootstrap_args(parser: ArgumentParser, specs: tuple[ParserSpec]) -> Namespace:
+def bootstrap_args(parser: ArgumentParser, specs: list[ParserSpec]) -> Namespace:
     """
     Bootstrap the program arguments.
 

{vim_eof_comment-0.4.1 → vim_eof_comment-0.5.0}/vim_eof_comment/comments/generator.py

@@ -5,7 +5,13 @@ Per-filetype modeline comment class.
 
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
-__all__ = ["Comments", "export_json", "import_json", "list_filetypes"]
+__all__ = [
+    "Comments",
+    "export_json",
+    "generate_list_items",
+    "import_json",
+    "list_filetypes",
+]
 
 import json
 import os
@@ -22,7 +28,6 @@ from ..util import die
 COMMENT_STR: str = "vim: set ts={ts} sts={sts} sw={sw} {et} ai si sta:"
 
 _JSON_FILE: str = realpath("./vim_eof_comment/comments/filetypes.json")
-
 _BLUE: int = Fore.BLUE
 _YELLOW: int = Fore.YELLOW
 _CYAN: int = Fore.CYAN
@@ -88,6 +93,7 @@ class Comments():
     __is_available(lang)
     __fill_langs(langs)
     get_defaults()
+    get_ft()
     """
 
     __DEFAULT: Dict[str, IndentMap] = _DEFAULT.copy()
@@ -108,7 +114,7 @@ class Comments():
             self.langs = self.__DEFAULT.copy()
             return
 
-        langs = dict()
+        langs: Dict[str, IndentMap] = dict()
         for lang, mapping in mappings.items():
             if not (self.__is_available(lang)) or len(mapping) == 0:
                 continue
@@ -117,7 +123,7 @@ class Comments():
             if len(mapping) > 1:
                 expandtab = mapping["expandtab"]
 
-            langs[lang] = {"level": indent, "expandtab": expandtab}
+            langs[lang] = IndentMap(level=indent, expandtab=expandtab)
 
         self.__fill_langs(langs)
 

{vim_eof_comment-0.4.1 → vim_eof_comment-0.5.0}/vim_eof_comment/comments/generator.pyi

@@ -2,7 +2,7 @@ from typing import Iterator, NoReturn
 
 from ..types import IndentMap
 
-__all__ = ['Comments', 'export_json', 'import_json', 'list_filetypes']
+__all__ = ['Comments', 'export_json', 'generate_list_items', 'import_json', 'list_filetypes']
 
 def import_json() -> tuple[dict[str, str], dict[str, IndentMap]]:
     """
@@ -41,6 +41,7 @@ class Comments:
     __is_available(lang)
     __fill_langs(langs)
     get_defaults()
+    get_ft()
     """
     __DEFAULT: dict[str, IndentMap]
     __formats: dict[str, str]
@@ -113,6 +114,24 @@ class Comments:
             Either the file extension string, or if not available then ``None``.
         """
 
+def generate_list_items(ft: str, level: int, expandtab: str) -> str:
+    '''
+    Generate a colored string for filetypes listing.
+
+    Parameters
+    ----------
+    ft : str
+        The filetype item in question.
+    level : int
+        Indent size.
+    expandtab : str
+        Either ``"Yes"`` or ``"No"``.
+
+    Returns
+    -------
+    str
+        The generated string.
+    '''
 def list_filetypes() -> NoReturn:
     """List all available filetypes."""
 def export_json() -> NoReturn:

{vim_eof_comment-0.4.1 → vim_eof_comment-0.5.0}/vim_eof_comment/eof.py

@@ -153,10 +153,9 @@ def main() -> int:
     dirs: List[str] = ns.directories
     exts: List[str] = ns.exts.split(",")
     newline: bool = ns.newline
-    indent: List[IndentHandler] = indent_handler(ns.indent)
     verbose: bool = ns.verbose
-
     dry_run: bool = ns.dry_run
+    indent: List[IndentHandler] = indent_handler(ns.indent)
 
     if dry_run:
         verbose = True

{vim_eof_comment-0.4.1 → vim_eof_comment-0.5.0}/vim_eof_comment/file.py

@@ -106,14 +106,14 @@ def open_batch_paths(paths: List[BatchPairDict]) -> Dict[str, BatchPathDict]:
     Dict[str, BatchPathDict]
         A ``str`` to ``BatchPathDict``` dictionary.
     """
-    result = dict()
+    result: Dict[str, BatchPathDict] = dict()
     for path in paths:
         fpath, ext = path["fpath"], path["ft_ext"]
         if not try_open(fpath):
             continue
 
         try:
-            result[fpath] = {"file": open(fpath, "r"), "ft_ext": ext}
+            result[fpath] = BatchPathDict(file=open(fpath, "r"), ft_ext=ext)
         except KeyboardInterrupt:
             die("\nProgram interrupted!", code=1)  # Kills the program
         except FileNotFoundError:

vim_eof_comment-0.4.1/vim_eof_comment/version.py → vim_eof_comment-0.5.0/vim_eof_comment/types.py

@@ -1,15 +1,26 @@
 # -*- coding: utf-8 -*-
 # Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
-Custom vim-eof-comment versioning objects.
+Custom vim-eof-comment ``TypedDict`` objects.
 
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
-__all__ = ["VersionInfo", "list_versions", "version_info", "version_print", "__version__"]
+__all__ = [
+    "BatchPairDict",
+    "BatchPathDict",
+    "CommentMap",
+    "EOFCommentSearch",
+    "IOWrapperBool",
+    "IndentHandler",
+    "IndentMap",
+    "LineBool",
+    "ParserSpec",
+    "VersionInfo",
+]
 
-from typing import List, NoReturn, Tuple
+from typing import Any, Dict, List, TextIO, Tuple, TypedDict
 
-from .util import die
+import argcomplete
 
 
 class VersionInfo():
@@ -134,8 +145,23 @@ class VersionInfo():
         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]:
+        """
+        Get a tuple representing the current version.
+
+        Returns
+        -------
+        major : int
+            Major component.
+        minor : int
+            Minor component.
+        patch : int
+            Patch component.
+        """
+        return (self.major, self. minor, self.patch)
+
     def get_all_versions(self) -> str:
-        r"""
+        """
         Retrieve all versions as a string.
 
         Returns
@@ -163,92 +189,171 @@ class VersionInfo():
         return result
 
 
-version_info = VersionInfo([
-    (0, 1, 1),
-    (0, 1, 2),
-    (0, 1, 3),
-    (0, 1, 4),
-    (0, 1, 5),
-    (0, 1, 6),
-    (0, 1, 7),
-    (0, 1, 8),
-    (0, 1, 9),
-    (0, 1, 10),
-    (0, 1, 11),
-    (0, 1, 12),
-    (0, 1, 13),
-    (0, 1, 14),
-    (0, 1, 15),
-    (0, 1, 16),
-    (0, 1, 17),
-    (0, 1, 18),
-    (0, 1, 19),
-    (0, 1, 20),
-    (0, 1, 21),
-    (0, 1, 22),
-    (0, 1, 23),
-    (0, 1, 24),
-    (0, 1, 25),
-    (0, 1, 26),
-    (0, 1, 27),
-    (0, 1, 28),
-    (0, 1, 29),
-    (0, 1, 30),
-    (0, 1, 31),
-    (0, 1, 32),
-    (0, 1, 33),
-    (0, 1, 34),
-    (0, 1, 35),
-    (0, 1, 36),
-    (0, 1, 37),
-    (0, 1, 38),
-    (0, 2, 0),
-    (0, 2, 1),
-    (0, 2, 2),
-    (0, 2, 3),
-    (0, 3, 0),
-    (0, 3, 1),
-    (0, 3, 2),
-    (0, 3, 3),
-    (0, 3, 4),
-    (0, 3, 5),
-    (0, 3, 6),
-    (0, 3, 7),
-    (0, 3, 8),
-    (0, 3, 9),
-    (0, 3, 10),
-    (0, 3, 11),
-    (0, 3, 12),
-    (0, 3, 13),
-    (0, 3, 14),
-    (0, 3, 15),
-    (0, 3, 16),
-    (0, 3, 17),
-    (0, 3, 18),
-    (0, 3, 19),
-    (0, 3, 20),
-    (0, 3, 21),
-    (0, 4, 0),
-    (0, 4, 1),
-])
-
-__version__: str = str(version_info)
-
-
-def list_versions() -> NoReturn:
-    """List all versions."""
-    die(version_info.get_all_versions(), code=0)
-
-
-def version_print(version: str) -> NoReturn:
-    """
-    Print project version, then exit.
+class ParserSpec(TypedDict):
+    """
+    Stores the spec for ``argparse`` operations in a constant value.
 
-    Parameters
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    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.
+    """
+
+    opts: List[str]
+    kwargs: Dict[str, Any]
+    completer: argcomplete.DirectoriesCompleter
+
+
+class CommentMap(TypedDict):
+    """
+    Stores a dict with a ``level`` key.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    level : int
+        The indentation level.
+    """
+
+    level: int
+
+
+class IndentMap(TypedDict):
+    """
+    A dict containing ``level`` and ``expandtab`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    level : int
+        The indent level.
+    expandtab : bool
+        Whether to expand tabs or not.
+    """
+
+    level: int
+    expandtab: bool
+
+
+class IndentHandler(TypedDict):
+    """
+    A dict containing ``ft_ext``, ``level`` and ``expandtab`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    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.
+    """
+
+    ft_ext: str
+    level: str
+    expandtab: bool
+
+
+class IOWrapperBool(TypedDict):
+    """
+    A dict containing ``file`` and ``had_nwl`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    file : TextIO
+        The opened file as a ``TextIO`` wrapper.
+    had_nwl : bool
+        Whether the file has a newline or not.
+    """
+
+    file: TextIO
+    had_nwl: bool
+
+
+class LineBool(TypedDict):
+    """
+    A dict containing ``line`` and ``had_nwl`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    line : str
+        The last line of the target file.
+    had_nwl : bool
+        Whether the file has a newline or not.
+    """
+
+    line: str
+    had_nwl: bool
+
+
+class BatchPathDict(TypedDict):
+    """
+    A dict containing ``file`` and ``ft_ext`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    file : TextIO
+        The opened file as a ``TextIO`` wrapper.
+    ft_ext : str
+        The file-type/file-extension.
+    """
+
+    file: TextIO
+    ft_ext: str
+
+
+class BatchPairDict(TypedDict):
+    """
+    A dict containing ``fpath`` and ``ft_ext`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
     ----------
-    version : str
-        The version string.
+    fpath : str
+        The target file's path.
+    ft_ext : str
+        The file-type/file-extension.
     """
-    die(f"vim-eof-comment-{version}", code=0)
+
+    fpath: str
+    ft_ext: str
+
+
+class EOFCommentSearch(TypedDict):
+    """
+    A dict containing ``state``, ``lang`` and ``match`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    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.
+    """
+
+    state: IOWrapperBool
+    lang: str
+    match: bool
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta: