当前位置: 首页 > java >正文

【基础】Python包管理工具uv使用全教程

一、uv简介

uv 是由 Astral(前身为 Basis)团队开发的 Python 包安装器和解析器,完全使用 Rust 语言编写。与传统 Python 工具不同,uv 将多个工具的功能整合到一个高性能的解决方案中,旨在提供更现代、更高效的 Python 开发体验。

底层技术原理

uv 之所以能够实现显著的性能提升,主要基于几个关键技术:

  1. Rust 实现:利用 Rust 语言的内存安全和高性能特性,避免了 Python 自身的解释开销
  2. 并行处理:在依赖解析和包下载安装过程中大量使用并行处理
  3. 优化的缓存策略:智能缓存机制减少重复下载和编译
  4. 零拷贝设计:减少内存使用和系统调用
  5. 编译优化:对于需要编译的包,采用更高效的编译策略

uv性能 

uv一个极快的 Python 包和项目管理器,用 Rust 编写,有多快呢,看图说话:

突出特点 

​🚀 一款工具,可替代 pip、pip-tools、pipx、poetry、pyenv、twine、virtualenv 等,并更多。
⚡️ 比 pip 快 10-100 倍 。
🗂️ 提供全面的项目管理 ,具有 通用的锁文件 。
❇️ 运行脚本 ,支持 内联依赖元数据 .
🐍 安装和管理 Python 版本。
🛠️ 运行和安装 发布为 Python 包的工具。
🔩 包含一个 与 pip 兼容的接口 ,以熟悉的 CLI 提升性能。
🏢 支持 Cargo 风格的工作区 ,适用于可扩展的项目。
💾 磁盘空间高效,具有全局缓存以进行依赖项去重。
⏬ 无需 Rust 或 Python,通过 curl 或 pip 即可安装。
🖥️ 支持 macOS、Linux 和 Windows。

二、安装

根据你的操作系统,选择安装方式,Windows安装,需要powershell。

# On macOS and Linux.
curl -LsSf https://astral.sh/uv/install.sh | sh# On Windows.
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"# With pip.
pip install uv#如果你支持pipx,也可以安装到隔离环境中
pipx install uv

执行界面:

 注:dos窗口重新打开,才能开到更新的环境变量,才能使用新安装的uv工具。

 另:如果需要更多安装方式或者卸载,见:https://docs.astral.sh/uv/getting-started/installation/#pypi

三、uv功能

uv 为 Python 开发提供必要功能——从安装 Python 和编写简单的脚本到处理支持多个 Python 版本和平台的复杂项目。

Python 版本管理

Python 版本由 Python 解释器(即 python 可执行文件)、标准库和其他支持文件组成。安装和管理 Python 本身。

  • uv python install:安装 Python 版本。
  • uv python list:查看可用的 Python 版本。
  • uv python find:查找已安装的 Python 版本。
  • uv python pin:将当前项目固定到使用特定 Python 版本。
  • uv python uninstall:卸载 Python 版本。

命令示例:

uv python list  # 查看uv支持的python版本uv python install 3.10 3.11 3.12 # 安装指定版本的Pythonuv python find 3.10  # 查找特定版本的pythonuv python uninstall 3.10  # 卸载特定版本的pythonuv run --python 3.12 python  # 指定版本运行python交互界面
uv run -p 3.12 python  # 指定版本运行python交互界面
uv run --python pypy@3.8 python
uv run -p pypy@3.8 pythonuv python pin 3.11  # 在当前目录中使用特定的 Python 版本

运行脚本

运行无依赖项的脚本

执行独立的 Python 脚本,例如 example.py。

example.py

print("Hello world")

 执行它:

 如果您的脚本依赖于 standard 库中的模块,也不需要安装依赖,执行命令是一样的。

 如果需要向脚本提供参数,如:

example.py

import sys print(" ".join(sys.argv[1:]))

 执行效果:

此外,您可以直接从 stdin 读取您的脚本:

$ echo 'print("hello world!")' | uv run -

注意,如果你在一个项目中使用 uv run,即一个带有 pyproject.toml 的目录,它会在运行脚本之前进行安装。如果您的脚本不依赖于项目,可以使用 --no-project 标志跳过此步骤:

# Note: the `--no-project` flag must be provided _before_ the script name.
uv run --no-project example.py

运行有依赖项的脚本

当您的脚本需要其他软件包时,必须将它们安装到 脚本运行环境中。可以使用 pyproject.toml管理依赖,uv会在执行脚步前进行安装。同时, UV 也支持每次调用请求依赖项。

例如,以下脚本需要 rich

example.py

import time
from rich.progress import trackfor i in track(range(20), description="For example:"):time.sleep(0.05)

 使用 --with 选项请求依赖项:

$ uv run --with rich example.py

执行效果:

如果需要特定版本,可以将 constraints 添加到请求的依赖项中:

$ uv run --with 'rich>12,<13' example.py

可以通过使用 --with 选项重复来请求多个依赖项。

运动带有Python内置依赖 

如果python脚本,在脚本本身中声明脚本的依赖项,用--script参数执行。

以下是包含嵌入元数据的脚本示例:

# /// script
# requires-python = ">=3.11"
# dependencies = [
#   "requests<3",
#   "rich",
# ]
# ///import requests
from rich.pretty import pprintresp = requests.get("https://peps.python.org/api/peps.json")
data = resp.json()
pprint([(k, v["title"]) for k, v in data.items()][:10])

使用 uv init --script 使用内联元数据初始化脚本, 它允许选择 Python 版本和定义依赖项:

uv init --script example.py --python 3.12

 UV 支持为您添加和更新内联脚本元数据。使用 uv add --script 声明脚本的依赖项: 

uv add --script example.py 'requests<3' 'rich'

 这将在脚本顶部添加一个脚本部分,使用 TOML 声明依赖项:

example.py

# /// script
# dependencies = [
#   "requests<3",
#   "rich",
# ]
# ///import requests
from rich.pretty import pprintresp = requests.get("https://peps.python.org/api/peps.json")
data = resp.json()
pprint([(k, v["title"]) for k, v in data.items()][:10])

命令一览表

  • uv run:运行脚本。
  • uv add --script:向脚本添加依赖。
  • uv remove --script: 从脚本中移除依赖

项目

uv 支持管理 Python 项目,这些项目在 pyproject.toml 文件中定义它们的依赖项。

创建新项目

您可以使用 uv init 命令创建新的 Python 项目:

uv init hello-world
cd hello-world

或者,您可以在工作目录中初始化一个项目:

mkdir hello-world
cd hello-world
uv init

UV 将创建以下文件:

.
├── .python-version
├── README.md
├── main.py
└── pyproject.toml

main.py 文件包含一个简单的 “Hello world” 程序。用 uv run 试试:

uv run main.py

项目结构

项目由几个重要的部分组成,这些部分协同工作并允许 uv 管理您的项目。除了 uv init 创建的文件外,uv 在你第一次执行项目命令,即 uv run, uv sync或uv lock时,会在项目根目录中,创建一个虚拟环境和 uv.lock 文件 。

完整的列表如下所示:

.
├── .venv
│   ├── bin
│   ├── lib
│   └── pyvenv.cfg
├── .python-version
├── README.md
├── main.py
├── pyproject.toml
└── uv.lock

pyproject.toml 文件

pyproject.toml 包含有关项目的元数据:

pyproject.toml 文件

[project]
name = "hello-world"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
dependencies = []

您将使用此文件指定依赖项,以及有关工程的详细信息,例如其描述或许可证。您可以手动编辑此文件,也可以使用 uv add 和 UV Remove 从终端管理您的项目。

命令一览表:

  • uv init: 创建新的 Python 项目。
  • uv add: 向项目添加依赖。
  • uv remove: 从项目中移除依赖。
  • uv sync: 将项目的依赖与环境同步。
  • uv lock: 为项目的依赖创建锁文件。
  • uv run:在项目环境中运行命令。
  • uv tree:查看项目的依赖树。
  • uv build:将项目构建为分发存档。
  • uv publish:将项目发布到包索引。

工具(tool)

UV 包括一个用于与工具交互的功能。可以使用 uv tool run 在不安装的情况下调用工具,uv提供的uvx命令,和uv tool run  这两个命令完全等效。

如果经常使用某个工具,使用 uv tool install 安装,安装后除非卸载该工具,否则不会删除环境。

工作原理

默认情况下,uv 工具目录名为 tools,位于 uv 应用程序目录中,例如 ~/.local/share/uv/tools。

使用uvx/uv tool run 运行工具时,虚拟环境将存储在 uv 缓存目录中,并被视为一次性环境,即,如果运行 uv cache clean,环境将被删除。

使用 uv tool install 安装工具时,将在 uv tools 目录中创建一个虚拟环境。除非卸载该工具,否则不会删除环境。如果手动删除环境,该工具将无法运行。

命令一览表

  • uvx / uv tool run :在临时环境中运行工具。
  • uv tool install :全局安装工具。
  • uv tool uninstall :卸载工具。
  • uv tool list :列出已安装的工具。
  • uv tool update-shell:更新 shell 以包含工具可执行文件。

兼容pip

手动管理环境和包 — 适用于旧式工作流程或高级命令无法提供足够控制的情况。

创建虚拟环境(替代 venv 和 virtualenv):

  • uv venv:创建一个新的虚拟环境。
     

在环境中管理包(替换 pip 和 pipdeptree):

  • uv pip install:将包安装到当前环境。
  • uv pip show:显示已安装包的详细信息。
  • uv pip freeze:列出已安装的包及其版本。
  • uv pip check:检查当前环境是否有兼容的包。
  • uv pip list:列出已安装的包。
  • uv pip uninstall:卸载包。
  • uv pip tree:查看环境的依赖树。

锁定环境中的包(替换 pip-tools):

  • uv pip compile:将需求编译到锁文件中。
  • uv pip sync: 使用锁文件同步环境。
     

重要提示:这些命令和原pip命令不完全一致,具体使用时,需进一步阅读手册。

应用

管理和检查 uv 的状态,例如缓存、存储目录或执行自我更新:

  • uv cache clean :删除缓存条目。
  • uv cache prune:删除过时的缓存条目。
  • uv cache dir:显示 uv 缓存目录路径。
  • uv tool dir:显示 uv 工具目录路径。
  • uv python dir:显示 uv 安装的 Python 版本路径。
  • uv self update :将 uv 更新到最新版本。

帮助菜单

--help 标志可用于查看命令的帮助菜单,例如,对于 uv:

uv --help

要查看特定命令的帮助菜单,例如 uv init:

uv init --help

使用 --help 标志时,uv 会显示一个精简的帮助菜单。要查看命令的较长帮助菜单,请使用 uv 帮助 :

uv help

要查看特定命令的长帮助菜单,例如 uv init:

uv help init

当使用较长的帮助菜单时,uv 将尝试使用更少或更多的 “page” 输出,以便它不会一次全部显示。要退出寻呼机,请按 q。

查看版本

寻求帮助时,确定您正在使用的 uv 版本很重要——有时问题已经在较新的版本中得到解决。

要检查已安装的版本:

uv version

以下内容也有效:

  • uv --version      # Same output as `uv version`
  • uv -V             # Will not include the build commit and date
  • uv pip --version  # Can be used with a subcommand

构建和发布包

uv 支持通过 uv build 将 Python 包构建到源代码和二进制分发中,并使用 UV publish 将它们上传到注册表。

准备要打包的项目,必须构建 Python 项目才能安装,此过程通常称为 “打包”。Python 项目元数据在 pyproject.toml 文件。

构建包

使用 uv build 构建包:

uv build

默认情况下,uv build 将在当前目录中构建项目,并将构建的工件放在 dist/ 子目录中。

发布包

使用 uv publish 发布包:

uv publish

使用 --token 或 UV_PUBLISH_TOKEN 设置 PyPI 令牌,PyPI 不再支持使用用户名和密码进行发布,而是需要生成令牌。

安装软件包

测试是否可以使用 uv run 安装和导入包:

uv run --with <PACKAGE> --no-project -- python -c "import <PACKAGE>"

--no-project 标志用于避免从本地项目目录安装软件包。

四、uvx运行时工具

许多 Python 包都提供了可用作工具的应用程序。UV 具有专门的支持,uvx 命令可以调用工具而不安装,使用 uvx 时,工具会被安装到临时的、隔离的环境中。与npx相似。

例如,要运行 ruff:

uvx ruff

这正是等价的:

uv tool run ruff

五、官方参考

官方文档:https://docs.astral.sh/uv/

http://www.xdnf.cn/news/4345.html

相关文章:

  • Java日期格式化方法总结
  • DApp 开发:开启去中心化应用新时代
  • Spring事务和事务传播机制
  • C语言| 递归和循环的优缺点
  • 塔能水泵节能方案:精准驱动工厂能耗优化
  • 展锐Android13禁止用户使用超级省电
  • 新一代Python专业编译器Nuitka简介
  • ROS2:自定义接口文件(无废话)
  • 多模态理论知识
  • 二叉树与堆排序(概念|遍历|实现)
  • python酒店在线预定管理系统-酒店客房管理系统-快捷酒店入住系统
  • 【Linux系统】vim编辑器的使用
  • FoMo 数据集是一个专注于机器人在季节性积雪变化环境中的导航数据集,记录了不同季节(无雪、浅雪、深雪)下的传感器数据和轨迹信息。
  • C语言编程--递归程序--求数组的最大元素值
  • 油气地震资料信号处理中的NMO(正常时差校正)
  • 【网络篇】传输层TCP协议的确认应答,超时重传机制
  • IT咨询——企业数据资产怎样评估
  • 满分PPT | 基于数据运营的新型智慧城市实践与思考智慧城市数据中台解决方案智能建筑与智慧城市建设方案
  • 基于nacos实现动态线程池设计与实践:告别固定配置,拥抱弹性调度
  • LabVIEW与 IMAQ Vision 机器视觉应用
  • C++类与对象基础续
  • 15.命令模式:思考与解读
  • 毫米波雷达原理(最通俗的解释)
  • MATLAB程序演示与编程思路,相对导航,四个小车的形式,使用集中式扩展卡尔曼滤波(fullyCN-EKF)
  • go 编译报错:build constraints exclude all Go files
  • Python使用爬虫ip抓取热点新闻
  • autojspro怎么免费用
  • 【原创分享】魔音变声器内含超多语音包实时变声
  • C#中从本地(两个路径文件夹)中实时拿图显示到窗口中并接收(两个tcp发送的信号)转为字符串显示在窗体中实现检测可视化
  • 【Wandb】搜索框仅支持正则匹配,不接受“tags:“前缀查询