Skip to content

Check whether a pre-commit hook is used as a part of is_used heuris… #813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanjmcdougall merged 5 commits into from
Jun 28, 2025
Merged

Check whether a pre-commit hook is used as a part of is_used heuris… #813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e3152e7
Check whether a pre-commit hook is used as a part of `is_used` heuris…
nathanjmcdougall Jun 28, 2025
0baea6b
Fix pre-commit schema violation in pre-commit integration test
nathanjmcdougall Jun 28, 2025
d39f02f
Try reading pre-commit config last in `is_used` to improve performance
nathanjmcdougall Jun 28, 2025
d9336d0
Merge branch 'main' into 811-improve-is_used-heuristics-by-checking-p…
nathanjmcdougall Jun 28, 2025
9e0a23d
Fix undefined FileDecodeError - change to FileConfigError
nathanjmcdougall Jun 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/usethis/_tool/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,9 @@ def is_used(self) -> bool:

Three heuristics are used by default:
1. Whether any of the tool's characteristic dependencies are in the project.
2. Whether any of the tool's managed files are in the project.
3. Whether any of the tool's managed config file sections are present.
2. Whether any of the tool's characteristic pre-commit hooks are in the project.
3. Whether any of the tool's managed files are in the project.
4. Whether any of the tool's managed config file sections are present.
"""
decode_err_by_name: dict[str, FileConfigError] = {}
_is_used = False
Expand All @@ -128,6 +129,13 @@ def is_used(self) -> bool:
except FileConfigError as err:
decode_err_by_name[err.name] = err

# Do this last since the YAML parsing is expensive.
if not _is_used:
try:
_is_used = self.is_pre_commit_config_present()
except FileConfigError as err:
decode_err_by_name[err.name] = err

for name, decode_err in decode_err_by_name.items():
warn_print(decode_err)
warn_print(
Expand Down
2 changes: 1 addition & 1 deletion tests/usethis/_core/test_core_ci.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ def test_contents(
self, uv_init_dir: Path, capfd: pytest.CaptureFixture[str]
):
# Arrange
(uv_init_dir / ".pre-commit-config.yaml").touch()
(uv_init_dir / ".pre-commit-config.yaml").write_text("repos: []")

# Act
with change_cwd(uv_init_dir), files_manager():
Expand Down
18 changes: 18 additions & 0 deletions tests/usethis/_tool/test_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

import pytest

from usethis._config_file import files_manager
from usethis._console import box_print
from usethis._integrations.file.pyproject_toml.io_ import PyprojectTOMLManager
from usethis._integrations.file.setup_cfg.io_ import SetupCFGManager
Expand Down Expand Up @@ -404,6 +405,23 @@ def preferred_file_manager(self) -> KeyValueFileManager:
"\n⚠ Assuming 'setup.cfg' contains no evidence of my_tool being used.\n"
)

def test_pre_commit_config(self, uv_init_dir: Path):
# Arrange
tool = MyTool()
with change_cwd(uv_init_dir), files_manager():
# Create a pre-commit config file
(uv_init_dir / ".pre-commit-config.yaml").write_text("""\
repos:
- repo: local
hooks:
- id: deptry
""")

# Act
result = tool.is_used()
# Assert
assert result

class TestIsDeclaredAsDep:
def test_dev_deps(self, uv_init_dir: Path):
# Arrange
Expand Down