docstringify 2.0.0__tar.gz → 2.0.1__tar.gz

{docstringify-2.0.0 → docstringify-2.0.1}/.github/workflows/ci.yml

@@ -46,10 +46,10 @@ jobs:
             python-version: ["3.11", "3.12", "3.13", "3.14"]
 
     steps:
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0  # v7.0.0
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6.2.0
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1  # v6.3.0
         with:
           python-version: ${{ matrix.python-version }}
 

{docstringify-2.0.0 → docstringify-2.0.1}/.github/workflows/pypi-publish.yml

@@ -10,9 +10,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
+    - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0  # v7.0.0
     - name: Set up Python
-      uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6.2.0
+      uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1  # v6.3.0
       with:
         python-version: "3.x"
     - name: Install pypa/build
@@ -49,7 +49,7 @@ jobs:
         name: python-package-distributions
         path: dist/
     - name: Publish distribution 📦 to PyPI
-      uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b  # v1.14.0
+      uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33  # v1.14.2
 
   github-release:
     name: >-
@@ -70,7 +70,7 @@ jobs:
         name: python-package-distributions
         path: dist/
     - name: Sign the dists with Sigstore
-      uses: sigstore/gh-action-sigstore-python@04cffa1d795717b140764e8b640de88853c92acc  # v3.3.0
+      uses: sigstore/gh-action-sigstore-python@5b79a39c381910c090341a2c9b0bf022c8b387e1  # v3.4.0
       with:
         inputs: >-
           ./dist/*.tar.gz
@@ -115,6 +115,6 @@ jobs:
         name: python-package-distributions
         path: dist/
     - name: Publish distribution 📦 to TestPyPI
-      uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b  # v1.14.0
+      uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33  # v1.14.2
       with:
         repository-url: https://test.pypi.org/legacy/

{docstringify-2.0.0 → docstringify-2.0.1}/.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 ci:
-  autofix_prs: false
+  autofix_prs: true
   autoupdate_schedule: quarterly
 
 repos:
@@ -12,7 +12,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.4.2
+    rev: v2.4.3
     hooks:
       - id: codespell
         additional_dependencies:
@@ -20,13 +20,13 @@ repos:
         exclude: (\.(svg|png|pdf)$)|(CODE_OF_CONDUCT.md)
 
   - repo: https://github.com/numpy/numpydoc
-    rev: v1.10.0
+    rev: v1.11.0
     hooks:
       - id: numpydoc-validation
         exclude: (tests|docs)/.*
 
   - repo: https://github.com/stefmolin/docstringify
-    rev: 1decb1a66b512ab792fdc0d190a7ba761b3d70fd
+    rev: 2.0.0
     hooks:
       - id: docstringify-edit
         name: docstringify source code with numpydoc style
@@ -38,14 +38,14 @@ repos:
         files: tests/.*
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.12
+    rev: v0.16.10
     hooks:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix, --show-fixes]
       - id: ruff-format
 
   - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: v2.21.1
+    rev: v2.30.1
     hooks:
       - id: pyproject-fmt
         args: [--keep-full-version, --no-print-diff]

{docstringify-2.0.0 → docstringify-2.0.1}/.pre-commit-hooks.yaml

@@ -24,13 +24,3 @@
   language: python
   require_serial: true
   types: [python]
-
-- id: docstringify
-  name: docstringify (deprecated)
-  description: >-
-    Flag missing docstrings and, optionally, generate them from signatures
-    and type annotations.
-  entry: docstringify
-  language: python
-  require_serial: true
-  types: [python]

{docstringify-2.0.0 → docstringify-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: docstringify
-Version: 2.0.0
+Version: 2.0.1
 Summary: Flag missing docstrings and, optionally, generate them from signatures and type annotations.
 Project-URL: Documentation, https://github.com/stefmolin/docstringify
 Project-URL: Homepage, https://github.com/stefmolin/docstringify
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 
@@ -104,6 +105,7 @@ You can use Docstringify in three modes:
     ```python
     """__description__"""
 
+
     def say_hello(name: str = 'World') -> None:
         """
         __description__

{docstringify-2.0.0 → docstringify-2.0.1}/README.md

@@ -83,6 +83,7 @@ You can use Docstringify in three modes:
     ```python
     """__description__"""
 
+
     def say_hello(name: str = 'World') -> None:
         """
         __description__

{docstringify-2.0.0 → docstringify-2.0.1}/pyproject.toml

@@ -1,10 +1,9 @@
 [build-system]
 build-backend = "hatchling.build"
-requires = [ "hatchling" ]
+requires = [ "hatch-vcs", "hatchling" ]
 
 [project]
 name = "docstringify"
-version = "2.0.0"
 description = "Flag missing docstrings and, optionally, generate them from signatures and type annotations."
 readme = "README.md"
 keywords = [
@@ -28,7 +27,9 @@ classifiers = [
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3.15",
 ]
+dynamic = [ "version" ]
 dependencies = []
 urls.Documentation = "https://github.com/stefmolin/docstringify"
 urls.Homepage = "https://github.com/stefmolin/docstringify"
@@ -38,16 +39,19 @@ scripts.docstringify = "docstringify.cli:main"
 [dependency-groups]
 dev = [ "pre-commit", { include-group = "test" } ]
 test = [
-  "pytest>=8.3.4",
+  "pytest>=9.0.3",
   "pytest-cov>=4.1.0",
   "pytest-randomly>=3.12.0",
 ]
 
+[tool.hatch]
+version.source = "vcs"
+
 [tool.ruff]
 line-length = 88
 format.indent-style = "space"
 format.quote-style = "single"
-format.skip-magic-trailing-comma = false
+format.skip-magic-trailing-comma = true
 format.docstring-code-format = true
 lint.select = [
   "ANN",  # flake8-annotations
@@ -94,11 +98,13 @@ checks = [
   "SA01", # or a see also section
   "SS06", # and don't require the summary to fit on one line
 ]
-exclude = [  # don't report on checks for these
+exclude = [
+  # don't report on checks for these
   "\\.__init__$",
   "\\.__repr__$",
   "\\.__str__$",
 ]
-override_SS05 = [  # allow docstrings to start with these words
+override_SS05 = [
+  # allow docstrings to start with these words
   "^Unambiguous ",
 ]

{docstringify-2.0.0 → docstringify-2.0.1}/src/docstringify/nodes/base.py

@@ -28,11 +28,7 @@ class DocstringNode:
 
     @overload
     def __init__(
-        self,
-        node: ast.Module,
-        module_name: str,
-        source_code: str,
-        parent: None = None,
+        self, node: ast.Module, module_name: str, source_code: str, parent: None = None
     ) -> None: ...
 
     @overload

{docstringify-2.0.0 → docstringify-2.0.1}/src/docstringify/nodes/function.py

@@ -141,7 +141,7 @@ class FunctionDocstringNode(DocstringNode):
             return self.get_source_segment(arg.annotation) or PARAMETER_TYPE_PLACEHOLDER
 
     def _extract_default_values(
-        self, default: ast.Constant | None | Literal[NO_DEFAULT], is_keyword_only: bool
+        self, default: ast.Constant | Literal[NO_DEFAULT] | None, is_keyword_only: bool
     ) -> str | Literal[NO_DEFAULT]:
         """
         Extract the argument's default value.

{docstringify-2.0.0 → docstringify-2.0.1}/src/docstringify/traversal/__init__.py

@@ -3,7 +3,4 @@
 from .transformer import DocstringTransformer
 from .visitor import DocstringVisitor
 
-__all__ = [
-    'DocstringTransformer',
-    'DocstringVisitor',
-]
+__all__ = ['DocstringTransformer', 'DocstringVisitor']

{docstringify-2.0.0 → docstringify-2.0.1}/src/docstringify/traversal/transformer.py

@@ -164,9 +164,7 @@ class DocstringTransformer(ast.NodeTransformer, DocstringVisitor):
             output_lines.append(
                 indent(
                     self.docstring_converter.format_docstring(
-                        docstring.splitlines(),
-                        indent=0,
-                        quote=True,
+                        docstring.splitlines(), indent=0, quote=True
                     )
                     + (f'\n{suffix}' if suffix else ''),
                     ' ' * prefix,
@@ -199,8 +197,7 @@ class DocstringTransformer(ast.NodeTransformer, DocstringVisitor):
         )
 
         suggested_docstring = self.docstring_converter.suggest_docstring(
-            docstring_node,
-            indent=indent,
+            docstring_node, indent=indent
         )
         docstring_ast_node = ast.Expr(ast.Constant(suggested_docstring))
 

{docstringify-2.0.0 → docstringify-2.0.1}/src/docstringify/traversal/visitor.py

@@ -135,30 +135,22 @@ class DocstringVisitor(ast.NodeVisitor):
 
     @overload
     def visit_docstring(
-        self,
-        node: ast.Module,
-        docstring_class: type[DocstringNode],
+        self, node: ast.Module, docstring_class: type[DocstringNode]
     ) -> ast.Module: ...
 
     @overload
     def visit_docstring(
-        self,
-        node: ast.ClassDef,
-        docstring_class: type[DocstringNode],
+        self, node: ast.ClassDef, docstring_class: type[DocstringNode]
     ) -> ast.ClassDef: ...
 
     @overload
     def visit_docstring(
-        self,
-        node: ast.FunctionDef,
-        docstring_class: type[FunctionDocstringNode],
+        self, node: ast.FunctionDef, docstring_class: type[FunctionDocstringNode]
     ) -> ast.FunctionDef: ...
 
     @overload
     def visit_docstring(
-        self,
-        node: ast.AsyncFunctionDef,
-        docstring_class: type[FunctionDocstringNode],
+        self, node: ast.AsyncFunctionDef, docstring_class: type[FunctionDocstringNode]
     ) -> ast.AsyncFunctionDef: ...
 
     def visit_docstring(