Rainbow Engine

IT技術を分かりやすく簡潔にまとめることによる学習の効率化、また日常の気付きを記録に残すことを目指します。

Python

Pythonでargparseを用いて引数を受け取って実行する方法

投稿日:2020年12月23日 更新日:

<目次>

(1) Pythonでargparseを用いて引数を受け取って実行する方法
 (1-1) argparseとは?
 (1-2) 基本的な使い方
 (1-3) サンプルプログラム
(2) 参考:argparseの引数の種類について
 (2-1) positional arguments
 (2-2) optional arguments

(1) Pythonでargparseを用いて引数を受け取って実行する方法

(1-1) argparseとは?

argparseはPythonで「位置指定引数」(positional arguments)を扱うためのパッケージです。位置指定引数とは引数の順番が意味を持つ引数です(順番を正しく保つ必要がある)。Python2.7でoptparseの後継機能として導入されています。

目次にもどる

(1-2) argparseの最も基本的な使い方

■STEP1:Parserオブジェクトの作成

まず最初のステップとして「parserオブジェクト」を作ります。
(STEP1)

import argparse
parser = argparse.ArgumentParser(description='Description of the argument')
 
■STEP2:引数の設定

次に「add_argument()」を使い、何の引数を待ち受けるかを教えます。それによりparserはプログラムのランタイム(実行時)にコマンドライン引数を処理する事ができます(ユーザが実行時に引数を与える)。
(STEP2)

parser.add_argument('indir', type=str, help='Input dir for videos')
parser.add_argument('outdir', type=str, help='Output dir for image')
 
■STEP3:引数の構文解析

parse_args()メソッドを用いて引数を構文解析(?)して格納します。
(STEP3)

args = parser.parse_args()

目次にもどる

(1-3) サンプルプログラム

argparseを使用して引数を受け取るサンプルプログラムをご紹介します。

(サンプルプログラム)

import argparse

def main():
    #(1)parsarオブジェクトの作成
    parser = argparse.ArgumentParser(description='Tiff to JPEG')
    #(2)引数を作成
    parser.add_argument('input', type=str, help='Input dir for Tiff')
    parser.add_argument('output', type=str, help='Output dir for JPEG')
    #(3)構文解析した引数を「args」変数にセット
    args = parser.parse_args()
    print(args.input)
    print(args.output)

if __name__ == '__main__':
    main()

上記サンプルプログラムをコマンドラインから、「スペース区切り」で引数を2つ与えて実行すると、その引数を受け取ってコンソール表示しています。

(図131)
引数に「ABCD」と「EFGH」を与えると、その引数を受け取って表示しています。
1つ目の引数が「indir」に格納され、2つ目の引数が「outdir」に格納されています。
ちなみに、引数を与える時はクォーテーションで囲まなくても正常に動作します。

目次にもどる

(2) 参考:argparseの引数の種類について

argparserにおける引数は2つの種類があり、基本は全て「①positional arguments」であり、「–help」のみが「②optional arguments」になります。

(2-1) positional arguments

引数には順序があり、最初に記述した引数が1つ目の変数(例では「input」)にセットされ、次に記述した引数が2つ目の変数にセットされます(例では「output」)。

(2-2) optional arguments

「–help」(及び短縮形の「-h」)は唯一のデフォルトで使えるオプション引数で「-」や「–」が付いているのが特徴です。「–help」は定義されている引数の情報をコンソールに出力します。

(図221)引数を定義したプログラムの末尾に「–help」を付けて実行すると引数の情報が表示されます。

 
また事前定義されているのは「–help」のみですが、optional argumentsは自身で定義する事もできます。
(例)
parser.add_argument('-r', '--rainbow')

 

Adsense審査用広告コード


Adsense審査用広告コード


-Python

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

Anacondaのインストール手順(Windows 10の例)

  <目次> (1) Anacondaのインストール手順(Windows 10の例)  (1-1) STEP1:インストーラーの入手と起動  (1-2) STEP2:インストール  (1-3 …

「pyenv」の導入後も「System Python」が有効になってしまう事象の原因と対処について

  <目次> (1) 「pyenv」の導入後も「System Python」が有効になってしまう事象の原因と対処について  (1-1) 問題点の整理  (1-2) 原因&対策(1つ目)  ( …

Azure FunctionsでPythonのライブラリを追加する方法(依存関係解決)

  <目次> (1) Azure FunctionsでPythonのライブラリを追加する方法(依存関係解決)  (1-1) requirement.txtの設定手順  (1-2) 補足事項 …

Pythonのvenvの使い方(基礎編)をご紹介

  <目次> (1) Pythonのvenvの使い方(基礎編)をご紹介  (1-1) venvとは?  (1-2) STEP1:仮想環境(venv)の作成  (1-3) STEP2:仮想環境 …

Python環境にpyodbcをインストールしてSQLServerに接続する手順

<目次> (1) PythonにpyodbcをインストールしてSQLServerに接続する手順  (1-1) 手順1:ODBCドライバのインストール  (1-2) 手順2:pythonパッケージの導入 …

  • English (United States)
  • 日本語
Top