<p data-line="0" class="code-line">複数のプロジェクトでPython開発を行う際、プロジェクト毎にPythonのバージョンや依存パッケージなどを使いわける必要があるかと思います。<br>
本記事ではWindowsで、pyenvとvenvを用いて作成した仮想環境にpipでパッケージをインストールし、Visual Studio Codeで扱うための設定手順について紹介します。</p>
<p data-line="3" class="code-line">Macで同じことをやりたい場合は<a href="https://zenn.dev/sion_pn/articles/d0f9e45716cabb" target="_blank">こちら</a><br style="display:none">
<span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__7d17f68f169f9" src="https://embed.zenn.studio/card#zenn-embedded__7d17f68f169f9" data-content="https%3A%2F%2Fzenn.dev%2Fsion_pn%2Farticles%2Fd0f9e45716cabb" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://zenn.dev/sion_pn/articles/d0f9e45716cabb" style="display:none" target="_blank">https://zenn.dev/sion_pn/articles/d0f9e45716cabb</a></p>
<h1 id="%E7%92%B0%E5%A2%83%E6%A7%8B%E7%AF%89" data-line="6" class="code-line">
<a class="header-anchor-link" href="#%E7%92%B0%E5%A2%83%E6%A7%8B%E7%AF%89" aria-hidden="true"></a> 環境構築</h1>
<h2 id="pyenv-win%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" data-line="7" class="code-line">
<a class="header-anchor-link" href="#pyenv-win%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" aria-hidden="true"></a> pyenv-winをインストール</h2>
<p data-line="8" class="code-line">Pythonのバージョン管理ツールであるpyenvのWindows版を、PowerShellを使ってインストールします。<br style="display:none">
<span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__7a2fefda6eea4" src="https://embed.zenn.studio/card#zenn-embedded__7a2fefda6eea4" data-content="https%3A%2F%2Fgithub.com%2Fpyenv-win%2Fpyenv-win%23installation" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/pyenv-win/pyenv-win#installation" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/pyenv-win/pyenv-win#installation</a></p>
<p data-line="11" class="code-line">まず、Windows PowerShellを管理者権限で開きます。<br>
次に、以下のコマンドでスクリプト実行可否を確認します。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="13">Get-ExecutionPolicy -Scope LocalMachine
</code></pre>
</div><p data-line="16" class="code-line"><code>Undefined</code>または<code>Restricted</code>という値が返ってきたら、スクリプトの実行が制限されているため、以下のコマンドで権限を変更します。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="17">Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine
</code></pre>
</div><p data-line="20" class="code-line">実行ポリシーを変更するか聞かれるので、<code>Y</code>を入力してエンターを押します。</p>
<p data-line="22" class="code-line">再度<code>get-executionpolicy</code>を実行し、<code>RemoteSigned</code>になっていることが確認出来たら、以下のコマンドを実行します。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="23">Invoke-WebRequest -UseBasicParsing -Uri "https://raw.githubusercontent.com/pyenv-win/pyenv-win/master/pyenv-win/install-pyenv-win.ps1" -OutFile "./install-pyenv-win.ps1"; &amp;"./install-pyenv-win.ps1"
</code></pre>
</div><p data-line="27" class="code-line">本記事では以降もPowerShellを使いますが、CommandPromptを使用したい方はお好みでPowerShellの実行権限を元に戻すことができます。<br>
PowerShellで引き続きpyenvを扱いたい方は、<code>RemoteSigned</code>以上の権限のままにしておきましょう。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="29">set-executionpolicy restricted
</code></pre>
</div><p data-line="33" class="code-line">なお、インストール直後はまだPATHが正常に通っていない状態なため、次の工程に進む前に一度PowerShellを閉じて開きなおしておくとよいでしょう。</p>
<h2 id="pyenv%E3%81%A7python%E3%82%92%E3%83%90%E3%83%BC%E3%82%B8%E3%83%A7%E3%83%B3%E6%8C%87%E5%AE%9A%E3%81%97%E3%81%A6%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" data-line="35" class="code-line">
<a class="header-anchor-link" href="#pyenv%E3%81%A7python%E3%82%92%E3%83%90%E3%83%BC%E3%82%B8%E3%83%A7%E3%83%B3%E6%8C%87%E5%AE%9A%E3%81%97%E3%81%A6%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" aria-hidden="true"></a> pyenvでpythonをバージョン指定してインストール</h2>
<p data-line="36" class="code-line">pyenvで提供されているバージョンの一覧を取得します。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="37">pyenv install --list
</code></pre>
</div><p data-line="41" class="code-line">上記コマンドで示されたリストから、バージョンを指定してインストールします。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="42">pyenv install 3.9.13
pyenv install 3.11.1
</code></pre>
</div><p data-line="47" class="code-line">WindowsはMacと違い、初期状態ではPythonがインストールされていないので、pyenvでPython導入時に<code>python</code>コマンドを実行した際に動作するグローバルなPythonバージョンを予め設定しておく必要があります。<br>
上記コマンドでインストールしたPythonで、好きなバージョンをglobal指定しておくとよいでしょう。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="49">pyenv global 3.9.13
</code></pre>
</div><p data-line="53" class="code-line">また、インストールされているバージョンを削除したい場合は<code>uninstall</code>コマンドが使えます。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="54">pyenv uninstall 3.11.1
</code></pre>
</div><h2 id="visual-studio-code%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" data-line="58" class="code-line">
<a class="header-anchor-link" href="#visual-studio-code%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" aria-hidden="true"></a> Visual Studio Codeをインストール</h2>
<p data-line="59" class="code-line">Visual Studio Codeをインストールします。<br style="display:none">
<span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__1bc9a839e365d" src="https://embed.zenn.studio/card#zenn-embedded__1bc9a839e365d" data-content="https%3A%2F%2Fcode.visualstudio.com%2F%23alt-downloads" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://code.visualstudio.com/#alt-downloads" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://code.visualstudio.com/#alt-downloads</a></p>
<h2 id="visual-studio-code%E3%81%A7python%E6%8B%A1%E5%BC%B5%E6%A9%9F%E8%83%BD%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" data-line="62" class="code-line">
<a class="header-anchor-link" href="#visual-studio-code%E3%81%A7python%E6%8B%A1%E5%BC%B5%E6%A9%9F%E8%83%BD%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" aria-hidden="true"></a> Visual Studio CodeでPython拡張機能をインストール</h2>
<p data-line="63" class="code-line">Visual Studio CodeでPythonの開発を行うには、以下の拡張機能をVisual Studio Codeに導入する必要があります。<br style="display:none">
<span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__4601404fce6eb" src="https://embed.zenn.studio/card#zenn-embedded__4601404fce6eb" data-content="https%3A%2F%2Fmarketplace.visualstudio.com%2Fitems%3FitemName%3Dms-python.python" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://marketplace.visualstudio.com/items?itemName=ms-python.python" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://marketplace.visualstudio.com/items?itemName=ms-python.python</a><br style="display:none">
VSCode内の拡張機能検索機能を使うか、上記リンクの<code>Install</code>ボタンからインストールを行います。</p>
<h1 id="%E4%BB%AE%E6%83%B3%E7%92%B0%E5%A2%83%E3%81%AE%E4%BD%9C%E6%88%90" data-line="67" class="code-line">
<a class="header-anchor-link" href="#%E4%BB%AE%E6%83%B3%E7%92%B0%E5%A2%83%E3%81%AE%E4%BD%9C%E6%88%90" aria-hidden="true"></a> 仮想環境の作成</h1>
<h2 id="%E4%BD%9C%E6%A5%AD%E3%83%87%E3%82%A3%E3%83%AC%E3%82%AF%E3%83%88%E3%83%AA%E3%81%B8%E7%A7%BB%E5%8B%95" data-line="68" class="code-line">
<a class="header-anchor-link" href="#%E4%BD%9C%E6%A5%AD%E3%83%87%E3%82%A3%E3%83%AC%E3%82%AF%E3%83%88%E3%83%AA%E3%81%B8%E7%A7%BB%E5%8B%95" aria-hidden="true"></a> 作業ディレクトリへ移動</h2>
<p data-line="69" class="code-line">.pyファイルが格納されている作業ディレクトリをWindows PowerShellで開いて下さい。<br>
Visual Studio Codeで扱う際に、何かしら.pyファイルが存在する必要があるため、新規でプロジェクトを作成する場合は、空のファイルで良いので.pyファイルを作成しておきましょう。</p>
<h2 id="pyenv%E3%81%A7python%E3%81%AE%E3%83%90%E3%83%BC%E3%82%B8%E3%83%A7%E3%83%B3%E6%8C%87%E5%AE%9A" data-line="72" class="code-line">
<a class="header-anchor-link" href="#pyenv%E3%81%A7python%E3%81%AE%E3%83%90%E3%83%BC%E3%82%B8%E3%83%A7%E3%83%B3%E6%8C%87%E5%AE%9A" aria-hidden="true"></a> pyenvでPythonのバージョン指定</h2>
<p data-line="73" class="code-line">pyenvでインストール済みのPythonのバージョン一覧を取得します</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="74">pyenv versions
</code></pre>
</div><p data-line="78" class="code-line">インストール済みのバージョンが確認できたら、その中からpyenvを使って当該プロジェクトで使用するPythonバージョンを指定します。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="79">pyenv local 3.9.13
</code></pre>
</div><p data-line="83" class="code-line">すると、<code>.python-version</code>というファイルが作成され、このディレクトリで<code>python</code>コマンドを実行した場合、今回指定したバージョンのPythonでコマンドが実行されます。</p>
<h2 id="venv%E3%81%A7%E4%BB%AE%E6%83%B3%E7%92%B0%E5%A2%83%E3%82%92%E4%BD%9C%E6%88%90" data-line="85" class="code-line">
<a class="header-anchor-link" href="#venv%E3%81%A7%E4%BB%AE%E6%83%B3%E7%92%B0%E5%A2%83%E3%82%92%E4%BD%9C%E6%88%90" aria-hidden="true"></a> venvで仮想環境を作成</h2>
<p data-line="86" class="code-line">念のため--versionで、<code>pyenv local</code>で指定したPythonのバージョンが反映されているか確認しておきます。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="87">python --version
</code></pre>
</div><p data-line="91" class="code-line">大丈夫そうであれば、venvで仮想環境を作成します。<br>
今回は慣例に従い仮想環境の名前は<code>.venv</code>としますが、任意の名前で作成することが可能です。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="93">python -m venv .venv
</code></pre>
</div><p data-line="97" class="code-line">これで、作業ディレクトリの<code>.venv</code>というディレクトリ以下に仮想環境が作成されました。</p>
<h2 id="%E4%BB%AE%E6%83%B3%E7%92%B0%E5%A2%83%E3%81%AB%E3%83%91%E3%83%83%E3%82%B1%E3%83%BC%E3%82%B8%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" data-line="99" class="code-line">
<a class="header-anchor-link" href="#%E4%BB%AE%E6%83%B3%E7%92%B0%E5%A2%83%E3%81%AB%E3%83%91%E3%83%83%E3%82%B1%E3%83%BC%E3%82%B8%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" aria-hidden="true"></a> 仮想環境にパッケージをインストール</h2>
<p data-line="100" class="code-line">作成した<code>.venv</code>にpipでパッケージをインストールします。</p>
<p data-line="102" class="code-line">まずは、venvで作成した仮想環境を起動します。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="103">.venv/Scripts/activate.ps1
</code></pre>
</div><p data-line="106" class="code-line">このとき、CommandPromptを使用している場合は、<code>.ps1</code>ではなく、<code>.bat</code>で実行します。</p>
<p data-line="108" class="code-line">仮想環境が起動したら、その後実行する<code>python</code>コマンドの影響範囲は、仮想環境内のみに限定されます。</p>
<p data-line="110" class="code-line">仮想環境のpipをアップデートします。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="111">python -m pip install --upgrade pip
</code></pre>
</div><p data-line="115" class="code-line">次に、パッケージをインストールします。<br>
今回の例では、scikit-learnをインストールしてみます。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="117">pip install scikit-learn
</code></pre>
</div><p data-line="121" class="code-line">一通りパッケージのインストールが完了したら、<code>deactivate</code>コマンドで仮想環境を閉じます。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">Windows PowerShell</span></div>
<pre class="language-ps"><code class="language-ps code-line" data-line="122">deactivate
</code></pre>
</div><h2 id="visual-studio-code%E3%81%A7%E9%96%8B%E3%81%8F" data-line="126" class="code-line">
<a class="header-anchor-link" href="#visual-studio-code%E3%81%A7%E9%96%8B%E3%81%8F" aria-hidden="true"></a> Visual Studio Codeで開く</h2>
<p data-line="127" class="code-line">作業ディレクトリを、Visual Studio Codeへドラッグ&amp;ドロップするなどして開きます。<br>
エクスプローラービューに作業ディレクトリ以下のファイル一覧が表示されるので、適当な.pyファイルをクリックします。</p>
<p data-line="130" class="code-line">VSCode下部のステータスバーの表示がPython専用のものに置き換わるので、ここに<code>'.venv': venv</code>と書かれたインタープリターが表示されていることを確認します。<br>
<img src="https://storage.googleapis.com/zenn-user-upload/369340730b17-20230131.png" class="md-img" loading="lazy"></p>
<p data-line="133" class="code-line">もし、先ほどvenvで作成した環境ではないものが表示されている場合、インタープリター名の文字をクリックすると、インタープリターの選択画面が開きます。<br>
<img src="https://storage.googleapis.com/zenn-user-upload/22b7e721adbd-20230131.png" class="md-img" loading="lazy"></p>
<p data-line="136" class="code-line">ここで<code>'.venv': venv</code>と書かれたインタープリターを選択すれば、ステータスバーの表示が切り替わり、venvで作成した仮想環境でVisual Studio Codeを用いた開発が可能になります。</p>


WindowsでVSCode+pyenv+venv+pipを使い、Pythonの開発環境を構築する

pyenvでpythonをバージョン指定してインストール

Visual Studio CodeでPython拡張機能をインストール

仮想環境にパッケージをインストール

Discussion