vim-eof-comment 0.3.12__py3-none-any.whl → 0.3.14__py3-none-any.whl

vim_eof_comment/args/completion.py

@@ -8,10 +8,28 @@ Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 __all__ = ["complete_parser"]
 
 from argparse import ArgumentParser
-from typing import NoReturn
+from typing import List, NoReturn
 
 from argcomplete import autocomplete
-from argcomplete.finders import default_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.
+    """
+    return current_input in completion_candidate
 
 
 def complete_parser(parser: ArgumentParser, **kwargs) -> NoReturn:
@@ -23,8 +41,8 @@ def complete_parser(parser: ArgumentParser, **kwargs) -> NoReturn:
     parser : argparse.ArgumentParser
         The ``ArgumentParser`` object.
     **kwargs
-        Extra parameters.
+        Extra parameters to be passed to ``argcomplete.autocomplete()``.
     """
-    autocomplete(parser, validator=default_validator, **kwargs)
+    autocomplete(parser, validator=complete_validator, **kwargs)
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

vim_eof_comment/args/completion.pyi

@@ -12,7 +12,7 @@ def complete_parser(parser: ArgumentParser, **kwargs) -> NoReturn:
     parser : argparse.ArgumentParser
         The ``ArgumentParser`` object.
     **kwargs
-        Extra parameters.
+        Extra parameters to be passed to ``argcomplete.autocomplete()``.
     """
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

vim_eof_comment/comments/generator.py

@@ -13,11 +13,20 @@ from io import TextIOWrapper
 from os.path import exists, isdir, realpath
 from typing import Dict, Iterator, List, NoReturn, Tuple
 
+from colorama import Fore, Style
+from colorama import init as color_init
+
 from ..types import IndentMap
 from ..util import die
 
 _JSON_FILE: str = realpath("./vim_eof_comment/comments/filetypes.json")
 
+_BLUE: int = Fore.BLUE
+_YELLOW: int = Fore.YELLOW
+_CYAN: int = Fore.CYAN
+_BRIGHT: int = Style.BRIGHT
+_RESET: int = Style.RESET_ALL
+
 
 def import_json() -> Tuple[Dict[str, str], Dict[str, IndentMap]]:
     """
@@ -195,15 +204,48 @@ class Comments():
         return comments.get(ext, 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.
+    """
+    txt = f"{_RESET}{_BRIGHT}{_BLUE}{ft}\n"
+    txt += f"   {_RESET}{_BRIGHT}indent size{_RESET}{_BRIGHT} ==> {_CYAN}{level}\n"
+    txt += f"   {_RESET}{_BRIGHT}expandtab{_RESET}{_BRIGHT} ==> {_CYAN}{expandtab}"
+
+    return txt
+
+
 def list_filetypes() -> NoReturn:
     """List all available filetypes."""
-    txt: List[str] = [""]
+    color_init()
+
+    defaults = Comments().get_defaults()
+    items: Dict[str, Tuple[int, str]] = dict()
+    for ft_ext, indents in defaults.items():
+        level: int = indents.get("level", 4)
+        et = "Yes" if indents.get("expandtab") else "No"
+        items[ft_ext] = (level, et)
+
+    keys: List[str] = list(items.keys())
+    keys.sort()
 
-    c: Comments = Comments()
-    defaults: Dict[str, IndentMap] = c.get_defaults()
-    for ext, indents in defaults.items():
-        txt.append(f"- {ext}: {indents}")
+    sorted_items: Dict[str, Tuple[int, str]] = {i: items[i] for i in keys}
 
+    txt = [generate_list_items(k, v[0], v[1]) for k, v in sorted_items.items()]
     die(*txt, code=0, sep="\n")
 
 

vim_eof_comment/eof.py

@@ -19,8 +19,8 @@ from .comments.generator import Comments, list_filetypes
 from .file import bootstrap_paths, get_last_line, modify_file, open_batch_paths
 from .regex import matches
 from .types import BatchPathDict, EOFCommentSearch, IndentHandler, IOWrapperBool
-from .util import die, gen_indent_maps, verbose_print, version_print
-from .version import __version__, list_versions
+from .util import die, gen_indent_maps, verbose_print
+from .version import __version__, list_versions, version_print
 
 _RED: int = Fore.LIGHTRED_EX
 _GREEN: int = Fore.LIGHTGREEN_EX

vim_eof_comment/util.py

@@ -5,7 +5,7 @@ EOF comments checker utilities.
 
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
-__all__ = ["die", "error", "gen_indent_maps", "verbose_print", "version_print"]
+__all__ = ["die", "error", "gen_indent_maps", "verbose_print"]
 
 from sys import exit as Exit
 from sys import stderr, stdout
@@ -117,22 +117,6 @@ def verbose_print(*msg, verbose: bool | None = None, **kwargs) -> NoReturn:
     print(*msg, end=end, sep=sep, flush=flush)
 
 
-def version_print(version: str) -> NoReturn:
-    """
-    Print project version, then exit.
-
-    Parameters
-    ----------
-    version : str
-        The version string.
-
-    See Also
-    --------
-    vim_eof_comment.util.die : The function used for this function.
-    """
-    die(f"vim-eof-comment-{version}", code=0)
-
-
 def gen_indent_maps(maps: List[IndentHandler]) -> Dict[str, IndentMap] | None:
     """
     Generate a dictionary from the custom indent maps.

vim_eof_comment/util.pyi

@@ -2,7 +2,7 @@ from typing import Callable, NoReturn, TextIO
 
 from .types import IndentHandler, IndentMap
 
-__all__ = ['die', 'error', 'gen_indent_maps', 'verbose_print', 'version_print']
+__all__ = ['die', 'error', 'gen_indent_maps', 'verbose_print']
 
 def error(*msg, **kwargs) -> NoReturn:
     """
@@ -77,19 +77,6 @@ def verbose_print(*msg, verbose: bool | None = None, **kwargs) -> NoReturn:
     --------
     print : This function is essentially being wrapped around here.
     """
-def version_print(version: str) -> NoReturn:
-    """
-    Print project version, then exit.
-
-    Parameters
-    ----------
-    version : str
-        The version string.
-
-    See Also
-    --------
-    vim_eof_comment.util.die : The function used for this function.
-    """
 def gen_indent_maps(maps: list[IndentHandler]) -> dict[str, IndentMap] | None:
     """
     Generate a dictionary from the custom indent maps.

vim_eof_comment/version.py

@@ -5,7 +5,7 @@ Custom vim-eof-comment versioning objects.
 
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
-__all__ = ["VersionInfo", "list_versions", "version_info", "__version__"]
+__all__ = ["VersionInfo", "list_versions", "version_info", "version_print", "__version__"]
 
 from typing import List, NoReturn, Tuple
 
@@ -103,7 +103,7 @@ class VersionInfo():
         Only one definition in constructor.
 
         >>> from vim_eof_comment.version import VersionInfo
-        >>> print(VersionInfo([(0, 0, 1)]))
+        >>> print(repr(VersionInfo([(0, 0, 1)])))
         0.0.1
 
         Multiple definitions in constructor.
@@ -163,7 +163,7 @@ class VersionInfo():
         return result
 
 
-version_info: VersionInfo = VersionInfo([
+version_info = VersionInfo([
     (0, 1, 1),
     (0, 1, 2),
     (0, 1, 3),
@@ -219,6 +219,8 @@ version_info: VersionInfo = VersionInfo([
     (0, 3, 10),
     (0, 3, 11),
     (0, 3, 12),
+    (0, 3, 13),
+    (0, 3, 14),
 ])
 
 __version__: str = str(version_info)
@@ -226,7 +228,18 @@ __version__: str = str(version_info)
 
 def list_versions() -> NoReturn:
     """List all versions."""
-    all_versions: str = version_info.get_all_versions()
-    die(all_versions, code=0)
+    die(version_info.get_all_versions(), code=0)
+
+
+def version_print(version: str) -> NoReturn:
+    """
+    Print project version, then exit.
+
+    Parameters
+    ----------
+    version : str
+        The version string.
+    """
+    die(f"vim-eof-comment-{version}", code=0)
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

vim_eof_comment/version.pyi

@@ -1,6 +1,8 @@
 from typing import NoReturn
 
-__all__ = ['VersionInfo', 'list_versions', 'version_info', '__version__']
+from _typeshed import Incomplete
+
+__all__ = ['VersionInfo', 'list_versions', 'version_info', 'version_print', '__version__']
 
 class VersionInfo:
     """
@@ -82,7 +84,7 @@ class VersionInfo:
         Only one definition in constructor.
 
         >>> from vim_eof_comment.version import VersionInfo
-        >>> print(VersionInfo([(0, 0, 1)]))
+        >>> print(repr(VersionInfo([(0, 0, 1)])))
         0.0.1
 
         Multiple definitions in constructor.
@@ -124,10 +126,19 @@ class VersionInfo:
         0.0.3 (latest)
         """
 
-version_info: VersionInfo
+version_info: Incomplete
 __version__: str
 
 def list_versions() -> NoReturn:
     """List all versions."""
+def version_print(version: str) -> NoReturn:
+    """
+    Print project version, then exit.
+
+    Parameters
+    ----------
+    version : str
+        The version string.
+    """
 
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

{vim_eof_comment-0.3.12.dist-info → vim_eof_comment-0.3.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vim-eof-comment
-Version: 0.3.12
+Version: 0.3.14
 Summary: Adds Vim EOF 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>
@@ -30,7 +30,6 @@ License-File: LICENSE
 Requires-Dist: argcomplete
 Requires-Dist: argparse
 Requires-Dist: colorama
-Requires-Dist: python-magic
 Requires-Dist: setuptools
 Requires-Dist: typing
 Requires-Dist: wheel

{vim_eof_comment-0.3.12.dist-info → vim_eof_comment-0.3.14.dist-info}/RECORD

@@ -7,7 +7,7 @@ docs/source/installation.rst,sha256=PkiS3E_ujNTWeKXicZ7aBPch2l1R0TsRRL6pFj_oMJI,
 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=ZT87ltzdnQLMoKZ6sx1QwRdSMcfjkFVWFEe9gwPkmqY,5159
+vim_eof_comment/eof.py,sha256=gjnqU5rWeN5WjPsfjw2j41sfbBJdnZzdzmrBhMYC0Ms,5159
 vim_eof_comment/eof.pyi,sha256=BTw9brhrHBTX12fYuwfO8_D-Gyrf0387ErmgrcTdvh0,1786
 vim_eof_comment/file.py,sha256=o_bWoBRehRWwzCozO-9DDf7G5-dU92nm-5mX1CxvlW4,4182
 vim_eof_comment/file.pyi,sha256=BWBtHbFkAdiNSRfe9SQBJvxtH3WHZfIgz03kFsIWX4w,1950
@@ -16,24 +16,24 @@ vim_eof_comment/regex.py,sha256=rGfFIBMbfWlIxAScXqvgBlB-tMJBUxQwTVjEkoxDZ3o,1007
 vim_eof_comment/regex.pyi,sha256=LJt6HN9s0Vo1B5plpaYURVZ3okmtl5jnV6kKdn1KyqA,433
 vim_eof_comment/types.py,sha256=q8q5FcWLyisRQ-aWUmY9pCVO8YjvEYQ9yNaGNZRZsIY,3832
 vim_eof_comment/types.pyi,sha256=2DWWKheDuztFlKZZkaYQYELaZVWoZzdi2UfQNsqBmqE,3562
-vim_eof_comment/util.py,sha256=k2cCknGHnpitRRDMNkEYzuMbwMtZ1eqyr9okgZQDwyg,4461
-vim_eof_comment/util.pyi,sha256=2o50NhjhYm0gLHkCcUXNvFNjWc6kP5Xuo0r_sngRg1U,2963
-vim_eof_comment/version.py,sha256=igN9itTpm1CIOrWUoIRc9YcyZdh6Vfq76Ly-oi08nI8,5457
-vim_eof_comment/version.pyi,sha256=tFXP9Be8ChJLKy6MEiiTR9l-0bn5uJMYIOSrvn2LlMQ,3460
+vim_eof_comment/util.py,sha256=0-SUdHqpgMdwHauZawaY3KL5FkIfe1u2zA1AHb80ez8,4125
+vim_eof_comment/util.pyi,sha256=5RQukLgpVZTwbALhBOtd1NqFkiqC-V6JEWeT1_B9-2k,2675
+vim_eof_comment/version.py,sha256=6Mte7F-FCo1MH3e9jn9TRYH3mvUMg7gedL6-ThzYL6c,5686
+vim_eof_comment/version.pyi,sha256=suF5VwVtpA0rVOuKpa6cvJ8TNocXgtJiI51DRrpzOTs,3692
 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=wnN9r5Y-t7r3As558_bAq2XzLqg-HTzR8_ufXU-9bpU,779
-vim_eof_comment/args/completion.pyi,sha256=kB4X_7NaSIuPqL8zbcBszewyLh-evB-9TYfYLOjCU4A,408
+vim_eof_comment/args/completion.py,sha256=ddK6xcpR6SpcGXH7m6m6h9DhB5QMoai324WVvtwwplw,1248
+vim_eof_comment/args/completion.pyi,sha256=svMFBL6vfiqctncHkOMwxzuufzV3y5VfGic3o71UU4o,455
 vim_eof_comment/args/parsing.py,sha256=AOHLN-K0vzbXBwsOjUv4ZcXMDbF_BDEONonZJFwwazo,6617
 vim_eof_comment/args/parsing.pyi,sha256=czQNpDTfgUCv1P_bxHykUD9WDn5A8tnz396TT7oEdkY,1745
 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=cjKvqTx2TflOUWrYqD7vvPDJ7KpPaVr-HrNO3OHrBfA,4736
-vim_eof_comment/comments/generator.py,sha256=lJ8Ux922JebBk-6BjC8ZlkmpXuN-ZeGP6g25EEusvIk,6407
+vim_eof_comment/comments/generator.py,sha256=RuSdZgUVXt9AuqktKkkFfzrxEWw0tqGoy5BofANkgzs,7531
 vim_eof_comment/comments/generator.pyi,sha256=Nj33jwria5FWUuydUD_uZSH__PxSZ3yPxOPYF1_TIpM,3272
-vim_eof_comment-0.3.12.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
-vim_eof_comment-0.3.12.dist-info/METADATA,sha256=ReV25DOt8j3I1MYb1qSF-OF75gVrMkA_CigOYD7azZU,2804
-vim_eof_comment-0.3.12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-vim_eof_comment-0.3.12.dist-info/entry_points.txt,sha256=vm47g4hoUbow4elcHr9yylYfj6IvAs10wSFKqwqTu6E,61
-vim_eof_comment-0.3.12.dist-info/top_level.txt,sha256=TkaQ5vuhVzXaJnfUdcLJCQ81ILK2V6OtvX5-hIMZAc0,21
-vim_eof_comment-0.3.12.dist-info/RECORD,,
+vim_eof_comment-0.3.14.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
+vim_eof_comment-0.3.14.dist-info/METADATA,sha256=bAjhWLOdtEpPGDzpAdZoD8ORu4IelVXqBCKNUdWZFWc,2776
+vim_eof_comment-0.3.14.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+vim_eof_comment-0.3.14.dist-info/entry_points.txt,sha256=vm47g4hoUbow4elcHr9yylYfj6IvAs10wSFKqwqTu6E,61
+vim_eof_comment-0.3.14.dist-info/top_level.txt,sha256=TkaQ5vuhVzXaJnfUdcLJCQ81ILK2V6OtvX5-hIMZAc0,21
+vim_eof_comment-0.3.14.dist-info/RECORD,,