【基本】Pythonの引数を徹底解説｜コマンドライン引数の取得例あり

2023.07.05

※本サイトにはプロモーション・広告が含まれています。

（最終更新日：2023年7月）

✔この記事の対象読者

「Pythonで引数を使ったプログラミングについて理解を深めたい」
「Pythonの引数の使い方や書き方を学びたい」
「Pythonで引数を用いた実用的なコードを見てみたい」

✔この記事でご紹介する内容

  • Pythonでの引数の基本知識
  • 引数の書き方やその活用法
  • Pythonで引数を用いた具体的なコード例

当記事では、Pythonでの引数の基本を始め、その応用法まで、具体的なサンプルコードを交えながら詳細に解説します。

ぜひ最後までご覧ください。

筆者プロフィール

筆者プロフィールアイコン

【現職】プロダクトマネージャー

【副業】ブログ（月間20万PV）/YouTube/Web・アプリ制作

「プログラミング × ライティング × 営業」の経験を活かし、30後半からのIT系職へシフト。現在はプロダクトマネージャーとして、さまざまな関係者の間に入り奮闘してます。当サイトでは、実際に手を動かせるWebアプリの開発を通じて、プログラミングはもちろん、IT職に必要な情報を提供していきます。

【当ブログで紹介しているサイト】

当サイトチュートリアルで作成したデモ版日報アプリ

Django × Reactで開発したツール系Webアプリ

✔人に見せても恥ずかしくないコードを書こう

「リーダブルコード」は、わかりやすく良いコードの定義を教えてくれる本です。

  • 見るからにきれいなコードの書き方
  • コードの分割方法
  • 変数や関数の命名規則

エンジニアのスタンダートとすべき基準を一から解説しています。

何回も読むのに値する本なので、ぜひ手にとって読んでみてください。

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック
created by Rinker

Pythonの引数とその重要性

ここではPythonの引数の基本的な概念とその重要性について説明します。

なぜ引数を学ぶべきかがより明確になるでしょう。

  • 引数の基本理解
  • 引数の利点
  • 引数の注意点

引数の基本理解

Pythonの引数は、関数やメソッドがアクションを実行するために必要な情報を提供します。

それは以下のように、どのような種類のデータでも可能です。

  • 数値
  • 文字列
  • リスト
  • 辞書 など、

引数は、関数定義の一部としてパラメータとして宣言され、関数が呼び出されるときに具体的な値として渡されます。

これにより、同じ関数を異なる値で再利用できるのです。

引数の利点

引数を使用する最大の利点の一つは、コードの再利用性を向上させることです。

同じ関数を異なる引数で呼び出すことで、さまざまなケースに対応できます。

また引数を使用すれば、関数の挙動を細かく制御し、柔軟なプログラムが作成可能です。

引数の注意点

引数の使用使用時における注意点は、関数が期待する引数の数と種類に注意を払うこと。

関数の定義と異なる数や種類の引数を渡してしまうと、エラーが発生するからです。

また関数によっては、引数内のデータを変更することがあるため、その関数がどのように引数を使用するかを事前に理解しておくことが重要といえるでしょう。

Pythonでの引数取得

こちらンでは、Pythonでコマンドライン引数を取得する方法について詳しく見ていきます。

  • 引数の取得方法
  • 引数の数とその確認方法
  • 引数とループの関係
  • 引数のエラーハンドリング（不適切な引数の取り扱い）

引数の取得方法

Pythonでは、sysモジュールのargvリストを使用してコマンドライン引数を取得します。

argv[0]は常にスクリプトの名前です。

続くインデックスが、コマンドラインから提供された引数となります。

python script.py arg1 arg2

sys.argvを[‘script.py’, ‘arg1’, ‘arg2’]というリストに変換します。

引数の数とその確認方法

引数の数は、len()関数を使用してargvリストの長さから取得できます。

argv[0]（スクリプト名）を省くため、引数の数を得るには1を引きましょう。

コマンドラインから提供された正確な引数の数を確認できます。

import sys

args_count = len(sys.argv) - 1  # スクリプト名を除いた引数の数を取得

print(f"引数の数: {args_count}")

引数とループの関係

引数はリスト形式で格納されるため、Pythonのforループを使用して個々の引数を処理できます。

個々の引数に対して操作をおこなえるのです。

import sys

# スクリプト名を除いた引数のリストを取得
args = sys.argv[1:]

# 個別の引数を処理
for arg in args:
    print(f"引数: {arg}")
    # ここで個別の引数に対して操作を行う

引数のエラーハンドリング

引数のエラーハンドリングは、関数の堅牢性を向上させるために重要な要素です。

関数が期待する引数の数が提供されているか、また引数が正しい形式で提供されているかなどをチェックしましょう。

Pythonでの引数の使い方

次に、Pythonでの引数の効果的な使い方について解説します。

引数の正確な渡し方とその実践例、複数の引数の一度に渡す方法、そして引数の順序とその重要性について詳しく見ていきましょう。

  • 引数の渡し方とその実践例
  • 複数の引数の渡し方
  • 引数の順序とその重要性

引数の渡し方とその実践例

Pythonで関数に引数を渡す基本的な方法は、引数をカンマで区切って、関数名後の括弧内に書くことです。

次の関数print_sumは、2つの引数aとbを受け取り、その和を表示します。

def print_sum(a, b):
    print(a + b)

print_sum(3, 5)  # Output: 8

複数の引数の渡し方

複数の引数を一度に渡す場合、*argsを使用します。

argsは、複数の非キーワード引数をタプルとして受け取るための特殊な構文です。

次の関数print_argsは任意の数の引数を受け取り、それらを順番に表示します。

def print_args(*args):
    for arg in args:
        print(arg)

print_args("Hello", "world", "from", "Python")

引数の順序とその重要性

関数に引数を渡す際の順序は重要です。

関数の定義における引数の順序と、呼び出し時の順序が一致していることが求められます。

例えば、上述のprint_sum関数では、最初の引数がa、次の引数がbと定義されているため、呼び出し時にも同じ順序で値を渡す必要があります。

Pythonにおける引数の受け取りと型

こちらでは、引数の型とその変換、型に基づく引数のバリデーションについて解説します。

引数を受け取る際の注意点や引数の型について深く理解することも重要です。

  • Python引数の型について
  • 引数の型変換とその注意点
  • 型に基づく引数のバリデーション

Python引数の型について

Pythonでは、引数の型は特定の型に限定されません。

整数、浮動小数点数、文字列、リストなど、任意のデータ型を引数として関数に渡せるのです。

ただしコマンドライン引数は、すべて文字列としてプログラムに渡されます。

そのため、数値として扱いたい場合には型変換が必要となります。

int(sys.argv[1])

引数の型変換とその注意点

引数の型を変換する際には注意が必要です。

なぜなら意図しない値の場合、エラーが発生してしまうから。

例えば以下のようなケースです。

def add_numbers(num1, num2):
    result = int(num1) + int(num2)
    print(f"計算結果: {result}")

add_numbers("10", "20")  # 正常な実行
add_numbers("10", "abc")  # エラーが発生

数値を示す文字列を整数や浮動小数点数に変換する場合には、int()やfloat()関数を使用します。

しかし、数値を表さない文字列をこれらの関数で変換しようとするとエラーが発生してしまうのです。

型変換の前に、引数が適切な形式であるか確認しましょう。

def add_numbers(num1, num2):
    try:
        result = int(num1) + int(num2)
        print(f"計算結果: {result}")
    except ValueError:
        print("引数が正しくありません。整数値を指定してください。")

add_numbers("10", "20")  # 30
add_numbers("10", "abc")  # 引数が正しくありません。整数値を指定してください。

型に基づく引数のバリデーション

引数が期待する型でない場合にエラーメッセージを表示するなどの対応を、バリデーションと言います。

Pythonでは、isinstance()関数を用いて引数の型を確認できます。

たとえば、引数が整数であることを確認するには次のようにします。

def print_if_int(arg):
    if isinstance(arg, int):
        print(arg)
    else:
        print(f"{arg} is not an integer.")

このように引数のバリデーションをおこなえば、エラーが起こる前にユーザーにメッセージを残すなどの対応が可能です。

Pythonにおけるリスト操作と引数

こちらでは、Pythonのリスト操作に引数をどのように活用できるかについて解説します。

リストはPythonの最も便利でよく使われるデータ構造のひとつなので、理解は必須です。

  • リストと引数の相互作用
  • 引数を用いたリストの削除操作
  • 引数とリスト操作の最適化

リストと引数の相互作用

リストは複数の要素をまとめて管理できる、便利なデータ型です。

これらの要素に対する操作は、通常、引数を用いておこないます。

例えば、リストから特定の要素を取り出す場合、そのインデックスを引数として指定します。

fruits = ["apple", "banana", "orange", "grape"]
index = 2
selected_fruit = fruits[index]
print(selected_fruit)  # 出力: "orange"

引数を用いたリストの削除操作

リストから特定の要素を削除するためには、その要素のインデックスまたは値を引数として渡すことで実現できます。

del文やremoveメソッドを使うと、指定した引数に基づいてリストから要素を削除できます。

fruits = ["apple", "banana", "orange", "grape"]
index_to_remove = 1
del fruits[index_to_remove]
print(fruits)  # 出力: ["apple", "orange", "grape"]

リストの要素削除方法については詳しくこちらで解説しています。

【Python】Listの要素を削除する方法5選｜場面別の実例付
「Pythonでリストから要素を削除する方法が知りたいですか？当記事では、Pythonのリストから、要素を削除する具体的な5つの方法を解説し、すべて具体例付きでご紹介します。一緒に手を動かしながら進められるので、初心者の方は必見です。
itc.tokyo
2023.06.17

引数とリスト操作の最適化

Pythonでは、リストの操作を最適化するために、いくつかの特殊な引数の使用法があります。

  • スライス操作：開始インデックスと終了インデックスを引数として指定し、リストから一部の要素を取り出す
  • list.sort()メソッド：key引数を使用してソートの基準を定義する

これらの技術を使うことで、リスト操作の効率と速度を大幅に向上させられます。

まとめ

当記事では、Pythonの引数について解説してきました。

  • 引数により、コードや値を再利用しやすくなる
  • コマンドラインの引数は、sys.argvで受け取れる
  • リスト操作に引数は必須

今後の学習のステップとしては、Pythonの高度な引数の使用方法を探求することをおすすめします。

例えばデフォルト引数や可変長引数、キーワード引数といったテーマは、引数の理解をさらに深めるのに役立つでしょう。

タイトルとURLをコピーしました