Python Pixi 简单使用

  • ~2.47K 字
  • 次阅读
  • 条评论
  1. 1. 安装 Pixi
    1. 1.1. 安装命令
      1. 1.1.1. Windows
      2. 1.1.2. Linux / macOS 等
    2. 1.2. 验证安装是否成功
  2. 2. 创建示例项目
    1. 2.1. 使用 PyCharm 创建示例项目
      1. 2.1.1. 生成并初始化项目
      2. 2.1.2. 安装附属包,使 PyCharm 将其处理为 Conda
    2. 2.2. 使用VSCode创建项目
      1. 2.2.1. 创建并进入项目目录
      2. 2.2.2. 添加 Python 和 Pixi 环境
        1. 2.2.2.1. 初始化 Pixi
        2. 2.2.2.2. 将 Python 添加到目录
      3. 2.2.3. 激活 Pixi 环境
        1. 2.2.3.1. sh的方式 (适用于类Unix和Windows的bash)
        2. 2.2.3.2. PowerShell
  3. 3. 编写运行示例代码
    1. 3.1. 编写 Python 代码
    2. 3.2. 运行 Python 代码
      1. 3.2.1. IDE(如 VS Code、PyCharm)
      2. 3.2.2. 在命令行中运行
    3. 3.3. 输出结果
    4. 3.4. 如何把环境导出给他人
  4. 4. 结尾

本篇文章简单记录 Pixi 环境的搭建过程。

安装 Pixi

官方网站详见这里,也可以点击安装指南查看快速安装方式。

安装命令

以下仅列出部分安装命令,其他方法请点击安装指南进一步查看或者查阅搜索引擎

Windows

这里主要介绍 PowerShell 和 scoop,choco 等安装方式也可以考虑。

1
2
3
4
5
# 使用 PowerShell
powershell -ExecutionPolicy ByPass -c "irm -useb https://pixi.sh/install.ps1 | iex"

# 使用 scoop(注意 pixi 已经存在于 main bucket 中)
scoop install pixi

Linux / macOS 等

注意,可以使用 apt、dnf、Homebrew、pacman、Portage 等方式安装,具体方式取决于所用系统。

1
2
3
4
5
# 使用curl
curl -fsSL https://pixi.sh/install.sh | sh

# 使用wget
wget -qO- https://pixi.sh/install.sh | sh

验证安装是否成功

1
2
# 执行以下命令,检查是否有输出
pixi --version

创建示例项目

以下文字说明主要针对笔者示例所用环境(Windows 11)进行说明,可能与 Linux / macOS 等其他环境有区别,请以最新官方文档为准。

使用 PyCharm 创建示例项目

生成并初始化项目

以下命令主要针对从零开始的环境搭建,如果你想引入已经配置好的文件进项目根目录,请查阅这个链接

1
2
# 在当前目录一键式生成子文件夹并在其中创建项目
pixi init my-pixi-project --format pyproject

操作完成后,启动 PyCharm,用它打开 my-pixi-project 这个项目文件夹。

安装附属包,使 PyCharm 将其处理为 Conda

本步操作安装 pixi-pycharm,可以更方便地在 PyCharm 中使用 Pixi。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
# 请注意,以下的操作命令可能会更新,请及时点击链接查阅文档
# PyCharm 环境中,在导入其他包之前优先安装 pixi-pycharm

# 请切换到项目文件夹内安装
cd my-pixi-project
# 安装附加组件
pixi add pixi-pycharm

# 在项目文件夹内生成与Conda命令兼容的可执行文件
# on Linux/macOS
pixi run 'echo $CONDA_PREFIX/libexec/conda'
# on Windows
pixi run 'echo $CONDA_PREFIX\\libexec\\conda.bat'

注意,因文档时刻更新,关于如何把 PyCharm 当前解释器替换为 Pixi,请以官方文档的最新方法为准。

使用VSCode创建项目

创建并进入项目目录

1
2
3
4
# 创建目录
mkdir my-pixi-project
# 进入指定目录
cd my-pixi-project

添加 Python 和 Pixi 环境

初始化 Pixi

1
pixi init

将 Python 添加到目录

1
2
3
4
5
# 默认已安装版本
pixi add python

# 某个特定版本
pixi init --python=3.11 # 替换为你想要的python版本

激活 Pixi 环境

sh的方式 (适用于类Unix和Windows的bash)

1
pixi shell

PowerShell

1
2
3
4
5
6
# 确保你在项目根目录,即包含 pixi.toml 文件的目录
# 然后执行:
pixi shell-hook | Out-String | Invoke-Expression

# 简便版写法
Invoke-Expression -Command (pixi shell-hook)

你会注意到终端的提示符发生了变化,通常会在前面显示你的项目名(如 my-pixi-project ),这表示你现在正处在一个由 pixi 管理的独立环境中。

编写运行示例代码

编写 Python 代码

我们将创建一个简单的 Python 文件,你可以在终端里用 VSCode 打开当前项目,也可以手动创建。

创建一个名为hello.py的python文件(默认建在项目根目录),写入如下代码:

1
print("Hello, World from Pixi!")

随后,保存此文件。

运行 Python 代码

以下为可能的运行方式(方法不唯一)

IDE(如 VS Code、PyCharm)

  • 在 hello.py 文件中,点击右上角“播放”按钮 (▶)
  • 在编辑器内右键选择 “Run Python File in Terminal”

在命令行中运行

1
python hello.py

输出结果

你应该会看到终端输出形如:

1
Hello, World from Pixi!

如何把环境导出给他人

假设另一个人使用 Conda 环境

1
pixi workspace export conda-environment >> environment.yml

结尾

如果要上传到 GitHub 等代码托管平台,例如本文的样例,仓库只需包含最精要的资产(比如 .gitignorepixi.tomlpixi.lock、源码等),并将所有依赖项交由 Pixi 管理。这样有助于保持仓库整洁,也能保障环境的可复现性。

未来,任何一位开发者克隆您的项目后,无需担忧环境配置的琐碎问题,只需简单的:

1
2
pixi install
pixi run python hello.py

一个与您完全一致的环境就已准备就绪,现在就开始您的高效开发之旅吧!

赞助喵
非常感谢您的喜欢!
赞助喵
分享这一刻
让朋友们也来瞅瞅!