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

docs/source/conf.py

@@ -22,8 +22,10 @@ release: str = '0.1.33'
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions: List[str] = [
+    'numpydoc',
     'sphinx.ext.autodoc',
     'sphinx.ext.autosectionlabel',
+    'sphinx.ext.autosummary',
     'sphinx.ext.duration',
 ]
 
@@ -36,4 +38,19 @@ exclude_patterns: List[str] = []
 html_theme: str = 'sphinx_rtd_theme'
 html_static_path: List[str] = ['_static']
 
+# -- Options for numpydoc ----------------------------------------------------
+numpydoc_xref_param_type = True
+numpydoc_validation_checks = {
+    "all",  # report on all checks, except the below
+    "ES01",
+    "EX01",
+    "SA01",
+}
+numpydoc_xref_aliases = {
+    'TextIO': 'typing.TextIO',
+    'List': 'list',
+    'Dict': 'dict',
+    'Tuple': 'tuple',
+}
+
 # vim: set ts=4 sts=4 sw=4 et ai si sta:

docs/source/index.rst

@@ -18,5 +18,5 @@ Contents
 
 .. toctree::
 
-   usage
+   installation
    functions

docs/source/installation.rst

@@ -0,0 +1,14 @@
+Installation
+============
+
+To install *vim-eof-comment*, first install it using ``pip``:
+
+.. code-block:: console
+
+   $ pip install -U vim-eof-comment
+
+You may also use ``pipenv`` or any other virtual environment:
+
+.. code-block:: console
+
+   $ pipenv install vim-eof-comment

vim_eof_comment/regex.py

@@ -11,7 +11,7 @@ from re import compile
 from typing import Tuple
 
 
-def matches(s: str, verbose: bool) -> bool:
+def matches(s: str, verbose: bool = False) -> bool:
     """
     Check if given string matches any of the given patterns.
 
@@ -19,7 +19,7 @@ def matches(s: str, verbose: bool) -> bool:
     ----------
     s : str
         The string to be matched.
-    verbose : bool
+    verbose : bool, optional, default=False
         Enables verbose mode.
 
     Returns

vim_eof_comment/regex.pyi

@@ -1,6 +1,6 @@
 __all__ = ['matches']
 
-def matches(s: str, verbose: bool) -> bool:
+def matches(s: str, verbose: bool = False) -> bool:
     """
     Check if given string matches any of the given patterns.
 
@@ -8,7 +8,7 @@ def matches(s: str, verbose: bool) -> bool:
     ----------
     s : str
         The string to be matched.
-    verbose : bool
+    verbose : bool, optional, default=False
         Enables verbose mode.
 
     Returns

vim_eof_comment/types.py

@@ -32,15 +32,15 @@ class ParserSpec(TypedDict):
     ----------
     opts : List[str]
         A list containing all the relevant iterations of the same option.
-    kwargs : Dict[str, str]
+    kwargs : Dict[str, Any]
         Extra arguments for ``argparse.ArgumentParser``.
-    completer : argcomplete.DirectoriesCompleter, optional, default=None
-        An optional ``argcomplete`` completer object.
+    completer : argcomplete.DirectoriesCompleter
+        An ``argcomplete`` completer object.
     """
 
     opts: List[str]
     kwargs: Dict[str, Any]
-    completer: DirectoriesCompleter | None
+    completer: DirectoriesCompleter
 
 
 class CommentMap(TypedDict):
@@ -59,7 +59,18 @@ class CommentMap(TypedDict):
 
 
 class IndentMap(TypedDict):
-    """A ``TypedDict`` container."""
+    """
+    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
@@ -69,6 +80,8 @@ class IndentHandler(TypedDict):
     """
     A dict containing ``ft_ext``, ``level`` and ``expandtab`` as keys.
 
+    This is a ``TypedDict``-like object.
+
     Attributes
     ----------
     ft_ext : str
@@ -85,35 +98,92 @@ class IndentHandler(TypedDict):
 
 
 class IOWrapperBool(TypedDict):
-    """A ``TypedDict`` container."""
+    """
+    A dict containing ``file`` and ``has_nwl`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    file : TextIO
+        The opened file as a ``TextIO`` wrapper.
+    has_nwl : bool
+        Whether the file has a newline or not.
+    """
 
     file: TextIO
     has_nwl: bool
 
 
 class LineBool(TypedDict):
-    """A ``TypedDict`` container."""
+    """
+    A dict containing ``line`` and ``has_nwl`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    line : str
+        The last line of the target file.
+    has_nwl : bool
+        Whether the file has a newline or not.
+    """
 
     line: str
     has_nwl: bool
 
 
 class BatchPathDict(TypedDict):
-    """A ``TypedDict`` container."""
+    """
+    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 ``TypedDict`` container."""
+    """
+    A dict containing ``fpath`` and ``ft_ext`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    fpath : str
+        The target file's path.
+    ft_ext : str
+        The file-type/file-extension.
+    """
 
     fpath: str
     ft_ext: str
 
 
 class EOFCommentSearch(TypedDict):
-    """A ``TypedDict`` container."""
+    """
+    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

vim_eof_comment/types.pyi

@@ -14,14 +14,14 @@ class ParserSpec(TypedDict):
     ----------
     opts : List[str]
         A list containing all the relevant iterations of the same option.
-    kwargs : Dict[str, str]
+    kwargs : Dict[str, Any]
         Extra arguments for ``argparse.ArgumentParser``.
-    completer : argcomplete.DirectoriesCompleter, optional, default=None
-        An optional ``argcomplete`` completer object.
+    completer : argcomplete.DirectoriesCompleter
+        An ``argcomplete`` completer object.
     """
     opts: list[str]
     kwargs: dict[str, Any]
-    completer: DirectoriesCompleter | None
+    completer: DirectoriesCompleter
 
 class CommentMap(TypedDict):
     """
@@ -37,7 +37,18 @@ class CommentMap(TypedDict):
     level: int
 
 class IndentMap(TypedDict):
-    """A ``TypedDict`` container."""
+    """
+    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
 
@@ -45,6 +56,8 @@ class IndentHandler(TypedDict):
     """
     A dict containing ``ft_ext``, ``level`` and ``expandtab`` as keys.
 
+    This is a ``TypedDict``-like object.
+
     Attributes
     ----------
     ft_ext : str
@@ -59,27 +72,84 @@ class IndentHandler(TypedDict):
     expandtab: bool
 
 class IOWrapperBool(TypedDict):
-    """A ``TypedDict`` container."""
+    """
+    A dict containing ``file`` and ``has_nwl`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    file : TextIO
+        The opened file as a ``TextIO`` wrapper.
+    has_nwl : bool
+        Whether the file has a newline or not.
+    """
     file: TextIO
     has_nwl: bool
 
 class LineBool(TypedDict):
-    """A ``TypedDict`` container."""
+    """
+    A dict containing ``line`` and ``has_nwl`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    line : str
+        The last line of the target file.
+    has_nwl : bool
+        Whether the file has a newline or not.
+    """
     line: str
     has_nwl: bool
 
 class BatchPathDict(TypedDict):
-    """A ``TypedDict`` container."""
+    """
+    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 ``TypedDict`` container."""
+    """
+    A dict containing ``fpath`` and ``ft_ext`` as keys.
+
+    This is a ``TypedDict``-like object.
+
+    Attributes
+    ----------
+    fpath : str
+        The target file's path.
+    ft_ext : str
+        The file-type/file-extension.
+    """
     fpath: str
     ft_ext: str
 
 class EOFCommentSearch(TypedDict):
-    """A ``TypedDict`` container."""
+    """
+    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_eof_comment/version.py

@@ -218,6 +218,7 @@ version_info: VersionInfo = VersionInfo([
     (0, 3, 9),
     (0, 3, 10),
     (0, 3, 11),
+    (0, 3, 12),
 ])
 
 __version__: str = str(version_info)

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

@@ -1,18 +1,21 @@
 Metadata-Version: 2.4
 Name: vim-eof-comment
-Version: 0.3.11
+Version: 0.3.12
 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>
 License-Expression: GPL-2.0-only
 Project-URL: Issues, https://github.com/DrKJeff16/vim-eof-comment/issues
 Project-URL: Repository, https://github.com/DrKJeff16/vim-eof-comment
+Project-URL: Download, https://github.com/DrKJeff16/vim-eof-comment/releases/latest
 Keywords: eof comments,eof,files,preprocessing,text,vim modeline,vim,vim-eof
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12

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

@@ -1,9 +1,9 @@
 docs/Makefile,sha256=1rYkueTz6GC8AAF0rtOIJIv7sX-hMxVQBumHEqvbFEI,684
 docs/make.bat,sha256=0qjrzODegavKd7LLwmr9ADhaYftiTnBgqOVAL9kApyo,769
-docs/source/conf.py,sha256=QXm85HG5Ii0abjZRRRVPTYnMNAorgViYI0gy2xeMl50,1328
+docs/source/conf.py,sha256=nqU9B3qBpI-hZ8-L2oJuh2xY4Ob-GCD3nN00JiZbRHg,1729
 docs/source/functions.rst,sha256=erouYhzblZATxkA5yB6aUvF8baSvBcPQ9HwySWATTdI,20
-docs/source/index.rst,sha256=4ga-scVigmQiruBFGUwXbYopcpv1JOFMNSPzeUegckU,450
-docs/source/usage.rst,sha256=r5GDHkgDxB35f2Nn_N30wNKqwfQQXKOE66mdrqGHsuE,155
+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
@@ -12,13 +12,13 @@ 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
 vim_eof_comment/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vim_eof_comment/regex.py,sha256=LxL4gu1iwnsTEOTqE0XYrJPhbg2ooodUidrLKqg4lFs,974
-vim_eof_comment/regex.pyi,sha256=p0eI_9fi2QOGdNnViOpYYdvN5hKPVDnVOYM0cU-W4hM,400
-vim_eof_comment/types.py,sha256=Nlm4rMqKvBEgD5LAtoGM5YeGDuKrAFlxdWKoIpHe3qo,2393
-vim_eof_comment/types.pyi,sha256=FYmDZ_aEFA4zKkgLKR7ItgOcTDdu6e0aazQ2X46wHMc,2123
+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=6cxMyb9DatZhrMwGBetbf3PB5mHFko2KjH5i3CC6FdI,5441
+vim_eof_comment/version.py,sha256=igN9itTpm1CIOrWUoIRc9YcyZdh6Vfq76Ly-oi08nI8,5457
 vim_eof_comment/version.pyi,sha256=tFXP9Be8ChJLKy6MEiiTR9l-0bn5uJMYIOSrvn2LlMQ,3460
 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=cjKvqTx2TflOUWrYqD7vvPDJ7KpPaVr-HrNO3OHrBfA,4736
 vim_eof_comment/comments/generator.py,sha256=lJ8Ux922JebBk-6BjC8ZlkmpXuN-ZeGP6g25EEusvIk,6407
 vim_eof_comment/comments/generator.pyi,sha256=Nj33jwria5FWUuydUD_uZSH__PxSZ3yPxOPYF1_TIpM,3272
-vim_eof_comment-0.3.11.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
-vim_eof_comment-0.3.11.dist-info/METADATA,sha256=b67NO5g1nqcgVQH-qZTF31DtaCMKWbkr1EoLRH5rBOk,2616
-vim_eof_comment-0.3.11.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-vim_eof_comment-0.3.11.dist-info/entry_points.txt,sha256=vm47g4hoUbow4elcHr9yylYfj6IvAs10wSFKqwqTu6E,61
-vim_eof_comment-0.3.11.dist-info/top_level.txt,sha256=TkaQ5vuhVzXaJnfUdcLJCQ81ILK2V6OtvX5-hIMZAc0,21
-vim_eof_comment-0.3.11.dist-info/RECORD,,
+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,,

docs/source/usage.rst

@@ -1,11 +0,0 @@
-Usage
-=====
-
-Installation
-------------
-
-To use *vim-eof-comment*, first install it using `pip`:
-
-.. code-block:: console
-
-   $ pip install vim-eof-comment