PythonのpwdモジュールでUnix/Linuxパスワードデータベースにアクセスする方法

はじめに

Pythonの標準ライブラリに含まれるpwdモジュールは、Unix/Linuxオペレーティングシステム上のユーザーアカウントに関するパスワードデータベース（/etc/passwdなど）へのアクセス機能を提供します。なお、このモジュールはUnix系OS専用であり、Windows環境では利用できない点に注意してください。

パスワードデータベースの各エントリは、タプルのようなオブジェクトとして格納されます。その構造は、CPython APIのpwd.hファイルで定義されているpasswd構造体に対応しています。

passwd構造体のフィールド一覧

pwdモジュールの主な関数

まず、pwdモジュールが提供している関数を確認してみましょう。

>>> import pwd
>>> dir(pwd)
['__doc__', '__loader__', '__name__', '__package__', '__spec__', 'getpwall', 'getpwnam', 'getpwuid', 'struct_passwd']

pwdモジュールには、主に以下の3つの関数が定義されています。

getpwnam()

指定したユーザー名に対応するパスワードデータベースのレコードを返します。

>>> pwd.getpwnam('root')
pwd.struct_passwd(pw_name='root', pw_passwd='x', pw_uid=0, pw_gid=0, pw_gecos='root', pw_dir='/root', pw_shell='/bin/bash')

getpwuid()

指定したUID（ユーザーID）に対応するパスワードデータベースのレコードを返します。

>>> pwd.getpwuid(0)
pwd.struct_passwd(pw_name='root', pw_passwd='x', pw_uid=0, pw_gid=0, pw_gecos='root', pw_dir='/root', pw_shell='/bin/bash')

getpwall()

システムに登録されている全ユーザーのpasswd構造体情報を含むタプルのリストを返します。構造体内のuidとgidは整数型として取得できます。

エラー処理：KeyError例外

getpwnam()やgetpwuid()に渡した引数に対応するエントリがデータベース内に存在しない場合、KeyError例外が発生します。

>>> pwd.getpwnam('hello')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'getpwnam(): name not found: hello'

実運用では、存在しないユーザー名を指定する可能性があるため、try-except文でKeyErrorを捕捉して適切に処理することが推奨されます。