Pythonのcommandsモジュールについて現役エンジニアが解説【初心者向け】

初心者向けにPythonのcommandsモジュールについて解説しています。これはPython 2系でOSコマンドを実行するものです。Python 3系で同様に使用されるsubprocessモジュールについても使い方を覚えておきましょう。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

Pythonのcommandsモジュールについて、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

 

そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まるでしょう。

 

なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

commandsモジュールについて詳しく説明していくね!

大石ゆかり

お願いします!

 

目次

 

commandsモジュールとは

commandsモジュールとは、Python 2系でOSコマンドを実行するためのモジュールです。

commandsモジュールはos.popenのラッパーとして機能し、引数で指定したコマンドを実行しましょう。

コマンドの出力や終了コードを得られます。

 

[PR] Pythonで挫折しない学習方法を動画で公開中

commandsモジュールの代替

commandsモジュールはPython 2系におけるOSコマンド実行手段でした。

Python 2系は2020/1/1をもってサポート終了になりました。

Deprecated since version 2.6: The commands module has been removed in Python 3. Use the subprocess module instead.

(※)https://docs.python.org/2/library/commands.html#module-commands より抜粋

Python 3系でOSコマンドを実行するには、代わりにsubprocessモジュールを使用します。

 

subprocessモジュールの使い方

subprocessモジュールでOSコマンドを実行するには、runメソッドを使いましょう。

引数でコマンドそのものや、コマンド引数を指定します。

また、オプション引数で挙動を切り替えられ、コマンド実行結果をそのまま出力するか、戻り値に含めるかといった点を選択可能です。

 

実際に書いてみよう

以下、ソースコード、実行結果です。

インタプリタで実行しました。

>>> import subprocess
>>> result = subprocess.run(['hostname'], capture_output=True)
>>> result
CompletedProcess(args=['hostname'], returncode=0, stdout=b'DESKTOP-xxxx\r\n', stderr=b'')
>>> result.args
['hostname']
>>> result.stdout
b'DESKTOP-xxxx\r\n'
>>> result.returncode
0

解説

subprocess.runでhostnameコマンドを実行しました。

戻り値を変数resultに代入し、resultはCompletedProcessというデータ型になりました。

メンバ変数args, stdout, returncodeを参照すると、引数、標準出力、終了コードを取得しています。

 

まとめ

この記事ではcommandsとその代替となるsubprocessモジュールを紹介しました。

今後はPython 3系が主流になるので、OSコマンドの実行にはsubprocessモジュールを使用してください。

 

執筆してくれたメンター

橋本紘希(はしもとひろき)

システムインテグレータ企業勤務のシステムエンジニア。

開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。

 

大石ゆかり

Pythonのcommandsモジュールの内容がよく分かったので良かったです!

田島悠介

ゆかりちゃん、これからも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間でPythonを使った人工知能(AI)や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。

挫折しない学習方法を知れる説明動画や現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。