| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152 |
- """Forward the user's package-index and transport configuration into uv.
- PM strips ambient ``UV_*`` so a caller's uv settings cannot steer which
- project, interpreter or cache an operation uses (pm.environment). Index and
- transport knobs are different: on mirrored or air-gapped networks they are the
- only way any dependency resolves at all (#88453, #94613, #95608). Only those
- cross the boundary; the lockfile stays authoritative for what gets installed.
- uv never reads pip's configuration, so a pip-only mirror (``PIP_INDEX_URL`` or
- ``index-url`` in pip.conf) is bridged to ``UV_INDEX_URL`` unless uv already has
- an index of its own. Stdlib only: the bootstrap runner imports this before any
- dependency exists.
- """
- from __future__ import annotations
- from collections.abc import Mapping
- import configparser
- import os
- from pathlib import Path
- import sys
- # Explicit uv index / transport settings that survive into uv. UV_INDEX_<NAME>_
- # {USERNAME,PASSWORD} credentials match by prefix in is_forwarded().
- FORWARDED_UV_SETTINGS = frozenset({
- "UV_INDEX_URL", "UV_EXTRA_INDEX_URL", "UV_DEFAULT_INDEX", "UV_INDEX", "UV_NO_INDEX",
- "UV_FIND_LINKS", "UV_INDEX_STRATEGY", "UV_KEYRING_PROVIDER",
- "UV_NATIVE_TLS", "UV_INSECURE_HOST", "UV_HTTP_TIMEOUT",
- })
- _UV_INDEX_KNOBS = ("UV_INDEX_URL", "UV_DEFAULT_INDEX", "UV_INDEX")
- # pip knob → uv knob, applied only when uv has no value of its own.
- _PIP_TO_UV = (
- ("PIP_EXTRA_INDEX_URL", "UV_EXTRA_INDEX_URL"),
- ("PIP_TRUSTED_HOST", "UV_INSECURE_HOST"),
- )
- TIMEOUT_HINT = ("uv timed out. If your network needs a package mirror, set index-url in "
- "pip.conf (bridged to uv automatically) or UV_INDEX_URL; raise UV_HTTP_TIMEOUT "
- "for slow links.")
- def is_forwarded(key: str) -> bool:
- return key in FORWARDED_UV_SETTINGS or key.startswith("UV_INDEX_")
- # Settings that redirect WHERE packages resolve from (index URLs, find-links,
- # resolution strategy, index credentials). These are what no_config isolation
- # must strip from the child: re-resolving the official-index runtime lockfile
- # against a mirror is exactly what trips `uv sync --locked` (#124418/#125071).
- # Transport knobs (UV_NATIVE_TLS, UV_INSECURE_HOST, UV_HTTP_TIMEOUT) are NOT
- # index redirects — corporate networks need them to reach the pinned URLs at
- # all, so they survive no_config isolation.
- INDEX_REDIRECT_SETTINGS = frozenset({
- "UV_INDEX_URL", "UV_EXTRA_INDEX_URL", "UV_DEFAULT_INDEX", "UV_INDEX", "UV_NO_INDEX",
- "UV_FIND_LINKS", "UV_INDEX_STRATEGY", "UV_KEYRING_PROVIDER",
- })
- def is_index_redirect(key: str) -> bool:
- return key in INDEX_REDIRECT_SETTINGS or key.startswith("UV_INDEX_")
- def pip_config_candidates(env: Mapping[str, str]) -> list[Path]:
- """pip's config files, lowest precedence first, as ``pip._internal.configuration`` ranks them.
- Global, then user (skipped entirely when ``PIP_CONFIG_FILE`` names an existing file), then
- the interpreter's ``sys.prefix`` site file, then ``PIP_CONFIG_FILE`` itself on top.
- ``RawConfigParser.read`` applies them in order, so the last file wins.
- ``PIP_CONFIG_FILE=os.devnull`` disables all of them.
- """
- explicit = env.get("PIP_CONFIG_FILE", "")
- if explicit == os.devnull:
- return []
- home = Path.home()
- if sys.platform == "win32":
- name = "pip.ini"
- global_files = [Path(env.get("ProgramData") or r"C:\ProgramData") / "pip" / name]
- user_files = [home / "pip" / name,
- Path(env.get("APPDATA") or home / "AppData" / "Roaming") / "pip" / name]
- elif sys.platform == "darwin":
- name = "pip.conf"
- global_files = [Path("/Library/Application Support/pip") / name]
- app_support = home / "Library" / "Application Support" / "pip"
- user_files = [home / ".pip" / name,
- (app_support if app_support.is_dir() else home / ".config" / "pip") / name]
- else:
- name = "pip.conf"
- xdg_dirs = (env.get("XDG_CONFIG_DIRS") or "/etc/xdg").split(os.pathsep)
- global_files = [Path(d) / "pip" / name for d in xdg_dirs if d] + [Path("/etc") / name]
- user_files = [home / ".pip" / name, Path(env.get("XDG_CONFIG_HOME") or home / ".config") / "pip" / name]
- explicit_files = [Path(explicit)] if explicit else []
- if explicit_files and explicit_files[0].is_file():
- user_files = []
- return global_files + user_files + [Path(sys.prefix) / name] + explicit_files
- def pip_conf_index_url(env: Mapping[str, str]) -> str | None:
- # Raw: pip does not interpolate, and mirror URLs carry percent-encoded credentials.
- parser = configparser.RawConfigParser()
- try:
- parser.read(str(path) for path in pip_config_candidates(env))
- if not parser.has_section("global"):
- return None
- return parser.get("global", "index-url", fallback="").strip() or None
- except configparser.Error:
- return None
- NPM_PUBLIC_REGISTRY = "https://registry.npmjs.org/"
- def npm_registry(env: Mapping[str, str]) -> str:
- """The npm registry the user configured, as npm resolves it: ``npm_config_registry`` (any
- case) beats ``registry=`` in the user npmrc (``npm_config_userconfig`` or ``~/.npmrc``)."""
- lowered = {key.lower(): value for key, value in env.items()}
- value = (lowered.get("npm_config_registry") or "").strip()
- if not value:
- npmrc = Path(lowered.get("npm_config_userconfig") or Path.home() / ".npmrc").expanduser()
- try:
- lines = npmrc.read_text(encoding="utf-8-sig").splitlines()
- except (OSError, UnicodeDecodeError):
- lines = []
- for line in lines:
- key, sep, candidate = line.partition("=")
- if sep and key.strip().lower() == "registry":
- value = candidate.strip().strip("\"'")
- return value.rstrip("/") + "/" if value.startswith(("https://", "http://")) else NPM_PUBLIC_REGISTRY
- def npm_registry_url(url: str, env: Mapping[str, str]) -> str:
- """*url* on the configured npm registry; non-npm URLs are returned unchanged."""
- if not url.startswith(NPM_PUBLIC_REGISTRY):
- return url
- return npm_registry(env) + url[len(NPM_PUBLIC_REGISTRY):]
- def bridged_index_settings(ambient: Mapping[str, str]) -> dict[str, str]:
- """The uv index/transport settings *ambient* asks for, pip knobs translated.
- ``PIP_INDEX_URL`` beats pip.conf, as in pip; any explicit uv index knob beats both.
- """
- settings = {key: value for key, value in ambient.items() if is_forwarded(key)}
- if not any(settings.get(key) for key in _UV_INDEX_KNOBS):
- index_url = (ambient.get("PIP_INDEX_URL") or "").strip() or pip_conf_index_url(ambient)
- if index_url:
- settings["UV_INDEX_URL"] = index_url
- for pip_key, uv_key in _PIP_TO_UV:
- value = (ambient.get(pip_key) or "").strip()
- if value and not settings.get(uv_key):
- settings[uv_key] = value
- return settings
|