ansys-pre-commit-hooks 0.7.0__tar.gz → 0.7.2__tar.gz

{ansys_pre_commit_hooks-0.7.0/src/ansys_pre_commit_hooks.egg-info → ansys_pre_commit_hooks-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ansys-pre-commit-hooks
-Version: 0.7.0
+Version: 0.7.2
 Home-page: https://github.com/ansys/pre-commit-hooks
 Author: ANSYS, Inc.
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
@@ -24,7 +24,7 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10,<4
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: GitPython==3.1.46
+Requires-Dist: GitPython==3.1.49
 Requires-Dist: importlib-metadata==9.0.0
 Requires-Dist: Jinja2==3.1.6
 Requires-Dist: reuse==6.2.0

{ansys_pre_commit_hooks-0.7.0 → ansys_pre_commit_hooks-0.7.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 requires = [
     "setuptools>=65.5.1",
-    "GitPython==3.1.46",
+    "GitPython==3.1.49",
     "Jinja2==3.1.6",
     "reuse==6.2.0",
     "requests==2.33.1",
@@ -20,7 +20,7 @@ license-files = ["LICENSE"]
 authors = [{ name = "ANSYS, Inc.", email = "pyansys.core@ansys.com" }]
 maintainers = [{ name = "ANSYS, Inc.", email = "pyansys.core@ansys.com" }]
 dependencies = [
-    "GitPython==3.1.46",
+    "GitPython==3.1.49",
     "importlib-metadata==9.0.0",
     "Jinja2==3.1.6",
     "reuse==6.2.0",
@@ -105,13 +105,13 @@ title_format = "`{version} <https://github.com/ansys/pre-commit-hooks/releases/t
 issue_format = "`#{issue} <https://github.com/ansys/pre-commit-hooks/pull/{issue}>`_"
 
 [[tool.towncrier.type]]
-directory = "added"
-name = "Added"
+directory = "breaking"
+name = "Breaking"
 showcontent = true
 
 [[tool.towncrier.type]]
-directory = "changed"
-name = "Changed"
+directory = "added"
+name = "Added"
 showcontent = true
 
 [[tool.towncrier.type]]
@@ -120,26 +120,32 @@ name = "Fixed"
 showcontent = true
 
 [[tool.towncrier.type]]
-directory = "dependencies"
-name = "Dependencies"
+directory = "documentation"
+name = "Documentation"
 showcontent = true
 
 [[tool.towncrier.type]]
-directory = "miscellaneous"
-name = "Miscellaneous"
+directory = "dependencies"
+name = "Dependencies"
 showcontent = true
 
 [[tool.towncrier.type]]
-directory = "documentation"
-name = "Documentation"
+directory = "maintenance"
+name = "Maintenance"
 showcontent = true
 
 [[tool.towncrier.type]]
-directory = "maintenance"
-name = "Maintenance"
+directory = "miscellaneous"
+name = "Miscellaneous"
 showcontent = true
 
 [[tool.towncrier.type]]
 directory = "test"
 name = "Test"
 showcontent = true
+
+[[tool.towncrier.type]]
+directory = "changed"
+name = "Changed"
+showcontent = true
+

{ansys_pre_commit_hooks-0.7.0 → ansys_pre_commit_hooks-0.7.2}/setup.py

@@ -39,7 +39,7 @@ setup(
     url="https://github.com/ansys/pre-commit-hooks",
     python_requires=">=3.10,<4",
     install_requires=[
-        "GitPython==3.1.46",
+        "GitPython==3.1.49",
         "importlib-metadata==9.0.0",
         "Jinja2==3.1.6",
         "reuse==6.2.0",

ansys_pre_commit_hooks-0.7.2/src/ansys/pre_commit_hooks/VERSION

@@ -0,0 +1 @@
+0.7.2

{ansys_pre_commit_hooks-0.7.0 → ansys_pre_commit_hooks-0.7.2}/src/ansys/pre_commit_hooks/add_license_headers.py

@@ -29,6 +29,7 @@ A license header consists of the Ansys copyright statement and licensing informa
 import argparse
 from datetime import date as dt
 import filecmp
+import io
 from pathlib import Path
 import re
 import shutil
@@ -201,22 +202,31 @@ def update_license_file(
         template_parent_dir = hook_loc / "assets" / "LICENSES"
         generate_license_file(template_parent_dir, year_span, repo_license_path, license)
     else:
-        # The year regex to match the year or year range in the LICENSE file
-        year_regex = r"(\d{4}) - (\d{4})|\d{4}"
-
         content = existing_content
-        # Get the first instance of the year range, either one year or a range of years
-        year_range_match = re.search(year_regex, content)
-        # Get the group from the year_range_match
-        year_range = year_range_match.group()
-
-        # Replace the current year span with the updated year span
-        if year_range != year_span:
-            # Update the year span in the LICENSE file. "1" is the max number of replacements
-            content = re.sub(year_regex, year_span, content, 1)
-
-            with repo_license_path.open(encoding="utf-8", newline="", mode="w") as file:
-                file.write(content)
+        # Match the year (or year range) specifically in the Copyright line.
+        # Searching for the first year in the file is incorrect for licenses like
+        # Apache-2.0 whose boilerplate contains "January 2004" before the copyright
+        # notice, which would otherwise be overwritten with the current year.
+        copyright_year_regex = r"(Copyright(?:\s+\(c\))?\s+)((?:\d{4}\s+-\s+)?\d{4})"
+        year_range_match = re.search(copyright_year_regex, content)
+
+        if year_range_match:
+            # Get the group from the year_range_match
+            year_range = year_range_match.group(2)
+
+            # Replace the current year span with the updated year span
+            if year_range != year_span:
+                # Update the year span in the LICENSE file. "1" is the max number of replacements
+                content = re.sub(copyright_year_regex, rf"\g<1>{year_span}", content, 1)
+
+                with repo_license_path.open(encoding="utf-8", newline="", mode="w") as file:
+                    file.write(content)
+        else:
+            # No year found in the Copyright line (e.g. "Copyright [yyyy]" placeholder
+            # in a stock Apache-2.0 LICENSE). Regenerate the file from the template.
+            hook_loc = Path(__file__).parent.resolve()
+            template_parent_dir = hook_loc / "assets" / "LICENSES"
+            generate_license_file(template_parent_dir, year_span, repo_license_path, license)
 
     # If the file changed, print a message that the LICENSE file was changed
     if not check_same_content(temp_file, repo_license_path):
@@ -340,7 +350,13 @@ def mkdirs_and_link(
         dest.unlink()
 
     # Make symbolic links to files within the assets folder
-    dest.symlink_to(src)
+    # Fall back to copying if symlinks are not permitted (e.g. Windows without Developer Mode)
+    try:
+        dest.symlink_to(src)
+    except OSError:
+        import shutil
+
+        shutil.copy2(src, dest)
 
 
 def _has_current_header(file_path: str, copyright: list, years: str) -> bool:
@@ -501,7 +517,7 @@ def non_recursive_file_check(
                 before_hook = NamedTemporaryFile(mode="w", delete=False).name
                 shutil.copyfile(file, before_hook)
                 _strip_reuse_header(file)
-                add_header(copyright, license, years, file, template, commented, sys.stdout)
+                add_header(copyright, license, years, file, template, commented, io.StringIO())
                 if not check_same_content(before_hook, file):
                     changed_headers = 1
                     print(f"Successfully changed header of {file}")
@@ -667,7 +683,7 @@ def add_header(
         The template to use for the license header. For example, "ansys.jinja2".
     commented: bool
         Whether the template is commented or not.
-    tmp: Union[NamedTemporaryFile, IO[str]]
+    out: Union[NamedTemporaryFile, IO[str]]
         Temporary file to capture the stdout of the add_header_to_file() function or ``sys.stdout``.
     """
     from reuse.cli.annotate import add_header_to_file, get_comment_style, get_reuse_info
@@ -686,12 +702,17 @@ def add_header(
     )
 
     # Add or update the header in the file with the REUSE information.
+    comment_style = get_comment_style(file)
+    if comment_style is None:
+        print(f"Skipping {file}: no comment style found for this file type.", file=out)
+        return
+
     add_header_to_file(
         path=file,
         reuse_info=reuse_info,
         template=template,
         template_is_commented=commented,
-        style=f"{get_comment_style(file).SHORTHAND}",
+        style=f"{comment_style.SHORTHAND}",
         merge_copyrights=True,
         out=out,
     )
@@ -946,7 +967,7 @@ def main():
         "copyright": args.custom_copyright,
         "template": args.custom_template,
         "license": args.custom_license,
-        "start_year": args.start_year,
+        "start_year": int(args.start_year),
         "current_year": dt.today().year,
         "git_repo": git_repo,
     }

{ansys_pre_commit_hooks-0.7.0 → ansys_pre_commit_hooks-0.7.2/src/ansys_pre_commit_hooks.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ansys-pre-commit-hooks
-Version: 0.7.0
+Version: 0.7.2
 Home-page: https://github.com/ansys/pre-commit-hooks
 Author: ANSYS, Inc.
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
@@ -24,7 +24,7 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10,<4
 Description-Content-Type: text/x-rst
 License-File: LICENSE
-Requires-Dist: GitPython==3.1.46
+Requires-Dist: GitPython==3.1.49
 Requires-Dist: importlib-metadata==9.0.0
 Requires-Dist: Jinja2==3.1.6
 Requires-Dist: reuse==6.2.0

{ansys_pre_commit_hooks-0.7.0 → ansys_pre_commit_hooks-0.7.2}/src/ansys_pre_commit_hooks.egg-info/requires.txt

@@ -1,4 +1,4 @@
-GitPython==3.1.46
+GitPython==3.1.49
 importlib-metadata==9.0.0
 Jinja2==3.1.6
 reuse==6.2.0

{ansys_pre_commit_hooks-0.7.0 → ansys_pre_commit_hooks-0.7.2}/tests/test_add_license_headers.py

@@ -22,6 +22,7 @@
 
 import argparse
 from datetime import date as dt
+import io
 import os
 from pathlib import Path
 import shutil
@@ -496,6 +497,108 @@ def test_copy_assets(tmp_path: pytest.TempPathFactory):
     check_ansys_header(tmp_file)
 
 
+@pytest.mark.add_license_headers
+def test_mkdirs_and_link_creates_symlink(tmp_path):
+    """Test that mkdirs_and_link creates a symlink when permissions allow."""
+    src_dir = tmp_path / "hook_assets"
+    src_dir.mkdir()
+    src_file = src_dir / "ansys.jinja2"
+    src_file.write_text("template content")
+
+    dest_dir = tmp_path / "repo" / ".reuse" / "templates"
+    asset_dir = str(dest_dir)
+
+    hook.mkdirs_and_link(asset_dir, str(src_dir), str(dest_dir), "ansys.jinja2")
+
+    dest_file = dest_dir / "ansys.jinja2"
+    assert dest_file.exists()
+    assert dest_file.read_text() == "template content"
+
+
+@pytest.mark.add_license_headers
+def test_mkdirs_and_link_fallback_copy_on_oserror(tmp_path, monkeypatch):
+    """Test that mkdirs_and_link falls back to copying when symlink raises OSError."""
+    src_dir = tmp_path / "hook_assets"
+    src_dir.mkdir()
+    src_file = src_dir / "ansys.jinja2"
+    src_file.write_text("template content")
+
+    dest_dir = tmp_path / "repo" / ".reuse" / "templates"
+    asset_dir = str(dest_dir)
+
+    # Simulate Windows symlink privilege error
+    monkeypatch.setattr(
+        Path,
+        "symlink_to",
+        lambda *_args, **_kwargs: (_ for _ in ()).throw(
+            OSError(1314, "A required privilege is not held by the client")
+        ),
+    )
+
+    hook.mkdirs_and_link(asset_dir, str(src_dir), str(dest_dir), "ansys.jinja2")
+
+    dest_file = dest_dir / "ansys.jinja2"
+    assert dest_file.exists()
+    assert not dest_file.is_symlink()
+    assert dest_file.read_text() == "template content"
+
+
+@pytest.mark.add_license_headers
+def test_mkdirs_and_link_skips_existing_symlink(tmp_path):
+    """Test that mkdirs_and_link skips creation when symlink points to the correct source."""
+    src_dir = tmp_path / "hook_assets"
+    src_dir.mkdir()
+    src_file = src_dir / "ansys.jinja2"
+    src_file.write_text("template content")
+
+    dest_dir = tmp_path / "repo" / ".reuse" / "templates"
+    dest_dir.mkdir(parents=True)
+    dest_file = dest_dir / "ansys.jinja2"
+
+    try:
+        dest_file.symlink_to(src_file)
+    except OSError:
+        pytest.skip("Symlinks not supported on this platform/environment")
+
+    mtime_before = src_file.stat().st_mtime
+
+    hook.mkdirs_and_link(str(dest_dir), str(src_dir), str(dest_dir), "ansys.jinja2")
+
+    # File should still exist and be unchanged
+    assert dest_file.is_symlink()
+    assert dest_file.read_text() == "template content"
+    assert src_file.stat().st_mtime == mtime_before
+
+
+@pytest.mark.add_license_headers
+def test_add_header_skips_unknown_comment_style(tmp_path, monkeypatch):
+    """Test add_header skips files when no comment style can be inferred."""
+    test_file = tmp_path / "unknown.ext"
+    test_file.write_text("content\n", encoding="utf-8")
+
+    called = {"add_header_to_file": False}
+
+    def _fake_add_header_to_file(**_kwargs):
+        called["add_header_to_file"] = True
+
+    monkeypatch.setattr("reuse.cli.annotate.get_comment_style", lambda _path: None)
+    monkeypatch.setattr("reuse.cli.annotate.add_header_to_file", _fake_add_header_to_file)
+
+    out = io.StringIO()
+    hook.add_header(
+        [DEFAULT_COPYRIGHT],
+        ["MIT"],
+        f"{dt.today().year}",
+        str(test_file),
+        "ansys.jinja2",
+        True,
+        out,
+    )
+
+    assert not called["add_header_to_file"]
+    assert "Skipping" in out.getvalue()
+
+
 @pytest.mark.add_license_headers
 def test_bad_chars(tmp_path: pytest.TempPathFactory):
     # Set template and license names
@@ -847,6 +950,46 @@ def test_mit_header_replaced_with_apache(tmp_path: pytest.TempPathFactory):
     os.chdir(REPO_PATH)
 
 
+@pytest.mark.add_license_headers
+def test_no_duplicate_prints_on_license_switch(
+    tmp_path: pytest.TempPathFactory, capsys: pytest.CaptureFixture
+):
+    """Test that switching from MIT to Apache-2.0 prints each changed file exactly once."""
+    template_name = "ansys.jinja2"
+    license_name = "Apache-2.0.txt"
+    template_path = Path(REPO_PATH) / ".reuse" / "templates" / template_name
+    license_path = (
+        Path(REPO_PATH)
+        / "src"
+        / "ansys"
+        / "pre_commit_hooks"
+        / "assets"
+        / "LICENSES"
+        / license_name
+    )
+
+    repo, tmp_file = set_up_repo(tmp_path, template_path, template_name, license_path, license_name)
+
+    # First run: add the MIT header
+    add_argv_run(repo, tmp_file, [tmp_file])
+    repo.index.add([tmp_file])
+    capsys.readouterr()  # discard output from the MIT-header run
+
+    # Second run: switch to Apache-2.0 — triggers the license-switch branch
+    add_argv_run(repo, tmp_file, [tmp_file, "--custom_license=Apache-2.0"])
+
+    captured = capsys.readouterr()
+    file_lines = [
+        line for line in captured.out.splitlines() if "Successfully changed header" in line
+    ]
+    assert len(file_lines) == 1, (
+        f"Expected 'Successfully changed header' to appear exactly once, "
+        f"but got {len(file_lines)} time(s):\n{captured.out}"
+    )
+
+    os.chdir(REPO_PATH)
+
+
 @pytest.mark.add_license_headers
 def test_mit_license_file_replaced_with_apache(tmp_path: pytest.TempPathFactory):
     """Test that LICENSE file is regenerated as Apache-2.0 when it's the custom license."""
@@ -888,6 +1031,34 @@ def test_mit_license_file_replaced_with_apache(tmp_path: pytest.TempPathFactory)
     os.chdir(REPO_PATH)
 
 
+@pytest.mark.add_license_headers
+def test_apache_license_year_update_preserves_boilerplate(tmp_path):
+    """Test that updating the year in an Apache-2.0 LICENSE does not corrupt the boilerplate.
+
+    Regression test: the 'January 2004' text in the Apache boilerplate header must not
+    be replaced with the current year when the copyright year is updated.
+    """
+    hook_loc = Path(REPO_PATH) / "src" / "ansys" / "pre_commit_hooks"
+    template_dir = hook_loc / "assets" / "LICENSES"
+    license_file = tmp_path / "LICENSE"
+
+    # Generate an Apache-2.0 LICENSE file with a fixed start year
+    hook.generate_license_file(template_dir, "2023", license_file, "Apache-2.0")
+
+    initial_content = license_file.read_text(encoding="utf-8")
+    assert "January 2004" in initial_content
+    assert "Copyright 2023 ANSYS" in initial_content
+
+    # Simulate a year-span update (e.g., a new calendar year)
+    hook.update_license_file(license_file, "2023 - 2026", "Apache-2.0")
+
+    updated_content = license_file.read_text(encoding="utf-8")
+    assert (
+        "January 2004" in updated_content
+    ), "The Apache boilerplate 'January 2004' must not be overwritten by the year update"
+    assert "Copyright 2023 - 2026 ANSYS" in updated_content
+
+
 @pytest.mark.add_license_headers
 def test_line_endings(tmp_path: pytest.TempPathFactory):
     """Test line endings remain the same before and after running the hook."""

ansys_pre_commit_hooks-0.7.0/src/ansys/pre_commit_hooks/VERSION

@@ -1 +0,0 @@
-0.7.0