Skip to content

Experiment: Add python_uv hook environments #2058

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

Draft
j178 wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

Experiment: Add python_uv hook environments #2058

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
3746242
Add python_uv hook environments
j178 May 7, 2026
c016aa1
Move hook env spec to top-level module
j178 May 7, 2026
4ae1b4c
Tweaks
j178 May 8, 2026
7f66f5d
Refactor
j178 May 8, 2026
936415e
Compat with legacy hook env
j178 May 8, 2026
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
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ reqwest = { version = "0.13.2", default-features = false, features = [
rustc-hash = { version = "2.1.1" }
rustix = { version = "1.0.8", features = ["pty", "process", "fs", "termios"] }
same-file = { version = "1.0.6" }
seahash = { version = "4.1.0" }
seahash = { version = "4.1.0", features = ["use_std"] }
semver = { version = "1.0.24", features = ["serde"] }
serde = { version = "1.0.210", features = ["derive"] }
serde_json = { version = "1.0.132", features = [
Expand Down
164 changes: 69 additions & 95 deletions crates/prek/src/cli/cache_gc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ use tracing::{debug, trace, warn};
use crate::cli::ExitStatus;
use crate::cli::cache_size::{dir_size_bytes, human_readable_bytes};
use crate::config::{self, Error as ConfigError, Repo as ConfigRepo, load_config};
use crate::hook::{HOOK_MARKER, HookEnvKey, HookSpec, InstallInfo, Repo as HookRepo};
use crate::hook::{HOOK_MARKER, HookSpec, InstalledHookEnv, Repo as HookRepo};
use crate::hook_env::{HookEnvIdentity, HookEnvRequest};
use crate::printer::Printer;
use crate::store::{CacheBucket, REPO_MARKER, Store, ToolBucket};

Expand Down Expand Up @@ -159,7 +160,7 @@ pub(crate) async fn cache_gc(
let mut used_tools: FxHashSet<ToolBucket> = FxHashSet::default();
let mut used_tool_versions: FxHashMap<ToolBucket, FxHashSet<String>> = FxHashMap::default();
let mut used_cache: FxHashSet<CacheBucket> = FxHashSet::default();
let mut used_env_keys: Vec<HookEnvKey> = Vec::new();
let mut used_env_requests: Vec<HookEnvRequest> = Vec::new();

// Always keep Prek's own cache.
used_cache.insert(CacheBucket::Prek);
Expand All @@ -186,7 +187,7 @@ pub(crate) async fn cache_gc(
};
kept_configs.insert(config_path);

used_env_keys.extend(hook_env_keys_from_config(store, &config));
used_env_requests.extend(hook_env_requests_from_config(store, &config, config_path));

// Mark repos referenced by this config (if present in store).
// We do this via config parsing (no clone), so GC won't keep repos for missing configs.
Expand All @@ -205,17 +206,20 @@ pub(crate) async fn cache_gc(
}

// Mark tools/caches from hook languages.
for key in &used_env_keys {
used_tools.extend(key.language.tool_buckets());
used_cache.extend(key.language.cache_buckets());
for request in &used_env_requests {
used_tools.extend(request.language.tool_buckets());
used_cache.extend(request.language.cache_buckets());
}

// Mark hook environments by matching already-installed env metadata.
// While doing this, try to derive the specific tool *version* directories in use from
// `InstallInfo.toolchain` (which is persisted in `.prek-hook.json`).
for info in &installed {
if used_env_keys.iter().any(|k| k.matches_install_info(info)) {
if let Some(dir) = info
// `InstalledHookEnv.toolchain` (which is persisted in `.prek-hook.json`).
for env in &installed {
if used_env_requests
.iter()
.any(|request| env.satisfies(request.into()))
{
if let Some(dir) = env
.env_path
.file_name()
.and_then(|s| s.to_str())
Expand All @@ -224,7 +228,7 @@ pub(crate) async fn cache_gc(
used_hook_env_dirs.insert(dir);
}

mark_tool_versions_from_install_info(store, info, &mut used_tool_versions);
mark_tool_versions_from_installed_env(store, env, &mut used_tool_versions);
}
}

Expand Down Expand Up @@ -350,8 +354,13 @@ fn print_removed_details(printer: Printer, verb: &str, removal: &Removal) -> Res
Ok(())
}

fn hook_env_keys_from_config(store: &Store, config: &config::Config) -> Vec<HookEnvKey> {
let mut keys = Vec::new();
fn hook_env_requests_from_config(
store: &Store,
config: &config::Config,
config_path: &Path,
) -> Vec<HookEnvRequest> {
let mut requests = Vec::new();
let project_root = config_path.parent().unwrap_or_else(|| Path::new("."));

for repo_config in &config.repos {
match repo_config {
Expand Down Expand Up @@ -383,23 +392,28 @@ fn hook_env_keys_from_config(store: &Store, config: &config::Config) -> Vec<Hook
let mut hook_spec = manifest_hook.clone();
hook_spec.apply_remote_hook_overrides(hook_config);

match HookEnvKey::from_hook_spec(config, hook_spec, Some(&remote_dep)) {
Ok(Some(key)) => keys.push(key),
match HookEnvRequest::from_hook_spec(
config,
hook_spec,
Some(&remote_dep),
project_root,
) {
Ok(Some(request)) => requests.push(request),
Ok(None) => {}
Err(err) => {
warn!(hook = %hook_config.id, repo = %remote_dep, %err, "Failed to compute hook env key, skipping");
warn!(hook = %hook_config.id, repo = %remote_dep, %err, "Failed to compute hook env request, skipping");
}
}
}
}
ConfigRepo::Local(repo_config) => {
for hook in &repo_config.hooks {
let hook_spec = HookSpec::from(hook.clone());
match HookEnvKey::from_hook_spec(config, hook_spec, None) {
Ok(Some(key)) => keys.push(key),
match HookEnvRequest::from_hook_spec(config, hook_spec, None, project_root) {
Ok(Some(request)) => requests.push(request),
Ok(None) => {}
Err(err) => {
warn!(hook = %hook.id, %err, "Failed to compute hook env key, skipping");
warn!(hook = %hook.id, %err, "Failed to compute hook env request, skipping");
}
}
}
Expand All @@ -408,20 +422,20 @@ fn hook_env_keys_from_config(store: &Store, config: &config::Config) -> Vec<Hook
}
}

keys
requests
}

fn mark_tool_versions_from_install_info(
fn mark_tool_versions_from_installed_env(
store: &Store,
info: &InstallInfo,
env: &InstalledHookEnv,
used_tool_versions: &mut FxHashMap<ToolBucket, FxHashSet<String>>,
) {
// NOTE: `InstallInfo.toolchain` is typically the executable path (e.g.
// NOTE: `InstalledHookEnv.toolchain` is typically the executable path (e.g.
// tools/go/1.24.0/bin/go). We keep the first path component under the tool bucket.
// If we can't recognize it, we do nothing (and GC will keep all versions).
for bucket in info.language.tool_buckets() {
for bucket in env.language.tool_buckets() {
let bucket_root = store.tools_path(*bucket);
if let Some(version) = tool_version_dir_name(&bucket_root, &info.toolchain) {
if let Some(version) = tool_version_dir_name(&bucket_root, &env.toolchain) {
used_tool_versions
.entry(*bucket)
.or_default()
Expand Down Expand Up @@ -699,13 +713,13 @@ fn sweep_stale_patch_files(root: &Path, dry_run: bool, collect_names: bool) -> R
fn label_for_entry(
kind: RemovalKind,
repo_marker: Option<&RepoMarker>,
hook_marker: Option<&InstallInfo>,
hook_marker: Option<&InstalledHookEnv>,
) -> Option<String> {
match kind {
RemovalKind::Repos => repo_marker.map(|repo| format!("{}@{}", repo.repo, repo.rev)),
RemovalKind::HookEnvs => hook_marker.map(|info| {
RemovalKind::HookEnvs => hook_marker.map(|env| {
// Keep this short; more info goes in detail lines.
format!("{} env", info.language.as_ref())
format!("{} env", env.language.as_ref())
}),
_ => None,
}
Expand All @@ -714,36 +728,47 @@ fn label_for_entry(
fn detail_lines_for_entry(
kind: RemovalKind,
_repo_marker: Option<&RepoMarker>,
hook_marker: Option<&InstallInfo>,
hook_marker: Option<&InstalledHookEnv>,
) -> Vec<String> {
const MAX_VALUE_CHARS: usize = 140;

match kind {
RemovalKind::Repos => vec![],
RemovalKind::HookEnvs => {
let Some(info) = hook_marker else {
let Some(env) = hook_marker else {
return Vec::new();
};

let mut lines = Vec::new();
lines.push(format!(
"{}: {} ({})",
"language".dimmed().bold(),
info.language.as_ref(),
info.language_version
env.language.as_ref(),
env.language_version
));

let (repo_dep, deps) = split_repo_dependency(&info.dependencies);
if let Some(repo_dep) = repo_dep {
lines.push(format!(
"{}: {}",
"repo".dimmed().bold(),
truncate_end(&repo_dep, MAX_VALUE_CHARS)
));
}
if !deps.is_empty() {
let deps_str = format_dependency_list(&deps, 6, MAX_VALUE_CHARS);
lines.push(format!("{}: {deps_str}", "deps".dimmed().bold()));
match &env.identity {
HookEnvIdentity::Dependencies(identity) => {
if let Some(repo) = &identity.remote_repo {
lines.push(format!(
"{}: {}",
"repo".dimmed().bold(),
truncate_end(repo, MAX_VALUE_CHARS)
));
}
if !identity.dependencies.is_empty() {
let deps = identity.dependencies.iter().cloned().collect::<Vec<_>>();
let deps_str = format_dependency_list(&deps, 6, MAX_VALUE_CHARS);
lines.push(format!("{}: {deps_str}", "deps".dimmed().bold()));
}
}
HookEnvIdentity::PythonUv(identity) => {
lines.push(format!(
"{}: {}",
"python_uv".dimmed().bold(),
truncate_end(&identity.fingerprint, MAX_VALUE_CHARS)
));
}
}
lines
}
Expand All @@ -765,7 +790,7 @@ fn read_repo_marker(root: &Path) -> Option<RepoMarker> {
serde_json::from_str(&content).ok()
}

fn read_hook_marker(root: &Path) -> Option<InstallInfo> {
fn read_hook_marker(root: &Path) -> Option<InstalledHookEnv> {
let content = fs_err::read_to_string(root.join(HOOK_MARKER)).ok()?;
serde_json::from_str(&content).ok()
}
Expand All @@ -782,30 +807,6 @@ fn truncate_end(s: &str, max_chars: usize) -> String {
out
}

fn split_repo_dependency(deps: &FxHashSet<String>) -> (Option<String>, Vec<String>) {
// Best-effort: the remote repo dependency is typically `repo@rev`.
// Prefer URL-like values to avoid accidentally treating PEP508 deps as repo identifiers.
let mut repo_dep: Option<String> = None;
let mut rest = Vec::new();

for dep in deps {
if repo_dep.is_none()
&& dep.contains('@')
&& (dep.contains("://")
|| dep.starts_with('/')
|| dep.starts_with("..")
|| dep.starts_with('.'))
{
repo_dep = Some(dep.clone());
} else {
rest.push(dep.clone());
}
}

rest.sort_unstable();
(repo_dep, rest)
}

fn format_dependency_list(deps: &[String], max_items: usize, max_chars: usize) -> String {
if deps.is_empty() {
return String::new();
Expand Down Expand Up @@ -843,33 +844,6 @@ mod tests {
assert_eq!(truncate_end("ééé", 2), "é…");
}

#[test]
fn split_repo_dependency_prefers_url_like_repo_at_rev() {
let mut deps = FxHashSet::default();
deps.insert("requests==2.32.0".to_string());
deps.insert("black==24.1.0".to_string());
deps.insert("https://github.com/pre-commit/[email protected]".to_string());

let (repo_dep, rest) = split_repo_dependency(&deps);

assert_eq!(
repo_dep.as_deref(),
Some("https://github.com/pre-commit/[email protected]")
);
assert_eq!(rest, vec!["black==24.1.0", "requests==2.32.0"]);
}

#[test]
fn split_repo_dependency_returns_none_when_no_repo_like_dep() {
let mut deps = FxHashSet::default();
deps.insert("requests==2.32.0".to_string());
deps.insert("black==24.1.0".to_string());

let (repo_dep, rest) = split_repo_dependency(&deps);
assert!(repo_dep.is_none());
assert_eq!(rest, vec!["black==24.1.0", "requests==2.32.0"]);
}

#[test]
fn format_dependency_list_includes_more_suffix() {
let deps = vec!["a".to_string(), "b".to_string(), "c".to_string()];
Expand Down
Loading
Loading