vim-eof-comment 0.4.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

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/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/comments/generator.py

@@ -108,7 +108,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 +117,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/eof.py

@@ -77,7 +77,7 @@ def eof_comment_search(
         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, "rb"), had_nwl=had_nwl),
+                state=IOWrapperBool(file=open(path, "r"), had_nwl=had_nwl),
                 lang=ext,
                 match=matches(last_line, verbose)
             )
@@ -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/file.py

@@ -6,10 +6,8 @@ File management utilities.
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
 __all__ = [
-    "EXCLUDED_DIRS",
     "bootstrap_paths",
     "get_last_line",
-    "has_excluded",
     "modify_file",
     "open_batch_paths",
     "try_open",
@@ -47,41 +45,18 @@ def try_open(fpath: str) -> bool:
     bool
         Whether the file triggers a ``UnicodeDecodeError`` or not.
     """
-    file = open(fpath, "rb")
-    success: bool = True
-    try:
-        file.read().decode(encoding="utf8")
-    except UnicodeDecodeError:
-        success = False
-    except Exception:
-        die("Something went wrong in `try_open()`!", code=2)
+    with open(fpath, "r") as file:
+        success: bool = True
+        try:
+            file.read()
+        except UnicodeDecodeError:
+            success = False
+        except Exception:
+            die("Something went wrong in `try_open()`!", code=2)
 
-    file.close()
     return success
 
 
-def has_excluded(dir: str) -> bool:
-    """
-    Check whether a directory list contains any excluded directories.
-
-    Parameters
-    ----------
-    dir : str
-        The directory to check.
-
-    Returns
-    -------
-    bool
-        Whether an excluded directory was found.
-    """
-    dir = dir.rstrip("/")
-    for excluded in EXCLUDED_DIRS:
-        if dir.endswith(excluded):
-            return True
-
-    return False
-
-
 def bootstrap_paths(paths: List[str], exts: List[str]) -> List[BatchPairDict]:
     """
     Bootstrap all the matching paths in current dir and below.
@@ -100,22 +75,13 @@ def bootstrap_paths(paths: List[str], exts: List[str]) -> List[BatchPairDict]:
     """
     result = list()
     for path in paths:
-        if not isdir(path) or has_excluded(path):
+        if not isdir(path):
             continue
 
         root: str
         dirs: List[str]
         files: List[str]
         for root, dirs, files in walk(path):
-            excluded = False
-            for dir in dirs:
-                if has_excluded(dir):
-                    excluded = True
-                    break
-
-            if excluded:
-                continue
-
             for file in files:
                 for ext in exts:
                     if not file.endswith(ext):
@@ -140,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, "rb"), "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:
@@ -181,7 +147,7 @@ def modify_file(file: TextIOWrapper, comments: Dict[str, str], ext: str, **kwarg
     matching: bool = kwargs.get("matching", False)
     newline: bool = kwargs.get("newline", False)
 
-    bdata: str = file.read().decode(encoding="utf8")
+    bdata: str = file.read()
     data: List[str] = bdata.split("\n")
     file.close()
 
@@ -224,7 +190,7 @@ def get_last_line(file: TextIOWrapper) -> LineBool:
     LineBool
         An object containing both the last line in a string and a boolean indicating a newline.
     """
-    bdata: str = file.read().decode(encoding="utf8")
+    bdata: str = file.read()
     data: List[str] = bdata.split("\n")
     file.close()
 

vim_eof_comment/file.pyi

@@ -2,9 +2,7 @@ from io import TextIOWrapper
 
 from .types import BatchPairDict, BatchPathDict, LineBool
 
-__all__ = ['EXCLUDED_DIRS', 'bootstrap_paths', 'get_last_line', 'has_excluded', 'modify_file', 'open_batch_paths', 'try_open']
-
-EXCLUDED_DIRS: list[str]
+__all__ = ['bootstrap_paths', 'get_last_line', 'modify_file', 'open_batch_paths', 'try_open']
 
 def try_open(fpath: str) -> bool:
     """
@@ -20,20 +18,6 @@ def try_open(fpath: str) -> bool:
     bool
         Whether the file triggers a ``UnicodeDecodeError`` or not.
     """
-def has_excluded(dir: str) -> bool:
-    """
-    Check whether a directory list contains any excluded directories.
-
-    Parameters
-    ----------
-    dir : str
-        The directory to check.
-
-    Returns
-    -------
-    bool
-        Whether an excluded directory was found.
-    """
 def bootstrap_paths(paths: list[str], exts: list[str]) -> list[BatchPairDict]:
     """
     Bootstrap all the matching paths in current dir and below.

vim_eof_comment/types.py

@@ -19,7 +19,7 @@ __all__ = [
 
 from typing import Any, Dict, List, TextIO, TypedDict
 
-from argcomplete.completers import DirectoriesCompleter
+import argcomplete
 
 
 class ParserSpec(TypedDict):
@@ -40,7 +40,7 @@ class ParserSpec(TypedDict):
 
     opts: List[str]
     kwargs: Dict[str, Any]
-    completer: DirectoriesCompleter
+    completer: argcomplete.DirectoriesCompleter
 
 
 class CommentMap(TypedDict):

vim_eof_comment/types.pyi

@@ -1,6 +1,6 @@
 from typing import Any, TextIO, TypedDict
 
-from argcomplete.completers import DirectoriesCompleter
+import argcomplete
 
 __all__ = ['BatchPairDict', 'BatchPathDict', 'CommentMap', 'EOFCommentSearch', 'IOWrapperBool', 'IndentHandler', 'IndentMap', 'LineBool', 'ParserSpec']
 
@@ -21,7 +21,7 @@ class ParserSpec(TypedDict):
     """
     opts: list[str]
     kwargs: dict[str, Any]
-    completer: DirectoriesCompleter
+    completer: argcomplete.DirectoriesCompleter
 
 class CommentMap(TypedDict):
     """

vim_eof_comment/util.py

@@ -5,7 +5,12 @@ EOF comments checker utilities.
 
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
-__all__ = ["die", "error", "gen_indent_maps", "verbose_print"]
+__all__ = [
+    "die",
+    "error",
+    "gen_indent_maps",
+    "verbose_print",
+]
 
 from sys import exit as Exit
 from sys import stderr, stdout
@@ -15,7 +20,7 @@ from .types import IndentHandler, IndentMap
 
 
 def error(*msg, **kwargs) -> NoReturn:
-    r"""
+    """
     Print to stderr.
 
     Parameters
@@ -29,11 +34,14 @@ def error(*msg, **kwargs) -> NoReturn:
     --------
     print : This function is essentially being wrapped around here.
     """
-    print(*msg, file=stderr, **kwargs)
+    end: str = kwargs.get("end", "\n")
+    sep: str = kwargs.get("sep", " ")
+    flush: bool = kwargs.get("flush", False)
+    print(*msg, file=stderr, end=end, sep=sep, flush=flush)
 
 
 def die(*msg, code: int = 0, func: Callable[[TextIO], None] | None = None, **kwargs) -> NoReturn:
-    r"""
+    """
     Kill the program execution.
 
     Summons ``sys.exit()`` with a provided code and optionally prints code to stderr or stdout
@@ -107,13 +115,13 @@ def verbose_print(*msg, verbose: bool | None = None, **kwargs) -> NoReturn:
     --------
     print : This function is essentially being wrapped around here.
     """
+    if verbose is None or not verbose:
+        return
+
     end: str = kwargs.get("end", "\n")
     sep: str = kwargs.get("sep", " ")
     flush: bool = kwargs.get("flush", False)
 
-    if verbose is None or not verbose:
-        return
-
     print(*msg, end=end, sep=sep, flush=flush)
 
 
@@ -150,10 +158,10 @@ def gen_indent_maps(maps: List[IndentHandler]) -> Dict[str, IndentMap] | None:
             continue
 
         mapping_len = mapping_len if mapping_len <= 3 else 3
-        map_d[ext] = {
-            "level": level,
-            "expandtab": True if mapping_len == 2 else mapping["expandtab"],
-        }
+        map_d[ext] = IndentMap(
+            level=level,
+            expandtab=True if mapping_len == 2 else mapping["expandtab"]
+        )
 
     return map_d
 

vim_eof_comment/version.py

@@ -229,6 +229,8 @@ version_info = VersionInfo([
     (0, 3, 20),
     (0, 3, 21),
     (0, 4, 0),
+    (0, 4, 1),
+    (0, 4, 2),
 ])
 
 __version__: str = str(version_info)

{vim_eof_comment-0.4.0.dist-info → vim_eof_comment-0.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vim-eof-comment
-Version: 0.4.0
+Version: 0.4.2
 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>
@@ -30,8 +30,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.0.dist-info → vim_eof_comment-0.4.2.dist-info}/RECORD

@@ -7,33 +7,33 @@ 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=JpU5v_V_4fIaWt0BJfPvgp-0ZjzhDdyj_otpusIa7a8,5160
+vim_eof_comment/eof.py,sha256=3iCP_fL3aUrPndKve3DoSpikZSvyIR0kwaE46EAlJqA,5158
 vim_eof_comment/eof.pyi,sha256=BTw9brhrHBTX12fYuwfO8_D-Gyrf0387ErmgrcTdvh0,1786
-vim_eof_comment/file.py,sha256=jNssQBOgT8Smrqb7fiQf2VGWRN0wHppRA4MMd6EYAJo,5818
-vim_eof_comment/file.pyi,sha256=Jelb8dvvqN6IfdX-WvRIgeVhcjdQhT6Qamq9lwlxRy0,2606
+vim_eof_comment/file.py,sha256=HNtwUMteUeKldBcVJEjdxlHLWNDXPbgjswJ-9PKRlQA,5100
+vim_eof_comment/file.pyi,sha256=S02kb4Ta5kDXpC3fYAVboC89jSUzHv6AHoll5HMICUg,2265
 vim_eof_comment/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vim_eof_comment/regex.py,sha256=rGfFIBMbfWlIxAScXqvgBlB-tMJBUxQwTVjEkoxDZ3o,1007
 vim_eof_comment/regex.pyi,sha256=LJt6HN9s0Vo1B5plpaYURVZ3okmtl5jnV6kKdn1KyqA,433
-vim_eof_comment/types.py,sha256=ofo6X9sbNG1ONsofMFganJPlYYsCZmriMWuZHj7dukg,3832
-vim_eof_comment/types.pyi,sha256=dJcnOLxqVShYHSyafbNZEQJ4D3MC42A-oDtlJArApRE,3562
-vim_eof_comment/util.py,sha256=0-SUdHqpgMdwHauZawaY3KL5FkIfe1u2zA1AHb80ez8,4125
+vim_eof_comment/types.py,sha256=YTFbh0YWYKc8IVDmn45RrD0fP2jmUKA5v9GK1TSk6Jk,3807
+vim_eof_comment/types.pyi,sha256=hBRWM3D6t-v8z5u2XQyDXUZImDQT_3oPcA1fsLwmLho,3537
+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=zjS4fTklwWgIGEEbmhNg-H-iFITfpbr5clLMpAppd5s,5813
+vim_eof_comment/version.py,sha256=aFNpBVEBQbzfxw3Jq_zUJYJKT54gA9D-JVvjRJ8qYDY,5843
 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=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/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=Mi3Yi0j-8aXQnVUsXqI1VE1yW71tWemooWgO9smSilI,7731
+vim_eof_comment/comments/generator.py,sha256=tnFDM4X8KdH1zHSeceYiyskAGqfsR8yFJzOakesMa-E,7756
 vim_eof_comment/comments/generator.pyi,sha256=Nj33jwria5FWUuydUD_uZSH__PxSZ3yPxOPYF1_TIpM,3272
-vim_eof_comment-0.4.0.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
-vim_eof_comment-0.4.0.dist-info/METADATA,sha256=UdfTEL_GC35_ulmY7fBAt0rdsBKijKG_YpLDeQtNoPA,2762
-vim_eof_comment-0.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-vim_eof_comment-0.4.0.dist-info/entry_points.txt,sha256=vm47g4hoUbow4elcHr9yylYfj6IvAs10wSFKqwqTu6E,61
-vim_eof_comment-0.4.0.dist-info/top_level.txt,sha256=TkaQ5vuhVzXaJnfUdcLJCQ81ILK2V6OtvX5-hIMZAc0,21
-vim_eof_comment-0.4.0.dist-info/RECORD,,
+vim_eof_comment-0.4.2.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
+vim_eof_comment-0.4.2.dist-info/METADATA,sha256=YJfEqi88QwH8ulUWHnVI8s0jXDwKZb0qWljE0B9E-xQ,2715
+vim_eof_comment-0.4.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+vim_eof_comment-0.4.2.dist-info/entry_points.txt,sha256=vm47g4hoUbow4elcHr9yylYfj6IvAs10wSFKqwqTu6E,61
+vim_eof_comment-0.4.2.dist-info/top_level.txt,sha256=TkaQ5vuhVzXaJnfUdcLJCQ81ILK2V6OtvX5-hIMZAc0,21
+vim_eof_comment-0.4.2.dist-info/RECORD,,