2024年4月26日追記
この記事ではRye 0.15.2を利用していますが、記事執筆後にリリースされたRye 0.18.0のリリースノートを確認したところ、以下のような記載がありました。
Disable revocation checks on windows to support corporate MITM proxies. #537
要は、Windowsにおける証明書の失効チェックが行われなくなったとのことです。従って、0.18.0以降にアップデートすれば、本記事でのRyeのインストール節やrye sync: 指定したバージョンのPythonバイナリとライブラリをインストール節で紹介しているエラーは発生せず、環境変数さえ設定すれば社内プロキシ配下でも自由に利用可能という現状になっています。（ありがたい・・・！）
繰り返しになりますが、これ以降の内容は、Rye 0.15.2を利用した際の内容であり、最新バージョンはこの記事でのRyeの挙動とは異なるということ、ご了承ください。
はじめに
こんにちは！
私は普段Pythonを使ってコーディングをすることが多いのですが、Pythonのパッケージ管理は様々なツールが群雄割拠の状況であり、何を使うべきか悩まされることが多いです。
本記事では、数あるパッケージ管理ツールの中で、個人的に使い勝手が良いと感じたRyeを紹介します。また、社内プロキシ環境で使う上で躓いた点とどう対処したかについても記していきたいと思います。
Ryeとは
Ryeは、Armin Ronacher氏がRustにて開発したPythonのパッケージ管理ツールです。
各種リンクは以下の通りです。
Ryeができることとして、例えば以下があります。
- Pythonのインストール、及びバージョン管理
- ライブラリのバージョン、依存関係の管理
- 仮想環境（venv）の作成
これまで、私はpoetryをよく使っていましたが、Pythonのインストールやバージョン管理は個別に実施するか、pyenvといった別のツールを利用する必要がありました。一方、Ryeを使えばPythonの管理も含めて、ワンストップで行えます。また、Rust製ということで動作も早く、個人的に使い勝手がよいなあと感じております。
Githubやドキュメントでも述べられている通り、RyeはまだExperimentalな段階とのことなので、個人開発や検証のみに使うことをお勧めします。
Ryeを社内プロキシ環境で使う
それでは、Ryeを社内プロキシ環境で使ってみたいと思います。
本記事では以下を実施します。
- Ryeのインストール
- Ryeプロジェクトの作成
- ライブラリの追加
- Pythonバージョンの変更
また、動作環境は以下の通りです。
- OS : Windows10
- rye : 0.15.2
本記事の趣旨は「社内プロキシ環境でRyeを使う」であるため、基本的な使い方しか紹介しません。もし、よりDeepな機能を知りたい方は公式のドキュメントや、以下をはじめとした他の方の記事を参照していただければと思います。
Ryeのインストール
とりあえずドキュメントに従ってインストール
以下のドキュメントに従ってインストールを行います。
https://rye-up.com/guide/installation/
上記ページから、お使いのPCに合った実行ファイルをダウンロードし実行すると、ryeのバイナリ（rye.exe）と、内部用のPythonバイナリがダウンロードされます。
Ryeは裏でpip-toolsを利用しているとのことで、ここでPythonをインストールする理由は、主にそれら内部の用途のためという認識です。
それでは以下を実行し、社内プロキシ環境で実際にインストールしてみます。
set RYE_HOME=C:\hogehoge\rye
rye-x86_64-windows.exe
以下、インストールの詳細です。
- 実行環境はWindows（64ビット）であったため、それに合わせて
rye-x86_64-windows.exeでインストールを実行しています。 - 環境変数
RYE_HOMEにC:\hogehoge\ryeを指定し、ダウンロード先をデフォルト（%USERPROFILE%\.rye）から変更しています。 - Rye
0.15.2において、内部用のPythonのデフォルトバージョンはcpython@3.11.6でした。
実行結果は以下の通りです。
Welcome to Rye!
Rye has detected that it's not installed on this computer yet and
automatically started the installer for you. For more information
read https://rye-up.com/guide/installation/
This installer will install rye to C:\hogehoge\rye
This path can be changed by exporting the RYE_HOME environment variable.
Details:
Rye Version: 0.15.2
Platform: windows (x86_64)
Continue? yes
Installed binary to C:\hogehoge\rye
Bootstrapping rye internals
Downloading cpython@3.11.6
error: failed to fetch internal cpython toolchain cpython@3.11
Caused by:
0: download of https://github.com/indygreg/python-build-standalone/releases/download/20231002/cpython-3.11.6%2B20231002-x86_64-pc-windows-msvc-shared-pgo-full.tar.zst failed
1: [35] SSL connect error (schannel: next InitializeSecurityContext failed: Unknown error (0x80092012))
Press any key to continue
早速、SSL connect errorが発生しました。ログを読み取ると、Ryeのインストールは成功したものの、Pythonのインストール時、github.com へアクセスした際にエラーが発生したという状況の様です。（実際に、rye.exeは所定のディレクトリにインストールされていましたが、Pythonはありませんでした。）
実は、弊社内プロキシがgithub.comへのアクセスの際に証明書を指定する必要があり、これが原因であると考えられます。
じゃあ、証明書を指定すればよいという話になるのですが、ドキュメントを見てもその方法は見つかりませんでした。以下の進行中のイシューでも同様の事象が発生しており、現状はできなさそうです。（もし、ご存じの方がいれば、教えてくださいm(__)m）
今回は回避策として、手動でPythonバイナリをダウンロードして、それをRyeに読み込ませたいと思います。これは、Ryeのインストールの前に環境変数RYE_TOOLCHAIN を設定することで実現できます。
例えば、ドキュメントでは、以下のように指定しています。
set RYE_TOOLCHAIN=%USERPROFILE%\AppData\Local\Programs\Python\Python310\python.exe
rye-x86_64-windows.exe
この例では、%USERPROFILE%\AppData\Local\Programs\Python配下にインストール済みのPython 3.10を指定しています。
ドキュメントにもある通り、ここで指定できるのは、CPythonの3.9～3.11のみとのことなので、注意してください。
Ryeのソースコード上で、ダウンロードを実行する箇所は以下です。将来的には、この辺りがうまく修正されれば指定できるようになるかと思います。
手動でPythonをダウンロードした後に、Ryeをインストール
それでは、RYE_TOOLCHAINに手動でダウンロードしたPythonを指定した後、再度Ryeのインストールを実行し、先ほどのエラーが発生しないかを確認します。
まず、初めに、https://github.com/indygreg/python-build-standalone/releases から、Python 3.11.6をzst形式でダウンロードし、それを解凍した後、C:\hogehoge\cpython-3.11-manual\に配置します。
cpython-3.11-manual
├── build
├── install
└── python.exe
├── licenses
└──PYTHON.json
その後、以下を実行し、Ryeをインストールします。
set RYE_TOOLCHAIN=C:\hogehoge\cpython-3.11-manual\install\python.exe
set RYE_HOME=C:\hogehoge\rye
rye-x86_64-windows.exe
RYE_TOOLCHAINには、先ほど配置したC:\hogehoge\cpython-3.11-manual\install\python.exeを指定します。
実行結果は以下の通りです。
Welcome to Rye!
Rye has detected that it's not installed on this computer yet and
automatically started the installer for you. For more information
read https://rye-up.com/guide/installation/
This installer will install rye to C:\hogehoge\rye
This path can be changed by exporting the RYE_HOME environment variable.
Details:
Rye Version: 0.15.2
Platform: windows (x86_64)
Continue? yes
Installed binary to C:\hogehoge\rye\shims\rye.exe
Registering toolchain at C:\hogehoge\rye\py\cpython-3.11-manual\install\python.exe
Registered toolchain as cpython@3.11.6
Bootstrapping rye internals
Found a compatible python version: cpython@3.11.6
WARNING: Retrying (Retry(total=4, connect=None, read=None, redirect=None, status=None)) after connection broken by 'ProxyError('Cannot connect to proxy.', OSError('Tunnel connection failed: 407 Proxy Authentication Required'))': /simple/pip/
------------------省略------------------
ERROR: No matching distribution found for pip==23.1
error: failed to initialize virtualenv (upgrade pip)
Press any key to continue
今度は別のエラーが発生しました。具体的には、pipのインストールの際にProxyErrorが発生しています。これは、単に環境変数HTTPS_PROXYを指定することで、解決できます。
set RYE_TOOLCHAIN=C:\hogehoge\cpython-3.11-manual\install\python.exe
set RYE_HOME=C:\hogehoge\rye
set HTTPS_PROXY=<プロキシURL>
rye-x86_64-windows.exe
Welcome to Rye!
Rye has detected that it's not installed on this computer yet and
automatically started the installer for you. For more information
read https://rye-up.com/guide/installation/
This installer will install rye to C:\hogehoge\rye
This path can be changed by exporting the RYE_HOME environment variable.
Details:
Rye Version: 0.15.2
Platform: windows (x86_64)
Continue? yes
Installed binary to C:\hogehoge\rye\shims\rye.exe
Registering toolchain at C:\hogehoge\cpython-3.11-manual\install\python.exe
Registered toolchain as cpython@3.11.6
Bootstrapping rye internals
Found a compatible python version: cpython@3.11.6
Upgrading pip
Installing internal dependencies
Updated self-python installation at C:\hogehoge\rye\self
Note: You need to manually add %USERPROFILE%\.rye to your PATH.
For more information read https://mitsuhiko.github.io/rye/guide/installation
All done!
Press any key to continue
やっと、エラー無くRyeをインストールすることができました。それでは、実際にRyeを使ってみたいと思います。
rye init: プロジェクトを作成
rye initによって、カレントディレクトリにプロジェクトを作成することができます。
rye init
以下が出力されたら成功です。（ 以下は、C:\test_rye\.での実行結果です。）
success: Initialized project in C:\test_rye\.
Run `rye sync` to get started
rye initによって、デフォルトでは以下のようなディレクトリ構成のプロジェクトが作成されます。
test_rye
├── .git
├── .gitignore
├── .python-version
├── README.md
├── pyproject.toml
└── src
└── my_project
└── __init__.py
特に、pyproject.tomlがライブラリのバージョン等を管理し、.python-versionがプロジェクト内でのPythonのバージョンを管理します。具体的に、それぞれのファイルの内容は以下の通りでした。
[project]
name = "test-rye"
version = "0.1.0"
description = "Add your description here"
authors = [
{ name = "hogehoge", email = "hogehoge@hogehoge.jp" }
]
dependencies = []
readme = "README.md"
requires-python = ">= 3.8"
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[tool.rye]
managed = true
dev-dependencies = []
[tool.hatch.metadata]
allow-direct-references = true
cpython-x86_64-windows@3.12.0
.python-versionより、Ryeの0.15.2では、Pythonのバージョンとして3.12.0が指定されるようです。
rye add: ライブラリを追加
rye addによってライブラリをプロジェクトに追加できます。
例えば、以下を実行し、numpyを追加します。
rye add numpy
これにより、pyproject.tomlのdependenciesにnumpyの記述が追加されます
[project]
name = "test-rye"
version = "0.1.0"
description = "Add your description here"
authors = [
{ name = "hogehoge", email = "hogehoge@hogehoge.jp" }
]
dependencies = [
"numpy>=1.24.4",
]
readme = "README.md"
requires-python = ">= 3.8"
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[tool.rye]
managed = true
dev-dependencies = []
[tool.hatch.metadata]
allow-direct-references = true
なお、poetryとは異なり、rye addの実行だけでは、ライブラリのインストールは実行されない点に注意してください。（後述のrye syncの実行時にインストールされます。）
rye pin: プロジェクト内のPythonバージョンを指定
rye pinによって、プロジェクト内で利用するPythonバージョンを変更できます。
ここでは、Ryeのインストール時にダウンロードした内部用のPythonに合わせて、3.11.6を指定します。
rye pin 3.11.6
これにより、.python-versionも以下のように変更されます。
3.11.6
上記はCPythonの例です。他にPyPyも指定可能ですが、この記事ではCPythonしか扱いません。PyPyの指定方法の詳細はドキュメントを参照してください。
rye sync: 指定したバージョンのPythonバイナリとライブラリをインストール
rye syncの実行によって、指定したバージョンのPythonバイナリやライブラリをインストールし、仮想環境を作成します。
まず、rye syncの前にプロキシの設定を済ませておきます。
環境変数HTTP_PROXY、HTTPS_PROXYが設定されていればOKですが、rye config によって、環境変数とは別のプロキシを指定することもできます。
rye config --set proxy.http=<プロキシのURL>
rye config --set proxy.https=<プロキシのURL>
以上を実行すると、%RYE_HOME%\config.tomlが以下のようになるかと思います。
[proxy]
http = <プロキシのURL>
https = <プロキシのURL>
その後、rye syncを実行します。結果は以下の通りです。
なお、Pythonの3.11.6はRyeのインストール時にダウンロード済みなので、以下ではPythonバイナリのダウンロードはスキップされているようです。
Initializing new virtualenv in C:\test_rye\.venv
Python version: cpython@3.11.6
Generating production lockfile: C:\test_rye\requirements.lock
Creating virtualenv for pip-tools
Generating dev lockfile: C:\test_rye\requirements-dev.lock
Installing dependencies
Looking in indexes: https://pypi.org/simple/
Obtaining file:///. (from -r C:\hogehoge\vscode\data\tmp\tmpobcr459e (line 1))
Installing build dependencies ... done
Checking if build backend supports build_editable ... done
Getting requirements to build editable ... done
Preparing editable metadata (pyproject.toml) ... done
Collecting numpy==1.26.2 (from -r C:\hogehoge\vscode\data\tmp\tmpobcr459e (line 2))
Using cached numpy-1.26.2-cp311-cp311-win_amd64.whl (15.8 MB)
Building wheels for collected packages: test-rye
Building editable for test-rye (pyproject.toml) ... done
Created wheel for test-rye: filename=test_rye-0.1.0-py3-none-any.whl size=1064 sha256=fb5f3f3601d674cb018161c9a46cb2db4cb127f9246446a27609026e5c582573
Stored in directory: C:\hogehoge\vscode\data\tmp\pip-ephem-wheel-cache-t8f6dp7x\wheels\97\54\f5\d849319cdfa096e074df352654ee2e7c919da8951f090690c6
Successfully built test-rye
Installing collected packages: test-rye, numpy
Successfully installed numpy-1.26.2 test-rye-0.1.0
Done!
以上により、.venvの他、requirements.lockやrequirements-dev.lockが生成されます。
その後、仮想環境に入り、numpyが実行できることを確認します。
.venv\Scripts\activate
python -c "import numpy as np; print(np.array([1, 2, 3, 4, 5]))"
[1 2 3 4 5]
うまく実行できました！
ダウンロードされていないバージョンのPythonを指定してみる
先ほどの実行では、インストール済みのPythonのバージョン（3.11.6）を指定しましたが、次に、ダウンロードされていないバージョンを指定し、再度rye syncを実行してみます。
具体的には、以下を実行します。ここでは、3.12を指定しています。
rye pin 3.12
rye sync
Python version mismatch (found cpython@3.11.6, expect cpython@3.12.0), recreating.
Downloading cpython@3.12.0
error: failed fetching toolchain ahead of sync
Caused by:
0: download of https://github.com/indygreg/python-build-standalone/releases/download/20231002/cpython-3.12.0%2B20231002-x86_64-pc-windows-msvc-shared-pgo-full.tar.zst failed
1: [35] SSL connect error (schannel: next InitializeSecurityContext failed: Unknown error (0x80092012))
例のSSLエラーが発生しました。
そこで、Ryeのインストール時と同様に手動でダウンロードして、Ryeに読み込ませたいと思います。しかし、Ryeのインストール時とは異なり、RYE_TOOLCHAINのような環境変数は用意されてなさそうなので、ここは、気合で指定します。
具体的には、%RYE_HOME%\py に配置します。また、ディレクトリ名もcpython@major.minor.patch にする必要があります。（このようにしないと、読み込まれませんでした。）
本記事の例では、%RYE_HOME%がC:\hogehoge\ryeであるため、以下のようなディレクトリ配置になりました。
C:\hogehoge\rye
└──cpython@3.12.0
├── build
├── install
└── python.exe
├── licenses
└──PYTHON.json
以上はドキュメントに未掲載のやり方なので、今後の更新次第では実行できなくなる可能性があることに注意してください。
その後再び以下を実行します。
rye pin 3.12
rye sync
Python version mismatch (found cpython@3.11.6, expect cpython@3.12.0), recreating.
Initializing new virtualenv in C:\test_rye\.venv
Python version: cpython@3.12.0
Generating production lockfile: C:\test_rye\requirements.lock
Creating virtualenv for pip-tools
Generating dev lockfile: C:\test_rye\requirements-dev.lock
Installing dependencies
Looking in indexes: https://pypi.org/simple/
Obtaining file:///. (from -r C:\hogehoge\vscode\data\tmp\tmppk6qzwp2 (line 1))
Installing build dependencies ... done
Checking if build backend supports build_editable ... done
Getting requirements to build editable ... done
Preparing editable metadata (pyproject.toml) ... done
Collecting numpy==1.26.2 (from -r C:\hogehoge\vscode\data\tmp\tmppk6qzwp2 (line 2))
Downloading numpy-1.26.2-cp312-cp312-win_amd64.whl (15.5 MB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 15.5/15.5 MB 5.9 MB/s eta 0:00:00
Building wheels for collected packages: test-rye
Building editable for test-rye (pyproject.toml) ... done
Created wheel for test-rye: filename=test_rye-0.1.0-py3-none-any.whl size=1064 sha256=fb5f3f3601d674cb018161c9a46cb2db4cb127f9246446a27609026e5c582573
Stored in directory: C:\hogehoge\vscode\data\tmp\pip-ephem-wheel-cache-cykv_nx_\wheels\8b\19\c8\73a63a20645e0f1ed9aae9dd5d459f0f7ad2332bb27cba6c0f
Successfully built test-rye
Installing collected packages: test-rye, numpy
Successfully installed numpy-1.26.2 test-rye-0.1.0
Done!
Python 3.12.0を読み込ませることに成功したようです。ログを見ると、Pythonバージョンを変えると、.venvらが再構築されていることがわかると思います。
なお、Pythonのダウンロードはバージョンごとに一度でOKなので、以降はPythonの3.11.6と3.12.0はプロキシを気にせずに行き来することができるはずです。
Ryeの機能は他にもいろいろありますが、基本的な機能は紹介しましたので、本記事はここで以上にしたいと思います。
まとめ
本記事では、Pythonのパッケージ管理ツールであるRyeを紹介し、また、社内プロキシ環境で使う上で躓いた点とどう対処したかについても紹介しました。やや、力技で解決したところもあり恐縮ですが、そこは、今後の更新に期待したいと思います。
何か、不明点、間違っている点があれば気軽にコメントでご指摘ください。