vim-eof-comment 0.3.11__tar.gz → 0.3.12__tar.gz

{vim_eof_comment-0.3.11 → vim_eof_comment-0.3.12}/Makefile

@@ -43,6 +43,8 @@ lint:
 		vim_eof_comment
 	@pydocstyle --convention=numpy --match='.*\.py' vim_eof_comment
 	@autopep8 --aggressive --aggressive --aggressive --in-place --recursive vim_eof_comment
+	$(eval files := $(shell fd --full-path vim_eof_comment -e py))
+	@numpydoc lint $(files)
 	@echo -e "\nDone!"
 
 stubs: lint

{vim_eof_comment-0.3.11 → vim_eof_comment-0.3.12}/PKG-INFO

@@ -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 → vim_eof_comment-0.3.12}/Pipfile

@@ -13,6 +13,7 @@ pyproject = "*"
 colorama = "*"
 argcomplete = "*"
 python-magic = "*"
+pynvim = "*"
 
 [dev-packages]
 pynvim = "*"

{vim_eof_comment-0.3.11 → vim_eof_comment-0.3.12}/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:

{vim_eof_comment-0.3.11 → vim_eof_comment-0.3.12}/docs/source/index.rst

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

vim_eof_comment-0.3.12/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-0.3.11 → vim_eof_comment-0.3.12}/pyproject.toml

@@ -10,6 +10,8 @@ classifiers = [
     "Intended Audience :: Developers",
     "Intended Audience :: End Users/Desktop",
     "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -45,7 +47,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.3.11"
+version = "0.3.12"
 
     [project.scripts]
     vim-eof-comment = "vim_eof_comment.eof:main"
@@ -53,13 +55,14 @@ version = "0.3.11"
     [project.urls]
     Issues     = "https://github.com/DrKJeff16/vim-eof-comment/issues"
     Repository = "https://github.com/DrKJeff16/vim-eof-comment"
+    Download   = "https://github.com/DrKJeff16/vim-eof-comment/releases/latest"
 
 [tool.numpydoc_validation]
 checks = [
+    "all",  # report on all checks, except the below
     "ES01",
     "EX01",
     "SA01",
-    "all",  # report on all checks, except the below
 ]
 exclude = [
     '\.undocumented_method$',

{vim_eof_comment-0.3.11 → vim_eof_comment-0.3.12}/requirements.txt

@@ -2,7 +2,11 @@
 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'
+greenlet==3.3.0; python_version >= '3.10'
+msgpack==1.1.2; python_version >= '3.9'
+pynvim==0.6.0; python_version >= '3.7'
 pyproject==1!0.1.2; python_version >= '3.12'
+python-magic==0.4.27; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
 setuptools==80.9.0; python_version >= '3.9'
 typing==3.7.4.3; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
 typing-extensions==4.15.0; python_version >= '3.9'

vim_eof_comment-0.3.12/version.txt

@@ -0,0 +1 @@
+0.3.12

{vim_eof_comment-0.3.11 → vim_eof_comment-0.3.12}/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-0.3.11 → vim_eof_comment-0.3.12}/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-0.3.11 → vim_eof_comment-0.3.12}/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-0.3.12/vim_eof_comment/types.pyi

@@ -0,0 +1,157 @@
+from typing import Any, TextIO, TypedDict
+
+from argcomplete.completers import DirectoriesCompleter
+
+__all__ = ['BatchPairDict', 'BatchPathDict', 'CommentMap', 'EOFCommentSearch', 'IOWrapperBool', 'IndentHandler', 'IndentMap', 'LineBool', 'ParserSpec']
+
+class ParserSpec(TypedDict):
+    """
+    Stores the spec for ``argparse`` operations in a constant value.
+
+    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: 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 ``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 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 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
+    ----------
+    fpath : str
+        The target file's path.
+    ft_ext : str
+        The file-type/file-extension.
+    """
+    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:

{vim_eof_comment-0.3.11 → vim_eof_comment-0.3.12}/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 → vim_eof_comment-0.3.12}/vim_eof_comment.egg-info/PKG-INFO

@@ -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 → vim_eof_comment-0.3.12}/vim_eof_comment.egg-info/SOURCES.txt

@@ -1,13 +1,13 @@
 .flake8
 .gitattributes
 .pre-commit-config.yaml
-.taplo.toml
 LICENSE
 Makefile
 Pipfile
 README.md
 pyproject.toml
 requirements.txt
+taplo.toml
 version.txt
 .github/CODEOWNERS
 .github/workflows/flake8-lint.yml
@@ -18,7 +18,7 @@ docs/make.bat
 docs/source/conf.py
 docs/source/functions.rst
 docs/source/index.rst
-docs/source/usage.rst
+docs/source/installation.rst
 vim_eof_comment/__init__.py
 vim_eof_comment/__init__.pyi
 vim_eof_comment/__main__.py

vim_eof_comment-0.3.11/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

vim_eof_comment-0.3.11/version.txt

@@ -1 +0,0 @@
-0.3.11

vim_eof_comment-0.3.11/vim_eof_comment/types.pyi

@@ -1,87 +0,0 @@
-from typing import Any, TextIO, TypedDict
-
-from argcomplete.completers import DirectoriesCompleter
-
-__all__ = ['BatchPairDict', 'BatchPathDict', 'CommentMap', 'EOFCommentSearch', 'IOWrapperBool', 'IndentHandler', 'IndentMap', 'LineBool', 'ParserSpec']
-
-class ParserSpec(TypedDict):
-    """
-    Stores the spec for ``argparse`` operations in a constant value.
-
-    This is a ``TypedDict``-like object.
-
-    Attributes
-    ----------
-    opts : List[str]
-        A list containing all the relevant iterations of the same option.
-    kwargs : Dict[str, str]
-        Extra arguments for ``argparse.ArgumentParser``.
-    completer : argcomplete.DirectoriesCompleter, optional, default=None
-        An optional ``argcomplete`` completer object.
-    """
-    opts: list[str]
-    kwargs: dict[str, Any]
-    completer: DirectoriesCompleter | None
-
-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 ``TypedDict`` container."""
-    level: int
-    expandtab: bool
-
-class IndentHandler(TypedDict):
-    """
-    A dict containing ``ft_ext``, ``level`` and ``expandtab`` as keys.
-
-    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 ``TypedDict`` container."""
-    file: TextIO
-    has_nwl: bool
-
-class LineBool(TypedDict):
-    """A ``TypedDict`` container."""
-    line: str
-    has_nwl: bool
-
-class BatchPathDict(TypedDict):
-    """A ``TypedDict`` container."""
-    file: TextIO
-    ft_ext: str
-
-class BatchPairDict(TypedDict):
-    """A ``TypedDict`` container."""
-    fpath: str
-    ft_ext: str
-
-class EOFCommentSearch(TypedDict):
-    """A ``TypedDict`` container."""
-    state: IOWrapperBool
-    lang: str
-    match: bool
-
-# vim: set ts=4 sts=4 sw=4 et ai si sta: