uv の概要

uv とは？

uv は、Python 用の高速なパッケージおよびプロジェクト管理ツールです。

従来の Python 環境の構築では、pip、venv など複数のツールを組み合わせて使用することが一般的でした。uv は、これらの機能を統合して、パッケージ管理、仮想環境管理、依存性管理などを 1 つのツールで扱えるようにしたものであり、pip の代替として非常に注目されているツールです。

また、uv は、プログラミング言語の Rust で実装されていることも特徴です。Rust の高速な処理能力を活かすことで、依存関係の解決やパッケージインストールを効率的に行うことができます。

この記事では、uv のインストール方法や使い方、pip との違いなどについて紹介していきます。

pip との比較

主な違い

pip は、Python の標準パッケージインストーラであり、PyPI (Python Package Index) からパッケージをインストールするためのツールです。一方、uv は、パッケージ管理だけでなく、仮想環境管理や依存関係の lock 管理なども統合して提供します。

速度の違い

uv は、Rust で開発されており、並列ダウンロードや効率的な I/O 処理により非常に高速に処理ができます。以下は、uv の公式サイトで紹介されている指標です。

このベンチマークでは、Python の非同期ライブラリ Trio の依存パッケージをインストールする際の速度が比較されています。Trio は、async / await を利用した非同期処理を扱う Python ライブラリで、このライブラリの依存関係をインストールする処理を各ツールで比較しています。

また、この測定は、warm cache (依存関係が既にキャッシュされている状態) で行われています。結果を見ると、poetry や pdm などの他ツールに比べて uv は非常に高速に処理できることが分かります。

uv のインストール方法

uv のインストール方法

uv のインストール方法を紹介します。手順は、公式のこちらを参照しています。

Windows でのインストール

Windows では、PowerShell を利用して以下のコマンドを実行します。

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

実際のインストールは「"irm https://astral.sh/uv/install.ps1 | iex"」の部分で実行されています。irm は、指定URLからデータを取得する PowerShell のコマンドで、インストールスクリプトをダウンロードし、iex に渡して実行しています。

「powershell -ExecutionPolicy ByPass」は、この起動した PowerShell プロセスだけ実行ポリシーを無視してスクリプトを実行するための指定です。

インストールが完了すると「uv.exe」などの実行ファイルがインストールされます。PATH も自動的に設定されるため、PowerShell を再起動すると uv コマンドが使用できるようになります。

Linux/ macOS

Linux や macOS では、以下のコマンドを実行します。

curl -LsSf https://astral.sh/uv/install.sh | sh

uv によるプロジェクトの作成と管理

uv によるプロジェクトの作成

uv では、「uv init」コマンドを使用して新しいプロジェクトを作成できます。以下は、my-project というプロジェクトを作成する例です。

uv init my-project

このコマンドを実行すると、my-project というフォルダに以下のようなファイルが自動で生成されます。

my-project
├ .gitignore
├ .python-version
├ main.py
├ pyproject.toml
└ README.md

簡単に各ファイルの説明をしておきます。

pyproject.toml

Python プロジェクトの設定ファイルです。プロジェクト情報を管理するために使用され、近年の Python プロジェクトでは、pyproject.toml が標準的な設定ファイルとして利用されています。

main.py

エントリーポイントとして利用できるサンプルの Python ファイルです。

README.md

プロジェクトの概要や使い方などを記述するためのファイルです。

.gitignore

Git の管理から除外するファイルを指定する設定ファイルです。Python プロジェクトでは、仮想環境、キャッシュファイル、一時生成ファイルなどは Git 管理対象外として除外することが一般的です。

.python-version

使用する Python バージョンを指定するファイルです。プロジェクト単位で使用する Python バージョンを明示できます。仮想環境作成時に uv は、このファイルを参照しており、開発環境ごとの Python バージョン差異を防ぐことができるようになります。

パッケージの管理方法

パッケージ管理は、uv コマンドを使用して実行します。作成したプロジェクトの配下で以下で紹介するようなコマンドを使用します。

パッケージの追加

パッケージの追加は「uv add」コマンドで行います。以下は、NumPy の追加例です。

uv add numpy

複数のパッケージをまとめてインストールする場合は、スペースでパッケージを列挙すればまとめてインストールできます。

仮想環境や lock ファイルがない場合は生成され、lock ファイルには、依存パッケージの具体的なバージョン情報が記録され、プロジェクトの依存関係を再現できます。

パッケージの削除

パッケージを削除する場合は「uv remove」コマンドを次のようにします。

uv remove numpy

uv add や uv remove で操作されたパッケージの依存関係は自動的に解決され、uv.lock が更新されます。

依存関係の表示（uv tree）

インストールしたパッケージの依存関係ツリーを表示したい場合には「uv tree」コマンドを使用します。

uv tree

例えば、NumPy、pandas、scikit-learn をインストールした状態だと以下のような依存性のツリーを確認できます。

my-project v0.1.0
├── numpy v2.4.2
├── pandas v3.0.1
│   ├── numpy v2.4.2
│   ├── python-dateutil v2.9.0.post0
│   │   └── six v1.17.0
│   └── tzdata v2025.3
└── scikit-learn v1.8.0
    ├── joblib v1.5.3
    ├── numpy v2.4.2
    ├── scipy v1.17.1
    │   └── numpy v2.4.2
    └── threadpoolctl v3.6.0

uv run によるプログラム実行

uv では、「uv run」コマンドを使用して以下のようにプログラムを実行できます。

uv run main.py

通常 Python 開発環境を利用する場合には、以下のような手順を踏む必要があります。

1. 仮想環境（venv）を作成
2. 仮想環境を activate
3. Python プログラムを実行

一方で、uv run を用いると、仮想環境が自動的に管理されるため、activate を意識せずにプログラムの実行ができます。

仮想環境（.venv）や uv.lock の生成タイミング

uv init でプロジェクトを生成したタイミングでは、仮想環境（.venv）や uv.lock ファイルは、生成されません。

これらは上記で紹介したような「uv run」「uv add」などのプロジェクトコマンドが最初に実行されたタイミングで生成されます。

仮想環境の自動管理

uv では、仮想環境が自動的に管理されるため、明示的な venv の作成や activate を意識する必要がありません。プロジェクト単位で Python 環境が管理されるため、複数のプロジェクトを扱う場合でも環境の衝突を防ぐことができます。また、プロジェクトごとに Python のバージョン指定をすることも可能です。

uv 使用に関する注意点

uv は、新しい Python プロジェクトでは非常に有力な選択肢となります。一方で、pip を中心としたプロジェクト管理と比較すると歴史はまだ浅いです。

既存の大規模プロジェクトへ導入する場合は、CI / CD 環境との整合性やチーム運用方針を確認しながら、段階的に導入を検討すると良いでしょう。新規のプロジェクトでは、ぜひ uv の採用を検討してみてください。

まとめ

Python で近年注目されている uv というパッケージおよびプロジェクト管理ツールについて解説しました。

uv は、Rust 製の高速な Python パッケージ・プロジェクト管理ツールです。pip での環境構築では複数ツールを組み合わせて行っていた「パッケージ管理」「仮想環境管理」「依存関係管理」を統合的に提供します。

uv は、pip に比べると歴史が浅いため、大規模プロジェクトでの採用には、段階的導入を検討するなど注意が必要ですが、新規プロジェクトでは、シンプルで再現性の高い開発環境を構築できるツールとして有力な選択肢となるでしょう。

あわせて読みたい

【Python Tech】プログラミングガイド

Ruff とは

Ruff（ラフ）は、Python 向けの高速なリンター兼フォーマッターです。プログラム言語としては、Rust で実装されており、従来の flake8、black、isort が担っていた役割を 1 つのツールで担える点が特徴です。

Ruff は、CLI ツールとして利用できるため Visual Studio Code (VS Code) に限らず、その他の統合開発環境（IDE）でも使用できます。

この記事では、Python の開発環境として非常によく利用されている VS Code での利用方法に焦点をあてて解説します。

Ruff でできること

Ruff では、主に以下の機能を提供します。

• フォーマット（コード整形）
• 静的解析（Lint）
• import の整理

コマンドとしては以下のように使用できます。

ruff format .

ruff check . --fix

Ruff は、コード整形でよく使われる black 互換のフォーマット機能、flake8 の静的解析（Lint）、isort 相当の import 整理機能を 1 つのツールで扱うことができます。

Ruff の特徴

Ruff の主な特徴を整理しておきます。

高速性

Ruff は、プログラム言語の Rust で実装がされており、大規模プロジェクトでも非常に高速に動作します。

Rust は、C/C++に匹敵する高性能を持ちながら、メモリ安全性が高く、Pythonなどのモダンな言語に見られる表現のしやすさも備えている、非常に優れた言語です。従来の Python 製リンターと比較しても非常に高速です。

多機能な静的解析（Lint）

flake8 のルールに加えて、多数のルールを内包しており、pyproject.toml によりルールを細かく制御することができます。

設定の一元管理

設定は、pyproject.toml にまとめて記述することができます。これにより、フォーマットと Lint の設定を同一ファイルで管理できます。

Ruff の歴史と位置づけ

Ruff は、2022 年頃に登場して急速に注目を集めてきました。高速性と利便性から、多くのプロジェクトでの採用が進んでいます。

近年では、Rust 製のツールが Python エコシステムを補完する動きが多くみられます（uv や Polars など）。その流れの中で、Ruffも実用的で高速な開発基盤ツールとして位置づけられています。新規プロジェクトでは black や isort の代替として、Ruff を採用するケースも増えています。

VSCode で Ruff を設定して使用する方法

ここからは、VS Code で Ruff を実際に利用する方法を解説します。なお、Ruff は CLI ツールであるため、以下の両方が必要です。

• プロジェクトに Ruff をインストールする
• VS Code の Ruff 拡張をインストールする

それぞれをインストールした上での基本的な設定方法などを紹介していきます。

Ruff のインストール

Ruff をインストールする場合は、以下のようにインストールします。

pip install ruff

また、uv を使用している場合は、以下でインストールします。

uv add ruff

ここで、インストールされるのは Ruff 本体の CLI ツールです。

Ruff の VSCode 拡張のインストール

次に、VS Code 拡張機能から Ruff をインストールします。VS Code の拡張機能で「Ruff」と検索すると、Astral Software の Ruff 拡張が検索できますのでインストールします。

Ruff 本体は、CLI ツールであり、この VS Code 拡張は、エディタ連携のための拡張機能という位置づけとなっています。

Ruff に関する VS Code の基本的な設定（setting.json）

Ruff を使用するにあたっての VS Code 側の基本的な設定を紹介します。

VS Code の「Ctrl + Shift + P」でコマンドパレットを開き、「Preferences: Open Settings (JSON)」から setting.json を開きます。

VS Code の設定は大きく次の 3 種類があります。

• 既定値（Default）：VS Code 本体や拡張機能が持つ初期設定
• ユーザー設定（User）：ユーザー個人に適用される設定
• ワークスペース設定（Workspace）：プロジェクト単位に適用される設定

プロジェクト単位で Ruff 有効にしたい場合は、ワークスペース設定（.vscode/settings.json）に記述するのがおすすめです。チーム開発では、この方法により設定を共有できます。

一方、自身が扱うすべてのプロジェクトで Ruff を有効にしたい場合は「ユーザー設定（User）」に記述しても問題ありません。

settings.json に以下の記載を追加してください。

{
  "[python]": {
    "editor.defaultFormatter": "charliermarsh.ruff",
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
      "source.fixAll.ruff": "explicit",
      "source.organizeImports.ruff": "explicit"
    }
  }
}

各項目の補足説明は以下の通りです。

Ruff の詳細設定（pyproject.toml）

Ruff の詳細設定は pyproject.toml に記述します。

Ruff は、デフォルトでも実用的な設定が有効になっているため、基本的には、pyproject.toml に追加の設定を記述しなくても利用できます。

ただし、プロジェクト方針やコーディング規約に応じて、設定を明示的に変更することも可能です。ここでは、代表的な設定の一部を紹介します。

基本設定 [tool.ruff]

Ruff の基本的な挙動は [tool.ruff] セクションで設定します。

例えば、代表的な設定として、1 行当たりの最大文字数は以下のように設定します。

[tool.ruff]
line-length = 88

Ruff のデフォルトは、black 互換の設定の 88 文字であるため、基本的に上記のような記載は必要ありません。

一方で、PEP8 準拠の 79 文字にしたい場合には、次のように指定します。

[tool.ruff]
line-length = 79

プロジェクトのコーディング規約にあわせて調整してください。

Lint 設定 [tool.ruff.lint]

ルール群の指定方法（select）

Ruff には、複数のリントルールがあります。こちらも基本的にはデフォルト設定で問題ありませんが、以下のように [tool.ruff.lint] セクションで制御できます。

[tool.ruff.lint]
select = ["E", "F", "I"]

select では、ルール群を表す文字列を指定します。なお、Ruff の記事執筆時点でのデフォルト設定は、["E4", "E7", "E9", "F"] です。これは、実行時エラーにつながる可能性が高い問題や、明確なコーディングエラーを中心に検出するルール群が有効になっていることを意味します。

リントのルール一覧は、公式ページの Rules ページにまとめられています。このページの「Code」列に書かれている値が各ルールを示すコードです。

例えば、"E" は、pycodestyle 由来のルール群を示します。また、"E4" は "E4"から始まるルールコードをまとめて指定する指定方法で、Rules ページを確認すると、"E4" には以下のルールが含まれることになります。

なお、"E" を指定すれば、"E" から始まる pycodestyle 由来のリントルール群がすべて有効になります。

ルールの除外（ignore）

まとめて指定した際に、特定ルールのみを除外したい場合は、ignore を使用します。

[tool.ruff.lint]
select = ["E", "F", "I"]
ignore = ["E501"]

上記では、"E" から始まるルール群をすべて有効にしつつ、"E501"（行長の違反） のみを除外しています。

Ruff は、デフォルト設定でも十分実用的です。まずは、デフォルトのまま導入し、必要に応じて、pyproject.toml を用いて柔軟に調整していくのがおすすめです。プロジェクトの方針に応じて検討してください。

まとめ

Python の高速なリンター兼フォーマッターである Ruff の概要と VSCode での設定方法を解説しました。

Ruff を導入することで、コード整形や静的解析（Lint）、import 整理といった機能を 1 つのツールで扱うことができるようになります。Ruff は、Rust で実装がされており非常に高速であることが特徴です。

VS Code と組み合わせることで、保存時に自動フォーマットや Lint 修正が実行され、より快適な Python 開発環境を構築できます。

Ruff 自体の設定方法についても一部紹介しましたが、Ruff はデフォルト設定でも十分実用的であり、まずは最小構成で導入し、必要に応じて pyproject.toml で調整していくのがおすすめです。

ぜひプロジェクトに導入してみてください。

あわせて読みたい

【Python Tech】プログラミングガイド

Databricks とは

Databricks は、ビックデータ分析や機械学習に特化したソフトウェアの企業です。Databricks は、Apache Spark の開発者を中心として立ち上げられ、レイクハウスという概念を提唱して広げていった先駆者として有名です。なお、提供されているデータ基盤のサービス名も Databricks と言います。

Databricks は、データの蓄積・加工から機械学習までの一連のデータ活用を強力にサポートしてくれるサービスです。Databricksは今後のデータ活用の中心的なサービスの一つになると私は考えています。

Databricks では、AWS や Azure などのクラウド環境上で用意するのが一般的ですが、学習等で試してみたいといった場合、クラウド環境の準備は費用的にも負担がかかります。このような時には、Databricks Community Edition で使用してみることがおすすめです。

Databricks Community Edition は、機能が限定されますが、期限なく無償で利用することができます。この記事では、Databricks Community Edition を使用する方法について説明します。

Databricks Community Edition の始め方

Databricks Community Edition は、独自のクラウドアカウントやコンピューティングリソース、ストレージを用意する必要なくDatabricksを試すことができます。

ただし、Databricks Platform Free Trial で利用できるいくつかの機能（REST APIなど）は、Databricks Community Edition では利用できません。

Databricksのアカウント作成とサインアップ

Databricks Community Edition にサインアップするには以下の手順で実施します。
※以降の画面は、記事執筆当時のもので変更されている可能性があります。

Databricks 無料トライアルにアクセスし、氏名やメールアドレスといった情報を入力して「続行」をクリックします。

個人で利用の欄の「Community Editionのトライアルを開始」をクリックします。

登録したメールアドレスにアドレス確認のメールが届きます。メールアドレスを認証するリンクがありますので、リンクをクリックしてください。

以下のようにパスワードの設定画面が出ますのでパスワードを設定します。

Databricks 画面にログインしますが、右上に日本語設定の画面が出ますので、日本語で使いたい人は「日本語を使う」ボタンを押してもらうと日本語画面で使用できます。

以下のような画面にログインができれば、Databricks を利用する環境が整います。

再度ログインする場合は「Community Editionログインページ」からログインするようにしてください。

Databricks の使用方法

Notebook を使ってプログラムを実行する簡単な例で Databricks を使う手順を紹介します。Databricks は大きく以下のような手順で使用します。

1. クラスターの作成と起動：プログラムを実行する環境を作成して起動します。
2. Notebook の作成：プログラムを作成します。
3. Notebook の実行：プログラムを実行します。

ここで、クラスターとは機能を実行する処理環境であると思ってください。作成した Notebook は作成したクラスター上で実行されます。また、Notebook はプログラムを記載するファイルのことです。

Jupyter Notebook を使用したことがある人は同じようなものであると思ってもらえればよいですが、相互に完全な互換性があるわけではありません。

クラスターの作成と起動

画面左の「クラスター」をクリックします。最初の時点では実行のためのコンピュート用クラスターがないため「コンピューティングを作成」をクリックして作成します。

クラスター作成画面で項目を入力・選択して「コンピューティングを作成」をクリックします。クラスターの作成・起動までには数分程度かかる場合があります。

• コンピュート名：作成するクラスターの名前を設定します。
• Databricks Runtime のバージョン：Runtime 環境のバージョンをプルダウンから選択します。
• インスタンス：インスタンスは無料の 15 GBメモリで 1 ~ 2 時間のアイドル状態で自動終了します。

クラスターの画面が表示され、実行中のマークがついていれば作成と起動が完了です。

Notebook の作成

次にプログラムを実際に作って動かしてみましょう。

Databricks に登録するとワークスペースの Users の下に登録メールアドレスのユーザーが作られています。当該ワークスペースを使うことでプログラミングやファイルの作成を行っていくことができます。

作成ボタンから「ノートブック」を選択すると Notebook 画面が表示されます。

Notebook画面左上でファイル名を変更でき、画面右側でクラスターを指定できます。

Notebook のデフォルト言語は「Python」になっていますが、SQL やScala、R といった言語を指定することもできます。

なお、Databricks ではセルごとに実行言語を指定できるミックス言語に対応しています。セルの冒頭でマジックコマンド %<language> を指定します。具体的には「%python」「%r」「%scala」「%sql」です。これにより、Python がデフォルトのノートブックの途中で SQL を発行するといったことも簡単にできます。

また、「%md」とすることで Markdown のテキストを記載できるので、プログラムの内容を記載しておくことも可能です。

サンプルプログラムを作成してみる

実際に簡単なプログラムを作成してみましょう。PySpark のデータフレームを作成して、テーブルに保存、読みだして表示という一連の流れを作成してみましょう。

データを生成する

以下のようなプログラムを、Databricks のセルに入力して、セルのボタンを押すか「Shift + Enter」で実行します。

from pyspark.sql.types import StructType, StructField, StringType, IntegerType

# スキーマ定義
schema = StructType(
    [
        StructField("name", StringType(), True),
        StructField("age", IntegerType(), True),
    ]
)

# データを作成
data = [("Taro", 25), ("Hanako", 30), ("Yuki", 20)]

# スキーマを指定してデータフレームを作成
df = spark.createDataFrame(data, schema=schema)

# DataFrameの内容表示
# df.show()
display(df)

実際には以下のようにとなります。

データ表示は、DataFrame の show メソッドで表示してもいいのですが、Databricksでは display という高機能なデータ表示機能が使用できます。

各列の値でソートができたり、＋ボタンで「可視化」や「データプロファイル」をクリックすることでデータフレームの内部の情報を集計した内容を確認したりできます。

「可視化」では、データに対してバーやヒストグラムといった基本的な可視化をすることが可能です。

データプロファイルでは、以下のように各列のプロファイル情報を表示できます。平均などの統計値や、データ欠損がどれだけあるかなどデータに対する情報を簡単に取り出せるため、その後のデータ加工に非常に役立ちます。

データを書き込む

次にデータを Delta Lake のテーブルに書き込んでみましょう。以下のような内容をセルに打ち込んで実行してください。

# データの書き込み
df.write.format("delta").mode("overwrite").saveAsTable("test_table")

上記実行により DataFrame の内容は「test_table」というテーブル名で保存されます。このデータは Delta Lake 形式で保存されます。Delta Lake については「Delta Lakeの使い方の基本」も参考にしてください。

登録したテーブルは、データの「カタログ」として使用することができます。Community Edition では、Hive を利用した hive_metastore.default というカタログに登録されます。画面左のカタログから default をクリックすると作成したテーブルが見つけられます。

作成した test_table をクリックすると、テーブル情報を確認できます。

有償の Databricks では、Unity Catalog という高機能なカタログが使用できますが、Community Edition では使用できません。Unity Catalog では、スキーマ、テーブルを階層的に管理でき、メタデータに対して一貫したセキュリティポリシーやアクセス制御ができるなど、より強力にデータガバナンスの実現ができます。

データを読み込む

カタログに登録したテーブルのデータを読み込むには以下のようなコードで簡単に読み込みが実行できます。

# データの読み込み
df_read = spark.read.format("delta").table("test_table")

display(df_read)

具体的な実行結果では以下のようになります。

まとめ

Databricks Community Edition を使用する方法について解説しました。

Databricks は、データ活用のための非常に高機能なデータ基盤サービスです。一般的には、AWS やAzure などのクラウド環境上で用意しますが、学習用などに使ってみたい場合には、Databricks Community Edition を使用するのがおすすめです。

この記事では、Community Edition の準備をして、クラスター作成・Notebook の実行までの一連の流れについて紹介をしました。

Databricks は、今後のデータ活用の中心的なサービスの一つになると私は思います。Community Edition を使って、どのようなサービスか無料で試してもらえると良いかと思います。また、有償版では Unity Catalog など Community Edition では使用できない優れたサービスもありますので、是非企業での活用も検討してみてください。

あわせて読みたい

【Python Tech】プログラミングガイド

Docker

Docker は、アプリケーションを軽量なコンテナとしてパッケージ化し、実行するための仮想環境です。これにより開発環境や本番環境など異なる環境間での一貫した動作が可能となります。

この記事では、Docker Desktopを使わずにWSL2上のLinuxでDockerを使用する方法について紹介したいと思います。

Docker Desktop

Docker Desktop は、簡単にインストールできるアプリケーションです。Docker Desktop は、従業員数が 250 人以上 または 年間収益が 1,000 万ドルを超える組織では、有料サブスクリプションが必要です。

ただし、以下のような条件に当てはまる場合は、無料で使用することができます。

• 従業員数が 250 人未満 かつ 年間収益が 1,000 万ドル未満の組織
• 個人のプロジェクトでの利用
• 教育目的での利用（学生や教育者によるもの）
• 非商用のオープンソースプロジェクトでの利用

上記条件に当てはまらない企業の場合で無償で Docker を使用したい場合には、Docker Desktop を使わない方法を検討する必要があります。

Docker を無償で使用する方法

Docker Desktop は上記の通り企業規模により有料サブスクリプションが必要になります。しかし、有料であるのは Docker Desktop であり、そのエンジンである Docker Engine 自体は無償で使用することができます。

つまり、Linux 環境や WSL2（Windows Subsystem for Linux 2）上で Docker Engine をインストールして使用する分には問題ありません。

以降では、Windows 11 環境を前提として、WSL2 上の Ubuntu で Docker を動作させて使用する方法を紹介していきます。

Docker Desktop を使わずに WSL2 上で
Docker を使用する

WSL2 で Ubuntu をインストールする

WSL2（Windows Subsystem for Linux 2）は、Windows 上で Linux 環境を動作させることができる環境です。

コマンドプロンプトで、以下コマンドを実行することにより、WSL のインストールと Ubuntu のインストールを同時に実行することが可能です。

wsl --install -d Ubuntu

上記でインストールを完了すると Windows の検索で「ubuntu」が見つかるようになり、実行すると Ubuntu のターミナルが表示され、Ubuntu 環境を使用できるようになります。

以下のコマンドで Ubuntu のバージョンを確認できます。今回の例では、Ubunt24.04.1 LTS となっています。

lsb_release -a

No LSB modules are available.
Distributor ID: Ubuntu
Description:    Ubuntu 24.04.1 LTS
Release:        24.04
Codename:       noble

wsl --update

wsl -l -v

wsl --set-version <ディストリビューション名> 2

wsl --set-default-version 2

Ubuntu 上に Docker をインストールする

Ubuntu のターミナルで以下を実行することで Docker 環境をインストールします。

Ubuntuパッケージの更新

Ubuntu 自体のパッケージを更新しておきます。

sudo apt update

Docker Engine のインストール

Docker のインストールスクリプトを実行します。インストールスクリプトに関する説明は Docker の公式ドキュメントのこちらを参考にしています。

curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

スクリプトにスリープが入っていますので、しばらく待ってもらえると実行が進んでいきます。完了したら Docker のインストールが完了です。

以下のコマンドで、Docker のサービスが実行されているかを確認してください。

sudo systemctl status docker

実行状態が、active(running) になっていれば Docker は起動しています。起動していないようであれば以下コマンドで実行してください。

sudo systemctl start docker

PySpark 環境を使ってみる

上記で WSL2 上の Ubuntu 環境に用意した Docker で PySpark の Docker 環境を使用してみましょう。

PySpark は、Apache Spark という分散データ処理フレームワークを Python で利用できるようにする API です。Spark は分散環境なのでローカル環境の用意は大変ですし、クラウド環境では課金が生じます。このような時にローカルで PySpark 環境が準備できると非常に便利です。

PySpark の Docker 環境を使う方法については「PySparkの実行環境をDockerで用意する方法」に詳細に説明をしています。この記事は Docker Desktop を前提にしていますが、今回作成した環境でも同様に実行できることを確認します。

Docker イメージの取得と実行

作成した ubuntu 環境のターミナルで以下コマンドで実行し、Docker Hub からPySpark を使用できる Jupyter Notebook 環境のイメージを取得します。

docker pull jupyter/pyspark-notebook

コンテナの作成と実行

以下のコマンドを実行することで PySpark の環境を起動することができます。

docker run --rm -it -p 8888:8888 -p 4040:4040 -v /mnt/d/docker1/pyspark_notebook_1:/home/jovyan/work jupyter/pyspark-notebook

コンテナが起動するとターミナルの表示の中に「http://127.0.0.1:8888/lab?token=xxxxxxxxxx」というような記載の文字列が表示されるかと思います。この URL をブラウザに入力することで Jupyter Lab を実行することができます。

なお、WSL2 上の Ubuntu では /mnt/c/ や /mnt/d/ に C や D ドライブがマウントされます。上記実行時には /mnt/d/docker1/pyspark_notebook_1 と指定しましたので、Jupyter Lab の work フォルダに作成されたファイルは D:\docker1\pyspark_notebook_1 フォルダ内に保存されます。

wsl.conf の修正（NTFSファイルシステムとの権限に関する問題）

上記環境構築をした際に PySpark のプログラムを動かすとファイルの書き込みに関するコードが失敗する事象が発生しました。NTFS ファイルシステムにおけるファイルの書き込み権限が原因でファイル操作が失敗したようです。

上記のような問題は ubuntu 環境の /etc/wsl.conf ファイルに以下の記載を追記すると改善します。

[automount]
options="metadata"

automount セクションは WSL が Windows のファイルシステムを自動的にマウントする際のオプションを設定するためのものです。通常 WSL2 は /mnt/c や /mnt/d のようにドライブごとに自動マウントします。

metadata オプションは、Windows ファイルシステム上のファイルに対して Linux のメタデータ（所有者、権限情報など）を保存できるようにするもので、Linux の権限モデル（chmod や chown など）を Windows ファイルシステムで扱えるようにします。

上記変更をした際には、以下で WSL を一度シャットダウンし、再度 ubuntu 環境を立ち上げ直してください。

wsl --shutdown

まとめ

Docker Desktop を使わずに WSL2 上の Linux で Docker を使用する方法を解説しました。

Docker Desktop は一定規模以上の企業では有料サブスクリプションが必要となるため、Docker Desktop を使用しないで実行できる環境があると非常に便利です。Windows 環境上の場合は、WSL2 上に Ubuntu を構築して Docker Engine をインストールすることで実現ができます。

この記事では一連の環境準備の方法について紹介しました。Docker 環境構築の参考にしていただければと思います。

あわせて読みたい

【Python Tech】プログラミングガイド

CUDA と cuDNN

CUDA (Compute Unified Device Architecture) とは、米 NVIDIA 社が自社グラフィックスプロセッサ (GPU) 向けに開発提供する並列計算のソフトウェア開発・実行環境で CUDA Toolkit をインストールすることで使用できます。また、cuDNN (CUDA Deep Neural Network liberary) は、CUDA Toolkit 上で動作するディープラーニングライブラリです。

TensorFlow や PyTorch といったディープラーニングライブラリを用いたプログラミングを行いたいときに NVIDIA の GPU を使う場合には、CUDA Toolkit と cuDNN をインストールする必要があります。

この記事では、CUDA Toolkit と cuDNN のインストール方法について紹介します。

CUDA Toolkitのインストール

CUDA Toolkit のインストール方法を紹介します。CUDA Toolkit はどのバージョンをインストールするか NVIDIA のドライバなどをもとに決める必要があるので、バージョンの確認方法を含めて説明します。

バージョンの確認

CUDA Toolkit をインストールする場合には、使用している PC の NVIDIA GPU によってインストールする CUDA Toolkit のバージョンを選ぶ必要があります。具体的には、NVIDIA Driver と CUDA Toolkit のバージョンの対応があうものを選びます。

CUDA リリースノートの CUDA Toolkit and Corresponding Driver Versions にCUDA Toolkit と Driver のバージョンに関する対応表があります。この表を参考にして、どの CUDA Toolkit が必要か調べます。

「>=」という表現は、その数値以上のドライババージョンが必要ということです。例えば、CUDA 12.2 GA を使う場合には、Windows では 536.25 以上の Driver バージョンが必要ということです。

今回 CUDA をインストールしようとしている環境については以下の通りです。
(記事執筆時点)

NVIDIA Driver のバージョンを確認するには、Windows の[設定] – [アプリ] からアプリと機能を “NVIDIA” で検索し「NVIDIA グラフィックドライバー」の数字を確認します。このバージョンの数値を CUDA Toolkit and Corresponding Driver Versions と照らし合わせて CUDA Toolkit を選択してください。

使用するディープラーニングライブラリ（PyTorch や TensorFlow 等）の対応状況も確認が必要です。

例えば、今回は PyTorch 2.0.1 を使用することを前提として PyTorch のページを調べてみます。最新バージョンはこちらを、過去バージョンはこちらのページを参考にしてください。以下は記事執筆時点で最新のページを確認した際のキャプチャです。

上記の表を見ればわかるように CUDA 11.7 や CUDA11.8 に対応しているようです。今回の環境のドライバでは 11.7、11.8 いずれも要件を満たしていましたので、今回は CUDA 11.8 をインストールしてみたいと思います。

CUDA のダウンロードとインストール

CUDA については CUDA Toolkit Archive のページから指定バージョンのダウンロードページへ遷移してダウンロードします。インストールしたいバージョンをクリックしてください。この記事では 11.8.0 をクリックした場合で説明していきます。

ダウンロードページでは、Windows 等の条件のボタンを押していくとダウンロードボタンが表示されます。local を選択すると数 GB のインストーラーをダウンロードすることになりますが、network を選択するとインストーラ自体は数 MB の小さなファイルとなり、実行時にダウンロードしつつインストールができます。

インストールしたインストーラをダブルクリックしてインストールを実行します。インストール用の一時フォルダの指定がありますが特にこだわりがなければそのまま「OK」をクリックしてください。

まずは、システムの互換性チェックが実行されます。

NVIDIA のソフトウェア使用許諾が表示されるので確認して「同意して続行する」をクリックしてください。

インストールオプションについては特に細かな設定が必要でなければ「高速(推奨)」を選択すれば問題ありません。次へをクリックします。

Visual Studio がインストールされていない場合、以下の画面が表示されるかと思います。Visual Studio で開発しない場合は不要ですので、チェックを入れて NEXT をクリックします。

インストールの準備が始まります。

インストールパッケージのダウンロードと処理が始まります。

インストールが開始されます。

以下のページが出たら、次へをクリックします。

インストールは完了です。チェックは任意で選択して閉じるをクリックしてください。

CUDA のインストールの確認をするために、コマンドプロンプトで以下を実行してください。以下のようにバージョン情報が表示されればインストール完了です。

>nvcc -V
nvcc: NVIDIA (R) Cuda compiler driver
Copyright (c) 2005-2022 NVIDIA Corporation
Built on Wed_Sep_21_10:41:10_Pacific_Daylight_Time_2022
Cuda compilation tools, release 11.8, V11.8.89
Build cuda_11.8.r11.8/compiler.31833905_0

cuDNN のインストール

ディープラーニングライブラリである cuDNN のインストール方法を紹介します。cuDNN は CUDA との対応をよく確認してインストールする必要があるので、バージョンの確認方法を含めて説明していきます。

バージョンの確認

cuDNN と CUDA との対応は GPU, CUDA Toolkit, and CUDA Driver Requirements の対応表を確認します。

今回インストールした CUDA 11.8 の場合は「cuDNN 8.9.3 for CUDA 11.x」が適切であることが分かります。(記事執筆時点)

cuDNN のダウンロードとインストール

cuDNN はこちらのページから「Download cuDNN」でダウンロードします。

cuDNN はダウンロードするために NVIDIA のアカウント登録が必要なので、持っていない人はアカウント登録してください。以下のページで Windows 用の ZIP ファイルをダウンロードします。

ダウンロードした zip を展開すると bin 等のフォルダがあるので CUDA フォルダの配下に配置します。私の場合は以下のフォルダを作ってファイルを配置しました。

C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.8\cudnn

次に cuDNN のライブラリフォルダに環境変数のパスを通します。システムのプロパティから環境変数を開き Path に以下のような CUDA 関連のパスを設定します。

（機械学習のプログラミングをしていて CUDA や cuDNN 関連でうまくプログラムが実行できない場合は、環境変数を確認してみると解決する可能性があります）

以下コマンドで場所が確認できれば問題ないかと思います。
※ dll のファイル名は cuDNN のバージョンにより異なるかもしれませんので、正確には bin フォルダ配下の dll ファイル名を確認してから実行してください。

where cudnn64_8.dll

以上で cuDNN のインストールは完了です。

GPU の認識を確認（PyTorch）

今回は Pytorch 2.0.1 を想定しつつ CUDA のインストールを試したので PyTorch での GPU の認識を確認してみます。任意の Python プロジェクトを作成して以下のコマンドで Pytorch をインストールします。

pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118

上記は、記事前半で確認したこちらのバージョンページにて「Run this Command:」で指定されているインストールコマンドです。

インストール後に pip list で確認してみると Pytorch (= torch) としては「2.0.1+cu118」がインストールできていることが確認できます。

>pip list
Package            Version
------------------ ------------
certifi            2022.12.7
charset-normalizer 2.1.1
filelock           3.9.0
idna               3.4
Jinja2             3.1.2
MarkupSafe         2.1.2
mpmath             1.2.1
networkx           3.0
numpy              1.24.1
Pillow             9.3.0
pip                23.2.1
requests           2.28.1
setuptools         68.0.0
sympy              1.11.1
torch              2.0.1+cu118
torchaudio         2.0.2+cu118
torchvision        0.15.2+cu118
typing_extensions  4.4.0
urllib3            1.26.13

Pytorch 環境をインストールできたら以下の簡単なプログラムを作成して実行することで GPU の認識を確認します。

import torch

# GPUの認識を確認する
print(torch.cuda.is_available(), "\n")

# PyTorchで使用できるGPU(デバイス)の数やデフォルトのGPU番号を確認
print(torch.cuda.device_count())
print(torch.cuda.current_device(), "\n")

# GPUデバイス名を確認する
print(torch.cuda.get_device_name())

【実行結果】
True 

1
0 

NVIDIA GeForce RTX 2080 Ti

is_available の実行結果として「True」が返ってきているので Pytorch が GPU を認識できています。また、各種メソッドを使うことでデバイスの情報が取得できていることが分かります。

is_available の結果が False の場合はうまく GPU を認識できていませんので GPU ドライバーや CUDA のバージョンなどを再度確認してみてください。

まとめ

NVIDIAのGPUを使った並列計算のための環境である CUDA や関連するライブラリの cuDNN をインストールする方法について解説しました。

CUDA と cuDNN は、どのバージョンをインストールするかで悩むと思います。また、プログラミング時にうまく動かないということもよくあります。私も最初はうまく動かせないことがありましたが、関係性を理解できると解決しやすくなります。

この記事を参考にしていただいて、使用している GPU やライブラリにあったディープラーニング実行環境を構築してもらえるといいかなと思います。

あわせて読みたい

【Python Tech】プログラミングガイド

Pythonのフォーマットツール

Pythonでプログラミングをしている際にコードの整形をサポートしてくれるツールがいくつかあります。

例えばAutopep8、black、yapfといったものがありますが、最近ではblackがデファクトスタンダートになっているようです。また、blackは、import文のソート順整理や重複削除について実行してくれませんのでisortと併用すると便利です。

本記事では、Pythonの統合開発環境であるPyCharmにてコードを保存する際に、blackとisortによるフォーマットをするための設定方法について解説します。

Pycharmにおけるコード保存時の自動フォーマット設定

blackとisortのインストール

blackとisortがまだインストールがされていない人は以下のコマンドでインストールしてください。

pip install black

pip install isort

Pycharmへのファイル監視プラグインのインストール

コード保存時の自動フォーマットをするためには、PyCharmのファイル監視プラグインである「File Watchers」が必要です。

PyCharmを開いた際の左側にある「プラグイン」で、Marketplaceの検索窓に”File Watchers”と入れてみてください。このプラグインはデフォルトで入るのだったか忘れてしまったのですが、インストール済みになっていればファイル監視プラグインはインストールされています。

インストールされていないようであれば、インストールを実行して、PyCharmを再起動してください。

PyCharmでのファイル監視プラグイン設定

ファイル監視プラグインがインストールされていると、PyCharmで[ファイル]-[設定]のツール配下に「File Watchers」という項目があります。

ここにblackとisortの設定を適用します。以降で具体的な手順を見ていきましょう。

blackの設定

blackを設定する場合には「+」のcustomを選択してください。

以下の項目を設定していきます。

上記の設定では、現在のPythonファイルに対してblackによるフォーマットを実行します。

[高度なオプション]の2項目は現在編集中のファイルが保存されたときだけblackを実行する用にチェックを外します。

OKを押すと以下のようにファイル監視設定が作成されます。無効化したい時はチェックを外しましょう。

上記の設定後にPythonファイルを保存してみましょう。blackによるコードフォーマットが実行されます。

1行の文字数を変更したい場合

blackでは1行の文字数は88文字になっています。PEP8では79文字以内ということになっているため、自動整形したときに80文字以上になるとPycharmの設定によってはPEP8に合わない旨の警告が出るかもしれません。

88文字である理由は、blackの開発者が88文字がよいという考えがあるからのようです。

blackの設定をPEP8に揃えたい場合は、.pyproject.tomlというファイルをプロジェクト直下に作成して以下のような記述を追加してください。

[tool.black]
line-length = 79

上記のような設定の.pyproject.tomlを用意しておくと、blackの自動成型時に79文字以内になるように整形してくれるため、PEP8のチェックも問題なくなります。

もちろん文字数は、プロジェクトの方針や個人の好みに合わせて変更していただければよいかと思います。

isortの設定

blackの設定と同じくisortの設定もしていきましょう。File Watchersの設定で「+」のcustomを選択し、以下のように入力してください。

上記の設定では、現在のPythonファイルに対してisortによるimport文の整形を実行します。

[高度なオプション]の2項目は現在編集中のファイルが保存されたときだけisortを実行する用にチェックを外します。

OKを押すと以下のようにファイル監視設定が作成されます。無効化したい時はチェックを外しましょう。

上記の設定後にPythonファイルを保存してみましょう。isortによるimport文のソートが実行されます。

まとめ

PyCharmでのプログラム開発時でコード保存時に自動フォーマットする方法について解説しました。具体的には、blackとisortを自動適用する方法を紹介しています。

コード保存時の自動適用は、ファイルを監視するPyCharmのプラグイン「File Watchers」にblackとisortの実行パラメータを設定することで実現できます。

フォーマットツールをうまく使うとプログラマ間で品質の違いを小さくすることができますので、是非設定して使ってもらえるとよいかと思います。

あわせて読みたい

【Python Tech】プログラミングガイド

Pythonにおけるdocstring

Pythonでプログラミング開発をしている際に、関数やクラスなどの仕様を利用者に対して分かるようにすることが必要です。ダブルクオート(“)を３つ連続して並べた三重引用符で囲んで記載した文字列をdocstringと言います。

例えば、docstringの例としては以下のような感じです。

def sample_func(temp1: int, temp2: int) -> int:
    """2変数の加算結果を返却する

    Args:
        temp1 (int): 数値1
        temp2 (int): 数値2

    Returns:
        int: 加算結果
    """
    return temp1 + temp2

このdocstringについては、自分でゼロから書いてももちろんいいのですが、関数の定義をベースに自動で生成して、細部を埋めていく方がはるかに楽です。

コードエディタであるVSCodeでは、拡張機能である「Python Docstring Generator」を使用することで、docstringを自動生成することが可能になります。

本記事では、Python Docstring Generatorをインストールや使い方、設定方法について紹介します。

Python Docstring Generatorの使い方

Python Docstring Generatorのインストール

Python Docstring Generatorは、Python拡張機能としてインストールできます。以下の手順でPython拡張機能をインストールしてください。

1. 拡張タブを選択する。
2. 検索窓で「docstring」と入力する。
3. 検索された「autoDocstring – …」をクリックすると右側にPython拡張の説明が表示される。
4. インストールをクリックしてPython拡張機能をインストールする。

上記のインストールを行うことでPython Docstring Generatorの機能が使用できるようになります。

Python Docstring Generatorの使い方

Python Docstring Generatorの使い方は簡単です。

開発しているPythonプログラムで関数を定義するときに、関数定義の下の行で以下のようにダブルクオート(“)を三つ入力すると「Generate Docstring」というように表示されるのでEnterを押します。

また、ダブルクオートを入力しなくても関数定義の下の行で「ctrl + shift + 2」とすることでも生成できますのでお好みの方法を利用してください。

実行すると以下のようにdocstringが自動生成されます。

_summary_や_description_のところを以下のように自分で書き換えればdocstringが完成します。

docstringを記載しておくと、以下のように呼び出しもとで関数にマウスのカーソルを合わせる等するだけ以下のように、関数の概要を把握することも可能になります。

Python Docstring Generatorの設定

Python Docstring Generatorでは、「google」スタイルのフォーマットがデフォルト設定となっています。

拡張機能のインストール一覧からPython Docstring Generatorの[歯車マーク]-[拡張機能の設定]をクリックすると設定を確認することができます。

以下のAuto Docstring: Docstring Formatの部分がフォーマットに関する設定になります。

プルダウンをクリックして見ると以下のように結構たくさんの種類がありますね。自分の好みやプロジェクトの方針により設定を変更して使用してください。

どのスタイルを使うのがよいのかという話があるかと思います。numpyスタイルか、googleスタイルかといったあたりがよく話が上がるような気がしますが、プロジェクトとして一貫していればいずれのフォーマットでも問題ないかと思います。

まとめ

VSCodeでのPython開発でdocstringを自動生成してくれるPython Docstring Generatorについて紹介しました。

Python Docstring Generatorのインストール、基本的な使い方、スタイルの設定について説明しています。docstringの記載は関数等の説明を利用者やプロジェクトメンバに伝える意味でも、プログラミングにおいて重要なことであると思っています。

ゼロから自分で書くのは少し面倒ですので、Python Docstring Generatorを活用して効率よく記載していってもらえるとよいかと思います。

あわせて読みたい

【Python Tech】プログラミングガイド

Gitのrebase

rebaseとは

Gitは、プログラムソース等のバージョン管理ソフトウェアです。rebaseとは、Gitで提供されるコマンドの一種です。

似たコマンドとして開発ブランチをまとめるmergeというコマンドがありますが、こちらは感覚的にも理解しやすいのに対して、このrebaseというコマンドは取り扱いが少し難しいコマンドです。

rebaseコマンドを一言で表すと「コミットをつなげなおしたり、ひとまとめにしたり、コミットメッセージを修正したりして、ログを綺麗にする」コマンドです。

本記事では、コードエディタのVSCodeを使いつつ、rebaseコマンドを実行して使う方法について、いくつかの主要な使い方に絞って図を用いながら紹介していきます。

VSCodeを用いてGitのrebaseを実行する方法

ここからは、コードエディタであるVSCodeを使ってGitのrebaseを実行する方法を紹介します。

前提として、VSCodeの拡張機能であるGitLensとGitGraphを使用しています。VSCodeの拡張機能としてインストールしておいてください。インストール方法が分からない方は、本記事内にこちらにインストール方法の参考を設けていますので、確認してインストールしてください。

rebaseでのよくある主要な使い方

rebaseはいくつかの使用ケースが考えられるかと思いますが、よくある主要な使い方だと思われる以下の３種類の方法について、概要図なども交えて紹介していきます。

1. 開発コミットをつなげなおす
2. 複数コミットを一つにまとめる
3. コミットメッセージを修正する

開発コミットをつなげなおす

一つ目の例として、開発コミットをつなげなおす例を紹介します。具体的には、以下の図でブランチAとブランチBのように複数のブランチで開発コミットしていた時に、ブランチAの後ろにブランチBをつなげなおすことを考えてみたいと思います。

上記の例は、startの位置でブランチAとブランチBが作成されてそれぞれで開発を進めた場合を示しています。

では、具体的にVSCode上でどのような手順を実施するか見ていきましょう。以下が実際に上記のような状況でのGitGraphのコミットグラフです。このコミットグラフの状態からブランチAの後ろにブランチBをつなげる手順を見ていきましょう。

まず、ブランチBがチェックアウトされている状態で、ベースとなるブランチA上で右クリックし、「Rebase current branch on this commit…」をクリックします。

以下のようなダイアログが出るので、「Launch Interactive Rebase in new Terminal」にチェックを入れて「Yes, rebase」をクリックします。

すると以下のようなGitLens Interactive Rebase画面が表示されます。各行がコミットを表していてプルダウンでいくつかの処理が選べます。「pick」は何もせずそのまま使うという意味で、今回はコミット自体には変更等加えずに、つなぎ変えるだけですのでpickを選んだ状態で「START REBASE」をクリックします。もしくは「Ctrl + Enter」でも実行できます。なお、処理をやめたいときは「ABORT」をクリックしてください。

Rebaseを実行するとVSCodeのターミナルで以下のような表示がされます。「git rebase」というのがコマンドが実行されて、成功していることが分かります。

git rebase --interactive c219f6ef4154eb71753828a641795630a38384e2

Successfully rebased and updated refs/heads/branch-B.

GitGraph上で更新ボタンを押すとグラフが更新されます。

上記のように、Aの後ろにつなぎなおされて一直線のきれいなコミットグラフになったことが分かります。

複数コミットを一つにまとめる

次に、複数コミットを一つにまとめる例を紹介します。コミットは開発にそって適宜実施していくわけですが、後から見ると複数のコミットをひとまとめのコミットにしておいた方が変更内容が理解しやすく、すっきりとするような場合がよくあります。

このような際には、rebaseを使って以下の図のようなイメージで複数コミットを一つにまとめることができます。

上記は、もともとa~dまであったコミットをまとめてeという一つのコミットにまとめているような例を示しています。

では、具体的にVSCode上でどのような手順を実施するか見ていきましょう。以下が実際に上記のような状況でのGitGraphのコミットグラフです。このコミットグラフで、ファイル作成～変更1, 2, 3のコミットを一つにまとめてみましょう。

まず、ブランチAがチェックアウトされている状態で、変更したい範囲の一つ前のコミットを右クリックし、「Rebase current branch on this commit…」をクリックします。

以下のようなダイアログが出るので、「Launch Interactive Rebase in new Terminal」にチェックを入れて「Yes, rebase」をクリックします。

すると以下のようなGitLens Interactive Rebase画面が表示されます。各行がコミットを表していてプルダウンでいくつかの処理が選べます。今回は、コミットを統合するので統合するコミットを「squash」に変更して、「START REBASE」をクリックします。もしくは「Ctrl + Enter」でも実行できます。なお、処理をやめたいときは「ABORT」をクリックしてください。

すると、GITで設定されているエディタが起動し以下のような画面になります。この例ではVSCodeが起動している例です。この画面ではコミットメッセージの変更をすることができ、#から始まる行はコミットメッセージとしては無視されます。

今回は、一つにコミットをまとめたメッセージにしたいので以下のように変更して保存し、「×」で閉じると処理が継続します。

Rebaseを実行するとVSCodeのターミナルで以下のような表示がされます。「git rebase」というのがコマンドが実行されて、成功していることが分かります。

git rebase --interactive 8f9c37b185f75ae5944cc05ea607290e3b93b14f

[detached HEAD 1e405dd] branch-A: ファイル作成&変更
 Date: Sun Nov 13 09:43:39 2022 +0900
 1 file changed, 3 insertions(+)
 create mode 100644 testA.py
Successfully rebased and updated refs/heads/branch-A.

GitGraph上で更新ボタンを押すとグラフが更新されます。

上記のように、複数あったコミットが一つのコミットにまとめられていることが分かるかと思います。

コミットメッセージを修正する

Gitでコミットをしていると、たまにコミットメッセージを間違えたり、書くべき事項が足りなかったりといったケースがよく発生します。

このような際には、rebaseを使って以下の図のようなイメージでコミットメッセージを修正することができます。

上記の例は、cの部分のコミットメッセージで変換ミスをしてしまった場合を示しています。

では、具体的にVSCode上でどのような手順を実施するか見ていきましょう。以下が実際に上記のような状況でのGitGraphのコミットグラフです。このコミットグラフの状態からコミットメッセージを修正する手順を見ていきましょう。

まず、ブランチAがチェックアウトされている状態で、変更したい範囲よりも前のコミットを右クリックし、「Rebase current branch on this commit…」をクリックします。

以下のようなダイアログが出るので、「Launch Interactive Rebase in new Terminal」にチェックを入れて「Yes, rebase」をクリックします。

すると以下のようなGitLens Interactive Rebase画面が表示されます。各行がコミットを表していてプルダウンでいくつかの処理が選べます。今回は、コミットメッセージを修正する対象のコミットを「reword」に変更して、「START REBASE」をクリックします。もしくは「Ctrl + Enter」でも実行できます。なお、処理をやめたいときは「ABORT」をクリックしてください。

すると、GITで設定されているエディタが起動し以下のような画面になります。この例ではVSCodeが起動している例です。この画面ではコミットメッセージの変更をすることができ、#から始まる行はコミットメッセージとしては無視されます。

今回は、rewordに設定したコミットメッセージが表示されます。コミットメッセージを修正して保存し、「×」で閉じると処理が継続します。今回の例ではrewordに設定したのが一つのコミットでしたが、複数の場合は順次同様に変更します。

Rebaseを実行するとVSCodeのターミナルで以下のような表示がされます。「git rebase」というのがコマンドが実行されて、成功していることが分かります。

git rebase --interactive 6291c81b14f50c98978dbe4287cfc8571148644f

[detached HEAD 6755a18] branch-A: ファイル変更2
 Date: Sun Nov 13 10:47:00 2022 +0900
 1 file changed, 1 insertion(+)
Successfully rebased and updated refs/heads/branch-A.

GitGraph上で更新ボタンを押すとグラフが更新されます。

上記のように、誤っていたコミットメッセージが修正されたことが分かるかと思います。

rebaseのその他の処理

rebaseで上記でも使用してきたpick、squash、reword等がありますが、他にもありますので表でまとめておこうと思います。今回は主要な処理に絞ってということで一部しか紹介しませんでした。必要に応じて各処理の方法を調べてもらえるとよいかと思います。

mergeとrebaseの使い分け

mergeコマンドとrebaseコマンドの大きな違いは、「既存のコミットに影響を与えるか否か」という点です。mergeコマンドを使うと、merge commitとして新しいコミットを作成するので既存のコミットに影響を与えることはありません。

そのため、複数の開発メンバーにて、共同開発をしている環境で安易にrebaseしてしまうと他の人のコミットを勝手に作り直してしまうというようなことが発生してしまう可能性もあります。

そのため、まだリモートリポジトリにpushしていない段階のローカルリポジトリ内でコミットの内容を修正するのにはrebaseを使うようにするとよいと思います。一方で、pushした後で他の人も見ている・ソースを修正しているような場合については、mergeを使用するようにしましょう。共同開発環境ではpull requestを通じて検証をしつつmergeするというのが一般的かと思います。

【参考】Git拡張機能のインストール

GitGraphのインストール

GitGraphは、Gitのコミットグラフをきれいに表示するためのVSCode拡張です。以下のように拡張タブからインストールしてください。

インストールすると、ソース管理タブのところから以下のボタンを押すことでGitGraphによるコミットグラフを表示することができます。

GitLensのインストール

GitLensは、Gitの変更情報などをVSCode上で確認したりするのに非常に便利な拡張機能です。以下のように拡張タブからインストールしてください。

GitLensを導入すると、ソースコード上にファイルの変更時刻や各行が最後に変更された際のコミットメッセージなどをソース上でも確認できるようになります。

他にもgitの変更情報を以下のようにコミットメッセージと並べて見たりなど、色々とGitのコミット情報を確認してプログラミングを進めるのに便利な機能が提供されています。

今回の記事では、上記で紹介している例のように「GitLens Interactive Rebase」ということでrebaseのコマンドをGUIでできる機能を使用しています。

まとめ

VSCodeでGitのrebaseを実施する方法について解説しました。rebaseとは、Gitで提供されるコマンドの一種です。

rebaseはいくつかの使用ケースが考えられるかと思いますが、よくある主要な使い方だと思われる以下の３種類の方法について、概要図なども交えて紹介しています。

1. 開発コミットをつなげなおす
2. 複数コミットを一つにまとめる
3. コミットメッセージを修正する

rebaseは、gitコマンドの中でも扱いが少し難しいものであると感じますが、コミットログを綺麗にする際にとても便利ですので、参考にしていただければと思います。

あわせて読みたい

【Python Tech】プログラミングガイド

.gitignoreとは

バージョン管理ソフトウェアであるGitでは、バージョン管理対象外とするファイルを指定することができます。この対象外のファイルを指定する特殊なファイルが「.gitignore」ファイルです。

.gitignoreは自分で書いてもよいのですが、プログラミング言語ごとに含めたくないファイルというのはおおむね決まっていてテンプレートも存在しています。GitHubのこちらにも様々な.gitignoreが公開されています。

上記リンク先のファイルをコピペして作ってもいいのですが、自動で生成してくれる方が便利です。本記事では.gitignoreのテンプレートを自動で生成する方法について紹介します。

.gitignoreのテンプレートで自動生成する方法

.gitignoreのテンプレートを自動で生成する方法として以下の２種類を紹介したいと思います。

• GitHubでプロジェクトを作成する際に生成する
• VSCodeの拡張機能で生成する

GitHubでプロジェクトを作成する際に生成する

GitHubでプロジェクトを生成する際には以下のような「Add .gitignore」という項目が存在し、プルダウンから各言語を選択することができます。以下の例ではPythonを選択した例になります。

上記の設定で「Create repository」によりリポジトリを作成すると以下のように.gitignoreファイルが自動で生成されます。

GitHubでプロジェクトを作った後は、ローカルにクローンして開発を進めることができます。

VSCodeのgitignore拡張機能を使用して生成する

VSCodeをプログラム開発で使用している人であれば、「gitignore」という拡張機能を使用することで.gitignoreを生成することが可能です。

gitignore拡張機能は以下の手順でインストールしてください。似たような拡張が出てきますが本記事では「CodeZombie」の拡張機能に関して紹介します。

1. 拡張タブを選択する
2. 検索窓で「gitignore」と入力する。
3. 検索された「gitignore」をクリックすると右側にgitignoreの説明が表示される。
4. インストールをクリックしてgitignoreをインストールする。

gitignoreをインストールすると「Add gitignore」というコマンドが使用できるようになります。

「Ctrl + Shift + P」またはF1でコマンドパレットを表示して、以下のように「Add gitignore」と入力してEnterを押してください。すると色々な.gitignoreの一覧が表示されますので、対象とする言語を選んでください。以下の例ではPythonを選択した場合です。

「Add gitignore」を実行すると、自動的に以下のように.gitignoreファイルを作成してくれます。

まとめ

Gitでバージョン管理する際に管理対象外を指定する.gitignoreを自動生成する方法について紹介しました。方法としては以下の２種類を紹介しています。

• GitHubでプロジェクトを作成する際に生成する
• VSCodeの拡張機能で生成する

.gitignoreは自分でゼロから作るのは大変ですので、自動生成を使って作成した後、カスタマイズしていくとよいかなと思います。

あわせて読みたい

【Python Tech】プログラミングガイド

Gitとは

Gitとは、プログラムのソースコード等のバージョンを管理するソフトウェアです。ソースコード等の変更履歴データを「リポジトリ」と呼ばれる場所で管理をします。

Gitは、分散バージョン管理システムとも呼ばれます。バージョン管理ソフトウェアとして他にも有名なSubversion等のソフトウェアがありますが、リポジトリが全体で一つでした。そのため、開発者が増えると変更箇所がぶつかる（コンフリクト）がよく発生してしまうなど不整合が起こりやすくなります。

Gitでは全体を統括する「リモートリポジトリ」と各開発者ごとの「ローカルリポジトリ」に分かれています。開発者は自分のローカルリポジトリに変更を記録していき、しかるべきタイミングでリモートリポジトリに変更を反映することができます。これが「分散」と呼ばれる理由です。

なお、GitとGitHubと混同する方もいらっしゃいますが、GitとGitHubは全く別物です。Gitはバージョン管理ソフトウェアで、GitHubはGitを利用した開発者を支援するWebサービスであるので異なったものです。GitHubはGitの機能を使用しつつ、Pull RequestやIssue等の世界中のソフトウェアが開発者が参加して共同でプログラムを開発する枠組みを提供しています。

本記事では、GitをWindowsにインストールする方法について解説をしていきます。

Gitのインストール方法

Gitのダウンロード

Gitのダウンロードページにアクセスします。

「Download」ボタンをクリックすると、最新のGitのインストーラーがダウンロードできます。本記事執筆時点では「2.38.1」でした。

Gitのインストール

ダウンロードしたexeファイルを実行します。

以降は「Git 2.38.1」でのインストール画面になります。バージョンにより若干インストール画面が異なる場合が異なるかと思いますが、どのバージョンでも基本的には同様にクリックしていけばダウンロードできます。

ライセンス条項を確認して「Next」をクリックします。

インストール場所は特に変更する必要ありませんが、必要あれば変更して「Next」をクリックします。

コンポーネントも基本的にはそのままのチェックで構いませんので「Next」をクリックします。

「Next」をクリックします。

Gitでデフォルトで使用するエディタを選択して「Next」をクリックします。上記ではVSCodeを選んでいますがお好みのエディタで構いません。

デフォルトブランチ名に関する設定です。「Override the default branch name for new repositories」を選択して「Next」をクリックします。以前はGitのデフォルトブランチ名はmasterでしたがmainに変わってきています。

コマンドラインからどのように使用するかの選択ですが、Reccomendedになっている「Git from the command line and also from 3rd-party software」を選択し、「Next」をクリックします。

SSHに関する選択ですが「Use bundled OpenSSH」を選択して「Next」をクリックします。

SSL/TLSに関する選択ですが「Use the OpenSSL library」を選択して「Next」をクリックします。

改行コードに関する選択ですが「Checkout Windows-style, commit Unix-style line endings」を選択し「Next」をクリックします。この設定ではコミット時に改行コードCRLFはLRにコンバートされてコミットされます。記載があるようにクロスプラットフォームで使用するプロジェクトで推奨されます。

ターミナルエミュレータに関する選択ですが「Use MinTTY (the default terminal of MSYS2)」を選択し「Next」をクリックします。

git pull時の選択についてですが「Default (fast-forward or merge)」を選択して「Next」をクリックします。

「Git Credential Manager」を選択して「Next」をクリックします。

「Enable file system caching」にチェックを入れて「Next」をクリックします。

「Install」をクリックするとインストールが開始されます。

以下の画面が表示さえたらGitのインストールは完了です。

「Finish」をクリックしてインストーラーを終了してください。

上記のインストールが完了するとGit Bashというアプリケーションが入っていると思いますので起動してみてください。

Git Bashが起動したら以下のコマンドを入力してみてください。

git version

上記のようにバージョンが表示されれば正常にGitがインストールされています。Git Bashで各種Gitコマンドを使用することで、Gitによるバージョン管理を行うことができます。

また、Visual Studio等の各種統合開発環境(IDE)では、Gitと連携できるようになっているものが多く、IDEから直接Gitを使用することもできます。

Gitの設定

Gitにユーザー名とメールアドレスを指定しておくことで、コミットした時に誰がコミット操作を行ったかを記録することができます。Git Bashに以下のように入力して、設定してください。「ユーザー名」「メールアドレス」の部分はそれぞれ皆さんの情報を入力してください。

git config --global user.name "ユーザー名"

git config --global user.email "メールアドレス"

ユーザー名とメールアドレスが設定できているかどうかを確認するには以下のコマンドで確認できます。Git Bashに入力して確認してみてください。

git config user.name

git config user.email

設定情報が確認出来たら初期設定としては完了です。

まとめ

バージョン管理ソフトウェアであるGitをWindowsにインストールする方法について解説しました。

Gitは現在のプログラミング開発では必須のツールの一つとなっています。バージョン管理について理解はSE、プログラマとして非常に重要な知識ですので、是非Gitをインストールして使い方に慣れていってもらいたいと思います。

あわせて読みたい

【Python Tech】プログラミングガイド