ansys-pre-commit-hooks 0.4.1__tar.gz → 0.4.3__tar.gz

{ansys_pre_commit_hooks-0.4.1/src/ansys_pre_commit_hooks.egg-info → ansys_pre_commit_hooks-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-pre-commit-hooks
-Version: 0.4.1
+Version: 0.4.3
 Summary: A Python wrapper to create Ansys-tailored pre-commit hooks
 Home-page: https://github.com/ansys/pre-commit-hooks
 Author: ANSYS, Inc.
@@ -25,20 +25,20 @@ Requires-Python: >=3.9,<4
 License-File: LICENSE
 License-File: AUTHORS.md
 Requires-Dist: GitPython==3.1.43
-Requires-Dist: importlib-metadata==8.0.0
+Requires-Dist: importlib-metadata==8.2.0
 Requires-Dist: Jinja2==3.1.4
-Requires-Dist: reuse==3.0.2
+Requires-Dist: reuse==4.0.3
 Requires-Dist: requests==2.32.3
 Requires-Dist: semver==3.0.2
 Requires-Dist: toml==0.10.2
 Provides-Extra: doc
 Requires-Dist: ansys-sphinx-theme[autoapi]==0.16.6; extra == "doc"
 Requires-Dist: numpydoc==1.7.0; extra == "doc"
-Requires-Dist: sphinx==7.4.0; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints==2.2.2; extra == "doc"
+Requires-Dist: sphinx==7.4.7; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==2.2.3; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.1; extra == "doc"
 Provides-Extra: tests
-Requires-Dist: pytest==8.2.2; extra == "tests"
+Requires-Dist: pytest==8.3.2; extra == "tests"
 Requires-Dist: pytest-cov==5.0.0; extra == "tests"
 
 Ansys pre-commit hooks
@@ -80,7 +80,7 @@ Currently, these hooks are available:
   `REUSE <https://reuse.software/>`_ . To use this hook, you must
   have ``REUSE`` implemented in your repository.
 * ``tech-review``: Do a technical review of your repository according to
-  `Ansys repository requirements <https://dev.docs.pyansys.com/packaging/structure.html>`_`
+  `Ansys repository requirements <https://dev.docs.pyansys.com/packaging/structure.html>`_
 
 ``add-license-headers`` setup
 -----------------------------
@@ -127,7 +127,7 @@ Set custom arguments
 .. code:: yaml
 
    - repo: https://github.com/ansys/pre-commit-hooks
-   rev: v0.4.1
+   rev: v0.4.3
    hooks:
    - id: add-license-headers
      args: ["--custom_copyright", "custom copyright phrase", "--custom_template", "template_name", "--custom_license", "license_name", "--ignore_license_check", "--start_year", "2023"]
@@ -172,7 +172,7 @@ the hook should run on, add the necessary regex to the ``files`` line in your
 .. code:: yaml
 
    - repo: https://github.com/ansys/pre-commit-hooks
-     rev: v0.4.1
+     rev: v0.4.3
      hooks:
      - id: add-license-headers
        files: '(src|examples|tests|newFolder)/.*\.(py|newExtension)|\.(proto|newExtension)'
@@ -185,7 +185,7 @@ In .pre-commit-config.yaml:
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.4.1
+    rev: v0.4.3
     hooks:
     - id: add-license-headers
       exclude: |
@@ -238,7 +238,7 @@ Technical review hook in ``ansys/pre-commit-hooks``' .pre-commit-config.yaml fil
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.4.1
+    rev: v0.4.3
     hooks:
     - id: tech-review
       args:
@@ -250,7 +250,7 @@ Technical review hook in ``PyMechanical``'s .pre-commit-config.yaml file:
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.4.1
+    rev: v0.4.3
     hooks:
     - id: tech-review
       args:

{ansys_pre_commit_hooks-0.4.1 → ansys_pre_commit_hooks-0.4.3}/README.rst

@@ -37,7 +37,7 @@ Currently, these hooks are available:
   `REUSE <https://reuse.software/>`_ . To use this hook, you must
   have ``REUSE`` implemented in your repository.
 * ``tech-review``: Do a technical review of your repository according to
-  `Ansys repository requirements <https://dev.docs.pyansys.com/packaging/structure.html>`_`
+  `Ansys repository requirements <https://dev.docs.pyansys.com/packaging/structure.html>`_
 
 ``add-license-headers`` setup
 -----------------------------
@@ -84,7 +84,7 @@ Set custom arguments
 .. code:: yaml
 
    - repo: https://github.com/ansys/pre-commit-hooks
-   rev: v0.4.1
+   rev: v0.4.3
    hooks:
    - id: add-license-headers
      args: ["--custom_copyright", "custom copyright phrase", "--custom_template", "template_name", "--custom_license", "license_name", "--ignore_license_check", "--start_year", "2023"]
@@ -129,7 +129,7 @@ the hook should run on, add the necessary regex to the ``files`` line in your
 .. code:: yaml
 
    - repo: https://github.com/ansys/pre-commit-hooks
-     rev: v0.4.1
+     rev: v0.4.3
      hooks:
      - id: add-license-headers
        files: '(src|examples|tests|newFolder)/.*\.(py|newExtension)|\.(proto|newExtension)'
@@ -142,7 +142,7 @@ In .pre-commit-config.yaml:
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.4.1
+    rev: v0.4.3
     hooks:
     - id: add-license-headers
       exclude: |
@@ -195,7 +195,7 @@ Technical review hook in ``ansys/pre-commit-hooks``' .pre-commit-config.yaml fil
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.4.1
+    rev: v0.4.3
     hooks:
     - id: tech-review
       args:
@@ -207,7 +207,7 @@ Technical review hook in ``PyMechanical``'s .pre-commit-config.yaml file:
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.4.1
+    rev: v0.4.3
     hooks:
     - id: tech-review
       args:

{ansys_pre_commit_hooks-0.4.1 → ansys_pre_commit_hooks-0.4.3}/pyproject.toml

@@ -3,7 +3,7 @@ requires = [
     "setuptools>=42.0",
     "GitPython==3.1.43",
     "Jinja2==3.1.4",
-    "reuse==3.0.2",
+    "reuse==4.0.3",
     "requests==2.32.3",
     "semver==3.0.2",
     "toml==0.10.2",
@@ -74,3 +74,18 @@ showcontent = true
 directory = "miscellaneous"
 name = "Miscellaneous"
 showcontent = true
+
+[[tool.towncrier.type]]
+directory = "documentation"
+name = "Documentation"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "maintenance"
+name = "Maintenance"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "test"
+name = "Test"
+showcontent = true

{ansys_pre_commit_hooks-0.4.1 → ansys_pre_commit_hooks-0.4.3}/setup.py

@@ -69,9 +69,9 @@ setup(
     python_requires=">=3.9,<4",
     install_requires=[
         "GitPython==3.1.43",
-        "importlib-metadata==8.0.0",
+        "importlib-metadata==8.2.0",
         "Jinja2==3.1.4",
-        "reuse==3.0.2",
+        "reuse==4.0.3",
         "requests==2.32.3",
         "semver==3.0.2",
         "toml==0.10.2",
@@ -80,12 +80,12 @@ setup(
         "doc": [
             "ansys-sphinx-theme[autoapi]==0.16.6",
             "numpydoc==1.7.0",
-            "sphinx==7.4.0",
-            "sphinx-autodoc-typehints==2.2.2",
+            "sphinx==7.4.7",
+            "sphinx-autodoc-typehints==2.2.3",
             "sphinx-copybutton==0.5.1",
         ],
         "tests": [
-            "pytest==8.2.2",
+            "pytest==8.3.2",
             "pytest-cov==5.0.0",
         ],
     },

ansys_pre_commit_hooks-0.4.3/src/ansys/pre_commit_hooks/VERSION

@@ -0,0 +1 @@
+0.4.3

{ansys_pre_commit_hooks-0.4.1 → ansys_pre_commit_hooks-0.4.3}/src/ansys/pre_commit_hooks/add_license_headers.py

@@ -39,6 +39,7 @@ from tempfile import NamedTemporaryFile
 
 import git
 from reuse import _annotate, _util, lint, project
+from reuse.vcs import VCSStrategyGit
 
 DEFAULT_TEMPLATE = "ansys"
 """Default template to use for license headers."""
@@ -97,7 +98,10 @@ def set_lint_args(parser: argparse.ArgumentParser) -> argparse.Namespace:
     parser.add_argument("--ignore_license_check", action="store_true")
     parser.add_argument("--parser")
     parser.add_argument("--no_multiprocessing", action="store_true")
-    lint.add_arguments(parser)
+
+    # Option for printing lint output
+    mutex_group = parser.add_mutually_exclusive_group()
+    mutex_group.add_argument("-q", "--quiet", action="store_true")
 
     return parser.parse_args()
 
@@ -241,7 +245,7 @@ def set_header_args(
         args.year = [current_year]
     else:
         args.year = [int(start_year), current_year]
-    args.copyright_style = "string-c"
+    args.copyright_prefix = "string-c"
     args.copyright = [copyright]
     args.merge_copyrights = True
     args.template = template
@@ -697,14 +701,13 @@ def find_files_missing_header() -> int:
     # year, style, copyright-style, template, exclude-year, merge-copyrights, single-line,
     # multi-line, explicit-license, force-dot-license, recursive, no-replace,
     # skip-unrecognized, and skip-existing
-    # header.add_arguments(parser)
     _annotate.add_arguments(parser)
 
     # Link the default template and/or license from the assets folder to your git repo.
     link_assets(assets, os_git_root, args)
 
     # Project to run `REUSE <https://reuse.software/>`_ on
-    proj = project.Project(git_root)
+    proj = project.Project(git_root, vcs_strategy=VCSStrategyGit)
 
     # Get files missing headers (copyright and/or license information)
     missing_headers = list(list_noncompliant_files(args, proj))

{ansys_pre_commit_hooks-0.4.1 → ansys_pre_commit_hooks-0.4.3}/src/ansys/pre_commit_hooks/tech_review.py

@@ -346,7 +346,7 @@ def download_license_json(url: str, json_file: str) -> bool:
     # If the licenses.json file does not exist in the hook's folder
     if not pathlib.Path.exists(json_file):
         # Download licenses.json
-        r = requests.get(url)
+        r = requests.get(url, timeout=60)
         status_code = r.status_code
         if status_code == 200:
             # If it was successfully downloaded, write content to file
@@ -545,7 +545,7 @@ def generate_file_from_jinja(
     """
     # Load the templates from the hook path
     loader = FileSystemLoader(searchpath=pathlib.PurePath.joinpath(HOOK_PATH, "templates"))
-    env = Environment(loader=loader)
+    env = Environment(loader=loader)  # nosec
     # Get the template for the specified file
     template = env.get_template(file)
     # Generate the file content from the template

{ansys_pre_commit_hooks-0.4.1 → ansys_pre_commit_hooks-0.4.3/src/ansys_pre_commit_hooks.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-pre-commit-hooks
-Version: 0.4.1
+Version: 0.4.3
 Summary: A Python wrapper to create Ansys-tailored pre-commit hooks
 Home-page: https://github.com/ansys/pre-commit-hooks
 Author: ANSYS, Inc.
@@ -25,20 +25,20 @@ Requires-Python: >=3.9,<4
 License-File: LICENSE
 License-File: AUTHORS.md
 Requires-Dist: GitPython==3.1.43
-Requires-Dist: importlib-metadata==8.0.0
+Requires-Dist: importlib-metadata==8.2.0
 Requires-Dist: Jinja2==3.1.4
-Requires-Dist: reuse==3.0.2
+Requires-Dist: reuse==4.0.3
 Requires-Dist: requests==2.32.3
 Requires-Dist: semver==3.0.2
 Requires-Dist: toml==0.10.2
 Provides-Extra: doc
 Requires-Dist: ansys-sphinx-theme[autoapi]==0.16.6; extra == "doc"
 Requires-Dist: numpydoc==1.7.0; extra == "doc"
-Requires-Dist: sphinx==7.4.0; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints==2.2.2; extra == "doc"
+Requires-Dist: sphinx==7.4.7; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==2.2.3; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.1; extra == "doc"
 Provides-Extra: tests
-Requires-Dist: pytest==8.2.2; extra == "tests"
+Requires-Dist: pytest==8.3.2; extra == "tests"
 Requires-Dist: pytest-cov==5.0.0; extra == "tests"
 
 Ansys pre-commit hooks
@@ -80,7 +80,7 @@ Currently, these hooks are available:
   `REUSE <https://reuse.software/>`_ . To use this hook, you must
   have ``REUSE`` implemented in your repository.
 * ``tech-review``: Do a technical review of your repository according to
-  `Ansys repository requirements <https://dev.docs.pyansys.com/packaging/structure.html>`_`
+  `Ansys repository requirements <https://dev.docs.pyansys.com/packaging/structure.html>`_
 
 ``add-license-headers`` setup
 -----------------------------
@@ -127,7 +127,7 @@ Set custom arguments
 .. code:: yaml
 
    - repo: https://github.com/ansys/pre-commit-hooks
-   rev: v0.4.1
+   rev: v0.4.3
    hooks:
    - id: add-license-headers
      args: ["--custom_copyright", "custom copyright phrase", "--custom_template", "template_name", "--custom_license", "license_name", "--ignore_license_check", "--start_year", "2023"]
@@ -172,7 +172,7 @@ the hook should run on, add the necessary regex to the ``files`` line in your
 .. code:: yaml
 
    - repo: https://github.com/ansys/pre-commit-hooks
-     rev: v0.4.1
+     rev: v0.4.3
      hooks:
      - id: add-license-headers
        files: '(src|examples|tests|newFolder)/.*\.(py|newExtension)|\.(proto|newExtension)'
@@ -185,7 +185,7 @@ In .pre-commit-config.yaml:
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.4.1
+    rev: v0.4.3
     hooks:
     - id: add-license-headers
       exclude: |
@@ -238,7 +238,7 @@ Technical review hook in ``ansys/pre-commit-hooks``' .pre-commit-config.yaml fil
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.4.1
+    rev: v0.4.3
     hooks:
     - id: tech-review
       args:
@@ -250,7 +250,7 @@ Technical review hook in ``PyMechanical``'s .pre-commit-config.yaml file:
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.4.1
+    rev: v0.4.3
     hooks:
     - id: tech-review
       args:

{ansys_pre_commit_hooks-0.4.1 → ansys_pre_commit_hooks-0.4.3}/src/ansys_pre_commit_hooks.egg-info/requires.txt

@@ -1,7 +1,7 @@
 GitPython==3.1.43
-importlib-metadata==8.0.0
+importlib-metadata==8.2.0
 Jinja2==3.1.4
-reuse==3.0.2
+reuse==4.0.3
 requests==2.32.3
 semver==3.0.2
 toml==0.10.2
@@ -9,10 +9,10 @@ toml==0.10.2
 [doc]
 ansys-sphinx-theme[autoapi]==0.16.6
 numpydoc==1.7.0
-sphinx==7.4.0
-sphinx-autodoc-typehints==2.2.2
+sphinx==7.4.7
+sphinx-autodoc-typehints==2.2.3
 sphinx-copybutton==0.5.1
 
 [tests]
-pytest==8.2.2
+pytest==8.3.2
 pytest-cov==5.0.0

{ansys_pre_commit_hooks-0.4.1 → ansys_pre_commit_hooks-0.4.3}/tests/test_reuse.py

@@ -184,8 +184,7 @@ def test_start_year_same_as_current(tmp_path: pytest.TempPathFactory):
     count = 0
     for line in file:
         count += 1
-        # Assert the copyright line's time range is
-        # from 2023 to the current year
+        # Assert the copyright line's time range is from 2023 to the current year
         if count == 1:
             assert f"Copyright (C) {dt.today().year} ANSYS, Inc." in line
         if count > 1:

ansys_pre_commit_hooks-0.4.1/src/ansys/pre_commit_hooks/VERSION

@@ -1 +0,0 @@
-0.4.1