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

vim_eof_comment/file.py

@@ -5,7 +5,15 @@ File management utilities.
 
 Copyright (c) 2025 Guennadi Maximov C. All Rights Reserved.
 """
-__all__ = ["bootstrap_paths", "open_batch_paths", "modify_file", "get_last_line"]
+__all__ = [
+    "EXCLUDED_DIRS",
+    "bootstrap_paths",
+    "get_last_line",
+    "has_excluded",
+    "modify_file",
+    "open_batch_paths",
+    "try_open",
+]
 
 from io import TextIOWrapper
 from os import walk
@@ -15,6 +23,64 @@ from typing import Dict, List
 from .types import BatchPairDict, BatchPathDict, LineBool
 from .util import die, error
 
+EXCLUDED_DIRS: List[str] = [
+    ".git",
+    ".mypy_cache",
+    ".ropeproject",
+    ".venv",
+    "build",
+    "venv",
+]
+
+
+def try_open(fpath: str) -> bool:
+    """
+    Try to open a file, unless a ``UnicodeDecodeError`` triggers.
+
+    Parameters
+    ----------
+    fpath : str
+        The file path to try and open.
+
+    Returns
+    -------
+    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)
+
+    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]:
     """
@@ -34,11 +100,22 @@ def bootstrap_paths(paths: List[str], exts: List[str]) -> List[BatchPairDict]:
     """
     result = list()
     for path in paths:
-        if not isdir(path):
+        if not isdir(path) or has_excluded(path):
             continue
 
-        file: str
+        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):
@@ -66,6 +143,9 @@ def open_batch_paths(paths: List[BatchPairDict]) -> Dict[str, BatchPathDict]:
     result = 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}
         except KeyboardInterrupt:

vim_eof_comment/file.pyi

@@ -2,8 +2,38 @@ from io import TextIOWrapper
 
 from .types import BatchPairDict, BatchPathDict, LineBool
 
-__all__ = ['bootstrap_paths', 'open_batch_paths', 'modify_file', 'get_last_line']
+__all__ = ['EXCLUDED_DIRS', 'bootstrap_paths', 'get_last_line', 'has_excluded', 'modify_file', 'open_batch_paths', 'try_open']
 
+EXCLUDED_DIRS: list[str]
+
+def try_open(fpath: str) -> bool:
+    """
+    Try to open a file, unless a ``UnicodeDecodeError`` triggers.
+
+    Parameters
+    ----------
+    fpath : str
+        The file path to try and open.
+
+    Returns
+    -------
+    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/version.py

@@ -227,6 +227,8 @@ version_info = VersionInfo([
     (0, 3, 18),
     (0, 3, 19),
     (0, 3, 20),
+    (0, 3, 21),
+    (0, 4, 0),
 ])
 
 __version__: str = str(version_info)

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

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

@@ -9,8 +9,8 @@ vim_eof_comment/__init__.pyi,sha256=Eh8FQwE_F9TrQEiT7CR1mdGHBT6fHUzfV6VP8uSN33g,
 vim_eof_comment/__main__.py,sha256=0AFVSkz8RuxSuPbJJWycyxs6u5Yypl8FKUMR3ZVLJbk,343
 vim_eof_comment/eof.py,sha256=JpU5v_V_4fIaWt0BJfPvgp-0ZjzhDdyj_otpusIa7a8,5160
 vim_eof_comment/eof.pyi,sha256=BTw9brhrHBTX12fYuwfO8_D-Gyrf0387ErmgrcTdvh0,1786
-vim_eof_comment/file.py,sha256=U-WEd53Xh1XcEePueJuoRn7awXynb5uHkYUT6dqgOMM,4277
-vim_eof_comment/file.pyi,sha256=BWBtHbFkAdiNSRfe9SQBJvxtH3WHZfIgz03kFsIWX4w,1950
+vim_eof_comment/file.py,sha256=jNssQBOgT8Smrqb7fiQf2VGWRN0wHppRA4MMd6EYAJo,5818
+vim_eof_comment/file.pyi,sha256=Jelb8dvvqN6IfdX-WvRIgeVhcjdQhT6Qamq9lwlxRy0,2606
 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
@@ -18,7 +18,7 @@ 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/util.pyi,sha256=5RQukLgpVZTwbALhBOtd1NqFkiqC-V6JEWeT1_B9-2k,2675
-vim_eof_comment/version.py,sha256=mWLHDCOShWmvUY_-CMyPJrXpbuxuT6D84eBBJljuudM,5782
+vim_eof_comment/version.py,sha256=zjS4fTklwWgIGEEbmhNg-H-iFITfpbr5clLMpAppd5s,5813
 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
@@ -31,9 +31,9 @@ vim_eof_comment/comments/__init__.pyi,sha256=cecbbrShh0If8btwJ8zKYpBt9dIsMwrDXbd
 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.pyi,sha256=Nj33jwria5FWUuydUD_uZSH__PxSZ3yPxOPYF1_TIpM,3272
-vim_eof_comment-0.3.20.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
-vim_eof_comment-0.3.20.dist-info/METADATA,sha256=8Ott95u7WkAzYD_8roT2jq0e91TUA8BkAw99unYhpGI,2763
-vim_eof_comment-0.3.20.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-vim_eof_comment-0.3.20.dist-info/entry_points.txt,sha256=vm47g4hoUbow4elcHr9yylYfj6IvAs10wSFKqwqTu6E,61
-vim_eof_comment-0.3.20.dist-info/top_level.txt,sha256=TkaQ5vuhVzXaJnfUdcLJCQ81ILK2V6OtvX5-hIMZAc0,21
-vim_eof_comment-0.3.20.dist-info/RECORD,,
+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,,