ansys-pre-commit-hooks 0.3.1__tar.gz → 0.4.0__tar.gz

ansys_pre_commit_hooks-0.3.1/README.rst → ansys_pre_commit_hooks-0.4.0/PKG-INFO

@@ -1,3 +1,39 @@
+Metadata-Version: 2.1
+Name: ansys-pre-commit-hooks
+Version: 0.4.0
+Summary: A Python wrapper to create Ansys-tailored pre-commit hooks
+Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Requires-Python: >=3.9,<4
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Dist: GitPython==3.1.43
+Requires-Dist: importlib-metadata==8.0.0
+Requires-Dist: Jinja2==3.1.4
+Requires-Dist: reuse==3.0.2
+Requires-Dist: requests==2.32.3
+Requires-Dist: semver==3.0.2
+Requires-Dist: toml==0.10.2
+Requires-Dist: ansys-sphinx-theme[autoapi]==0.16.6 ; extra == "doc"
+Requires-Dist: numpydoc==1.7.0 ; extra == "doc"
+Requires-Dist: sphinx==7.3.7 ; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==2.2.2 ; extra == "doc"
+Requires-Dist: sphinx-copybutton==0.5.1 ; extra == "doc"
+Requires-Dist: pytest==8.2.2 ; extra == "tests"
+Requires-Dist: pytest-cov==5.0.0 ; extra == "tests"
+Project-URL: Documentation, https://pre-commit-hooks.docs.ansys.com
+Project-URL: Homepage, https://github.com/ansys/pre-commit-hooks
+Project-URL: Source, https://github.com/ansys/pre-commit-hooks
+Project-URL: Tracker, https://github.com/ansys/pre-commit-hooks/issues
+Provides-Extra: doc
+Provides-Extra: tests
+
 Ansys pre-commit hooks
 ======================
 |pyansys| |python| |pypi| |GH-CI| |MIT| |black| |pre-commit-ci|
@@ -36,8 +72,8 @@ Currently, these hooks are available:
 * ``add-license-headers``: Add missing license headers to files by using
   `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>`_`
 
 ``add-license-headers`` setup
 -----------------------------
@@ -84,7 +120,7 @@ Set custom arguments
 .. code:: yaml
 
    - repo: https://github.com/ansys/pre-commit-hooks
-   rev: v0.3.1
+   rev: v0.4.0
    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 +165,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.3.1
+     rev: v0.4.0
      hooks:
      - id: add-license-headers
        files: '(src|examples|tests|newFolder)/.*\.(py|newExtension)|\.(proto|newExtension)'
@@ -142,7 +178,7 @@ In .pre-commit-config.yaml:
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.3.1
+    rev: v0.4.0
     hooks:
     - id: add-license-headers
       exclude: |
@@ -160,6 +196,59 @@ In .pre-commit-config.yaml:
 * ``.*\.js`` excludes all .js files in all directories.
 * ``\..*`` excludes all hidden files.
 
+``tech-review`` setup
+---------------------
+
+These are the default values for the arguments of the tech-review hook:
+
+* ``--author_maint_name=ANSYS, Inc.``
+* ``--author_maint_email=pyansys.core@ansys.com``
+* ``--license=MIT``
+* ``--url=https://github.com/ansys/{repo-name}``, replacing ``repo-name`` with the name of the repository
+
+The ``--author_maint_name`` is the name of the author and maintainer in the ``pyproject.toml`` file.
+By default, it is "Ansys, Inc.".
+
+The ``--author_maint_email`` is the email of the author and maintainer in the ``pyproject.toml`` file.
+By default, it is "pyansys.core@ansys.com".
+
+The ``--license`` argument is the license that is being used by your repository. By default, it is
+MIT.
+
+The ``--url`` argument is automatically rendered based on the repository name. If your repository
+is not in the Ansys organization, please add this argument to your configuration in
+.pre-commit-config.yaml.
+
+The ``--product`` argument is required if a ``README.rst`` or ``README.md`` file does not
+exist in your repository and you want the template to render correctly. The product
+for ``PyMechanical`` would be ``mechanical``, for example.
+
+The ``--non_compliant_name`` flag can be used if your repository does not follow the typical
+naming convention of ``ansys-*-*``.
+
+Technical review hook in ``ansys/pre-commit-hooks``' .pre-commit-config.yaml file:
+
+.. code:: yaml
+
+  - repo: https://github.com/ansys/pre-commit-hooks
+    rev: v0.4.0
+    hooks:
+    - id: tech-review
+      args:
+      - --product=pre_commit_hooks
+      - --non_compliant_name
+
+Technical review hook in ``PyMechanical``'s .pre-commit-config.yaml file:
+
+.. code:: yaml
+
+  - repo: https://github.com/ansys/pre-commit-hooks
+    rev: v0.4.0
+    hooks:
+    - id: tech-review
+      args:
+      - --product=mechanical
+
 
 How to install
 --------------
@@ -331,3 +420,4 @@ the building requirements and then execute the build module with these commands:
 .. _pytest: https://docs.pytest.org/en/stable/
 .. _Sphinx: https://www.sphinx-doc.org/en/master/
 .. _tox: https://tox.wiki/
+

ansys_pre_commit_hooks-0.3.1/PKG-INFO → ansys_pre_commit_hooks-0.4.0/README.rst

@@ -1,35 +1,3 @@
-Metadata-Version: 2.1
-Name: ansys-pre-commit-hooks
-Version: 0.3.1
-Summary: A Python wrapper to create Ansys-tailored pre-commit hooks
-Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
-Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
-Requires-Python: >=3.9,<4
-Description-Content-Type: text/x-rst
-Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Dist: importlib-metadata==7.1.0
-Requires-Dist: reuse==3.0.2
-Requires-Dist: GitPython==3.1.43
-Requires-Dist: ansys-sphinx-theme[autoapi]==0.15.2 ; extra == "doc"
-Requires-Dist: numpydoc==1.7.0 ; extra == "doc"
-Requires-Dist: sphinx==7.3.7 ; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints==2.1.0 ; extra == "doc"
-Requires-Dist: sphinx-copybutton==0.5.1 ; extra == "doc"
-Requires-Dist: pytest==8.1.1 ; extra == "tests"
-Requires-Dist: pytest-cov==5.0.0 ; extra == "tests"
-Project-URL: Documentation, https://pre-commit-hooks.docs.ansys.com
-Project-URL: Homepage, https://github.com/ansys/pre-commit-hooks
-Project-URL: Source, https://github.com/ansys/pre-commit-hooks
-Project-URL: Tracker, https://github.com/ansys/pre-commit-hooks/issues
-Provides-Extra: doc
-Provides-Extra: tests
-
 Ansys pre-commit hooks
 ======================
 |pyansys| |python| |pypi| |GH-CI| |MIT| |black| |pre-commit-ci|
@@ -68,8 +36,8 @@ Currently, these hooks are available:
 * ``add-license-headers``: Add missing license headers to files by using
   `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>`_`
 
 ``add-license-headers`` setup
 -----------------------------
@@ -116,7 +84,7 @@ Set custom arguments
 .. code:: yaml
 
    - repo: https://github.com/ansys/pre-commit-hooks
-   rev: v0.3.1
+   rev: v0.4.0
    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"]
@@ -161,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.3.1
+     rev: v0.4.0
      hooks:
      - id: add-license-headers
        files: '(src|examples|tests|newFolder)/.*\.(py|newExtension)|\.(proto|newExtension)'
@@ -174,7 +142,7 @@ In .pre-commit-config.yaml:
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.3.1
+    rev: v0.4.0
     hooks:
     - id: add-license-headers
       exclude: |
@@ -192,6 +160,59 @@ In .pre-commit-config.yaml:
 * ``.*\.js`` excludes all .js files in all directories.
 * ``\..*`` excludes all hidden files.
 
+``tech-review`` setup
+---------------------
+
+These are the default values for the arguments of the tech-review hook:
+
+* ``--author_maint_name=ANSYS, Inc.``
+* ``--author_maint_email=pyansys.core@ansys.com``
+* ``--license=MIT``
+* ``--url=https://github.com/ansys/{repo-name}``, replacing ``repo-name`` with the name of the repository
+
+The ``--author_maint_name`` is the name of the author and maintainer in the ``pyproject.toml`` file.
+By default, it is "Ansys, Inc.".
+
+The ``--author_maint_email`` is the email of the author and maintainer in the ``pyproject.toml`` file.
+By default, it is "pyansys.core@ansys.com".
+
+The ``--license`` argument is the license that is being used by your repository. By default, it is
+MIT.
+
+The ``--url`` argument is automatically rendered based on the repository name. If your repository
+is not in the Ansys organization, please add this argument to your configuration in
+.pre-commit-config.yaml.
+
+The ``--product`` argument is required if a ``README.rst`` or ``README.md`` file does not
+exist in your repository and you want the template to render correctly. The product
+for ``PyMechanical`` would be ``mechanical``, for example.
+
+The ``--non_compliant_name`` flag can be used if your repository does not follow the typical
+naming convention of ``ansys-*-*``.
+
+Technical review hook in ``ansys/pre-commit-hooks``' .pre-commit-config.yaml file:
+
+.. code:: yaml
+
+  - repo: https://github.com/ansys/pre-commit-hooks
+    rev: v0.4.0
+    hooks:
+    - id: tech-review
+      args:
+      - --product=pre_commit_hooks
+      - --non_compliant_name
+
+Technical review hook in ``PyMechanical``'s .pre-commit-config.yaml file:
+
+.. code:: yaml
+
+  - repo: https://github.com/ansys/pre-commit-hooks
+    rev: v0.4.0
+    hooks:
+    - id: tech-review
+      args:
+      - --product=mechanical
+
 
 How to install
 --------------
@@ -363,4 +384,3 @@ the building requirements and then execute the build module with these commands:
 .. _pytest: https://docs.pytest.org/en/stable/
 .. _Sphinx: https://www.sphinx-doc.org/en/master/
 .. _tox: https://tox.wiki/
-

{ansys_pre_commit_hooks-0.3.1 → ansys_pre_commit_hooks-0.4.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
 name = "ansys-pre-commit-hooks"
-version = "0.3.1"
+version = "0.4.0"
 description = "A Python wrapper to create Ansys-tailored pre-commit hooks"
 readme = "README.rst"
 requires-python = ">=3.9,<4"
@@ -27,21 +27,25 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-    "importlib-metadata==7.1.0",
-    "reuse==3.0.2",
     "GitPython==3.1.43",
+    "importlib-metadata==8.0.0",
+    "Jinja2==3.1.4",
+    "reuse==3.0.2",
+    "requests==2.32.3",
+    "semver==3.0.2",
+    "toml==0.10.2",
 ]
 
 [project.optional-dependencies]
 tests = [
-    "pytest==8.1.1",
+    "pytest==8.2.2",
     "pytest-cov==5.0.0",
 ]
 doc = [
-    "ansys-sphinx-theme[autoapi]==0.15.2",
+    "ansys-sphinx-theme[autoapi]==0.16.6",
     "numpydoc==1.7.0",
     "sphinx==7.3.7",
-    "sphinx-autodoc-typehints==2.1.0",
+    "sphinx-autodoc-typehints==2.2.2",
     "sphinx-copybutton==0.5.1",
 ]
 
@@ -51,6 +55,7 @@ name = "ansys.pre_commit_hooks"
 
 [project.scripts]
 add-license-headers = "ansys.pre_commit_hooks.add_license_headers:main"
+tech-review = "ansys.pre_commit_hooks.tech_review:main"
 
 [project.urls]
 Source = "https://github.com/ansys/pre-commit-hooks"
@@ -58,7 +63,6 @@ Tracker = "https://github.com/ansys/pre-commit-hooks/issues"
 Homepage = "https://github.com/ansys/pre-commit-hooks"
 Documentation = "https://pre-commit-hooks.docs.ansys.com"
 
-
 [tool.black]
 line-length = 100
 
@@ -66,9 +70,11 @@ line-length = 100
 profile = "black"
 force_sort_within_sections = true
 line_length = 100
-default_section = "THIRDPARTY"
 src_paths = ["doc", "src", "tests"]
 
+[tool.codespell]
+ignore-words = "doc/styles/config/vocabularies/ANSYS/accept.txt"
+
 [tool.coverage.run]
 source = ["ansys.pre_commit_hooks"]
 
@@ -81,6 +87,10 @@ addopts = "--cov=ansys.pre_commit_hooks --cov-report term-missing -vv"
 testpaths = [
     "tests",
 ]
+markers = [
+    "license_headers: marks tests for add-license-headers hook",
+    "tech_review: marks tests for tech-review hook",
+]
 
 [tool.towncrier]
 package = "ansys.pre_commit_hooks"
@@ -115,4 +125,4 @@ showcontent = true
 [[tool.towncrier.type]]
 directory = "miscellaneous"
 name = "Miscellaneous"
-showcontent = true
+showcontent = true

{ansys_pre_commit_hooks-0.3.1 → ansys_pre_commit_hooks-0.4.0}/src/ansys/pre_commit_hooks/add_license_headers.py

@@ -251,14 +251,7 @@ def set_header_args(
     return args
 
 
-def check_exists(
-    changed_headers: int,
-    parser: argparse.ArgumentParser,
-    values: dict,
-    proj: project.Project,
-    missing_headers: list,
-    i: int,
-) -> int:
+def non_recursive_file_check(changed_headers, parser, values, proj, missing_headers):
     """
     Check if the committed file is missing its header.
 
@@ -328,6 +321,89 @@ def check_exists(
     return changed_headers
 
 
+def recursive_file_check(changed_headers, parser, values, proj, missing_headers, count):
+    """
+    Check if the committed file is missing its header.
+
+    Parameters
+    ----------
+    changed_headers: int
+        ``0`` if no headers were added or updated.
+        ``1`` if headers were added or updated.
+    parser: argparse.ArgumentParser
+        Parser containing default license header arguments.
+    values: dict
+        Dictionary containing the values of files, copyright,
+        template, license, changed_headers, year, and git_repo.
+    proj: project.Project
+        Project to run `REUSE <https://reuse.software/>`_ on.
+    missing_headers: list
+        Committed files that are missing copyright and/or
+        license information in their headers.
+    count: int
+        Integer of the location in the files array.
+
+    Returns
+    -------
+    int
+        ``0`` if all files contain headers and are up to date.
+        ``1`` if ``REUSE`` changed all noncompliant files.
+    """
+    files = values["files"]
+    start_year = values["start_year"]
+    current_year = values["current_year"]
+    copyright = values["copyright"]
+    template = values["template"]
+
+    if count < len(files):
+        # If the committed file is in missing_headers
+        file = files[count]
+
+        if (file in missing_headers) or (os.path.getsize(file) == 0):
+            changed_headers = 1
+            # Run REUSE on the file
+            args = set_header_args(parser, start_year, current_year, file, copyright, template)
+            if not args.ignore_license_check:
+                args.license = [values["license"]]
+            _annotate.run(args, proj)
+
+            # Check if the next file is in missing_headers
+            return recursive_file_check(
+                changed_headers, parser, values, proj, missing_headers, count + 1
+            )
+        else:
+            # Save current copy of file
+            before_hook = NamedTemporaryFile(mode="w", delete=False).name
+            shutil.copyfile(file, before_hook)
+
+            # Update the header
+            # tmp captures the stdout of the header.run() function
+            with NamedTemporaryFile(mode="w", delete=True) as tmp:
+                args = set_header_args(parser, start_year, current_year, file, copyright, template)
+                _annotate.run(args, proj, tmp)
+
+            # Check if the file before add-license-headers was run is the same as the one
+            # after add-license-headers was run. If not, apply the syntax changes
+            # from other hooks before add-license-headers was run to the file
+            if check_same_content(before_hook, file) == False:
+                add_hook_changes(before_hook, file)
+
+            # Check if the file content before add-license-headers was run has been changed
+            # Assuming the syntax was fixed in the above if statement, this check is
+            # solely for the file's content
+            if check_same_content(before_hook, file) == False:
+                changed_headers = 1
+                print(f"Successfully changed header of {file}")
+
+            os.remove(before_hook)
+
+            return recursive_file_check(
+                changed_headers, parser, values, proj, missing_headers, count + 1
+            )
+
+    return changed_headers
+
+
 def check_same_content(before_hook, after_hook):
     """
     Check if file before the hook ran is the same as after the hook ran.
@@ -635,7 +711,14 @@ def find_files_missing_header() -> int:
 
     # Add or update headers of required files.
     # Return 1 if files were added or updated, and return 0 if no files were altered.
-    file_return_code = check_exists(changed_headers, parser, values, proj, missing_headers, 0)
+    if len(values["files"]) <= (sys.getrecursionlimit() - 2):
+        file_return_code = recursive_file_check(
+            changed_headers, parser, values, proj, missing_headers, 0
+        )
+    else:
+        file_return_code = non_recursive_file_check(
+            changed_headers, parser, values, proj, missing_headers
+        )
 
     # Unlink default files & remove .reuse and LICENSES folders if empty
     cleanup(assets, os_git_root)