0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

【Java経験者のためのPython入門 第2回】関数・例外・モジュール ― def の書き方とツールの骨格を読む知識

0
Posted at

株式会社Good Labでエンジニアをしている コータロー です。
日々、Java・SQL・Gitなどの技術情報や、新人エンジニア向けの学習ノウハウ、
AI活用についての情報を発信しています。

Good Labについて気になった方は、コーポレートサイトもぜひご覧ください。
▶コーポレートサイト

はじめに

「Java は書けるが Python は未経験なのに、既存の Python ツールを直すことになった」人向けのシリーズです。今回は 関数・例外・モジュール です。ここが分かると、既存ツールの骨格(どこから始まり、どこでエラーを処理するか)が読めます。

回 テーマ
第1回 基礎文法 ― Java との違いで覚える
第2回(本記事) 関数・例外・モジュール ― def の書き方と、ツールの骨格を読むための知識
第3回 Excel の管理表と pom.xml を突き合わせて、差分を GUI に出すツールを作る
第4回 既存ツールを読んで直す(ライブラリの見分け方・EXE 化・Windows での注意・安全な直し方)

コードはすべて Python 3.14 で実行して出力を確認しています。3.9 以前では動かない書き方には注記を付けます。

1. 関数の基本:def と return

ex01_func.py
def add(a, b):
    return a + b


def greet(name):
    print(f"Hello, {name}")  # return を書いていない


def min_max(numbers):
    return min(numbers), max(numbers)  # タプルになる


print(add(2, 3))
print(greet("Taro"))
print(min_max([3, 1, 4]))
low, high = min_max([3, 1, 4])  # アンパック(分割代入)
print(low, high)
出力
5
Hello, Taro
None
(1, 4)
1 4
  • void は無く、return を書かない関数は None を返す。「None で後続が落ちる」ときはまず return の抜けを疑う
  • 複数の値はタプル1個として返し、受け取る側で変数を並べて分解する

2. 引数:オーバーロードが無い代わりに

ex02_args.py
def make_message(name, greeting="こんにちは", mark="!"):
    return f"{greeting}、{name}さん{mark}"


def show(*args, **kwargs):
    print(args, kwargs)


print(make_message("佐藤"))
print(make_message("佐藤", "おはよう"))
print(make_message(mark="?", name="鈴木"))  # 順不同でよい
show(1, 2, debug=True, retry=3)
出力
こんにちは、佐藤さん!
おはよう、佐藤さん!
こんにちは、鈴木さん?
(1, 2) {'debug': True, 'retry': 3}
  • 定義側の greeting="こんにちは" が デフォルト値、呼び出し側の name="鈴木" が キーワード引数
  • *args は余った位置引数を タプルで、**kwargs は余ったキーワード引数を 辞書で受け取る

Python には オーバーロードがありません。同じ名前で def し直すと上書きされるだけなので、Java なら引数違いで3つ並べるメソッドも、デフォルト値で1つにまとめます。

3. 最大の罠:ミュータブルなデフォルト引数

ex03_mutable.py
def add_bad(item, items=[]):
    items.append(item)
    return items


def add_good(item: str, items: list[str] | None = None) -> list[str]:
    if items is None:
        items = []  # 呼び出しのたびに新しいリストを作る
    items.append(item)
    return items


print(add_bad("a"))
print(add_bad("b"))
print(add_bad.__defaults__)
print(add_good("a"))
print(add_good("b"))
出力
['a']
['a', 'b']
(['a', 'b'],)
['a']
['b']

add_bad("b") に前回の 'a' が残っています。デフォルト値は def の実行時に1回だけ評価されて保存され(__defaults__)、同じリストが使い回されるためです。

リスト・辞書・集合はデフォルト値に書かず None を使い、if items is None: で判定します(if not items: だと渡された空リストまで置き換わります)。add_good の型ヒントは次章で説明します(3.9 以前では動かない書き方です)。

4. 型ヒントと docstring

ex04_hints.py
def find_user(users: dict[int, str], user_id: int) -> str | None:
    """ユーザーIDから名前を探す。見つからなければ None を返す。"""
    return users.get(user_id)


def add(a: int, b: int) -> int:
    return a + b


print(find_user({1: "佐藤"}, 2))
print(add("1", "2"))  # 型ヒント違反でも実行時には止まらない
出力
None
12
  • 引数: 型 と -> 戻り値の型 が 型ヒント。str | None は「str または None」
  • 古いコードでは同じ意味を Optional[str]・Dict[int, str](typing から import)と書いていることが多い
  • 実行時には強制されない(add("1", "2") は文字列連結で 12)。検査は mypy などで行う
  • 関数直後の三重引用符の文字列が docstring(Javadoc に相当)

使っている Python が 3.9 以前の場合

  • str | None は 3.10 以降の書き方で、3.9 では def の行が TypeError: unsupported operand type(s) for |: 'type' and 'NoneType' で落ちます。Optional[str] で書くか、ファイル先頭に from __future__ import annotations(型ヒントを評価しない指定)を置きます
  • list[str] は 3.9 から使えます
  • 3.14 では型ヒントが必要になるまで評価されないため、新しいコードに from __future__ import annotations は基本的に不要です

5. スコープ:global が必要になる場面

ex05_scope.py
count = 0


def increment_wrong():
    count = count + 1  # 代入があるので count はローカル変数扱い


def increment():
    global count
    count += 1


try:
    increment_wrong()
except UnboundLocalError as e:
    print(e)
increment()
print(count)

for i in range(3):
    last = i
print(i, last)  # for を抜けても見える
出力
cannot access local variable 'count' where it is not associated with a value
1
2 2
  • 関数内で代入した変数は、関数全体でローカル扱いになる。グローバル変数に代入するには global が必要(読むだけ・リストの中身を変えるだけなら不要)
  • if や for はスコープを作らない。スコープの単位は関数・クラス・モジュール

3.9 ではこの文言が local variable 'count' referenced before assignment です。古い環境のログを検索するときは注意してください。

6. ラムダと「関数を引数に渡す」

関数も値なので引数に渡せます。典型例は sorted() の key です。

ex06_lambda.py
users = [("佐藤", 30), ("鈴木", 25), ("高橋", 35)]

print(sorted(users, key=lambda u: u[1]))

words = ["banana", "apple", "Cherry"]
print(sorted(words))
print(sorted(words, key=str.lower))  # 括弧なしで関数そのものを渡す
出力
[('鈴木', 25), ('佐藤', 30), ('高橋', 35)]
['Cherry', 'apple', 'banana']
['apple', 'banana', 'Cherry']
  • lambda 引数: 式 は式1つだけの無名関数(Java の u -> u.getAge())。key= は Comparator.comparing(...) と同じ発想
  • str.lower のように括弧なしで書けば関数そのものを渡せる(メソッド参照に近い)

7. 例外

try / except / else / finally と raise

ex07_try.py
class ConfigError(Exception):
    """設定の問題を表す例外"""


def read_port(text):
    try:
        port = int(text)
    except ValueError as e:
        raise ConfigError(f"port が不正です: {text}") from e
    else:
        print("変換成功")  # 例外が起きなかったときだけ通る
        return port
    finally:
        print("finally は必ず通る")


for text in ["8080", "80a"]:
    try:
        print(read_port(text))
    except ConfigError as e:
        print("エラー:", e, "/ 原因:", repr(e.__cause__))
出力
変換成功
finally は必ず通る
8080
finally は必ず通る
エラー: port が不正です: 80a / 原因: ValueError("invalid literal for int() with base 10: '80a'")
  • catch → except、throw new → raise。else は try が成功したときだけ通る
  • 自作例外は Exception を継承する。raise ... from e は new XxxException(msg, cause) と同じ原因の連鎖

Python には throws も検査例外もありません。何が投げられうるかは docstring や公式ドキュメントで確かめます。

except Exception で握りつぶす危険

ex08_swallow.py
def calc_average(values):
    try:
        return sum(values) / len(values)
    except Exception:
        return 0  # どんな例外も 0 にしてしまう


print(calc_average([10, 20]))
print(calc_average([]))            # ゼロ除算が 0 に化ける
print(calc_average(["10", "20"]))  # 型の間違い(バグ)まで 0 に化ける
print(issubclass(KeyboardInterrupt, Exception))
出力
15.0
0
0
False

3つ目はバグなのに静かに 0 が返ります。「結果がおかしいのにエラーが出ない」ときは、まず except Exception: や素の except: を探しましょう。後者は BaseException まで捕まえるので Ctrl+C(KeyboardInterrupt)も止められません。想定内のケースは if で分岐し、想定外の例外は表に出します。

トレースバックは下から読む

trace_demo.py
def load(path):
    return int(path)


load("config.txt")
出力(ファイルパスは .../ に省略)
Traceback (most recent call last):
  File ".../trace_demo.py", line 5, in <module>
    load("config.txt")
    ~~~~^^^^^^^^^^^^^^
  File ".../trace_demo.py", line 2, in load
    return int(path)
ValueError: invalid literal for int() with base 10: 'config.txt'

最後の行が例外の内容、その直前が発生箇所です。Java のスタックトレースとは向きが逆です。~~~~^^^^ の行は問題の式を指す印で、行全体が該当するときは省略されます(3.10 以前には無い行です)。

8. with 文:Java の try-with-resources

ex09_with.py
with open("sample.txt", "w", encoding="utf-8") as f:
    f.write("1行目\n2行目\n")

try:
    with open("sample.txt", encoding="utf-8") as f:
        print(f.readline().rstrip())
        raise RuntimeError("処理中にエラー")
except RuntimeError as e:
    print(e, "/ closed =", f.closed)
出力
1行目
処理中にエラー / closed = True

with を抜けると、例外でもファイルが自動で閉じられます。AutoCloseable に当たるのが __enter__ / __exit__ メソッドです。encoding を省略すると 3.14 までは OS 既定の文字コードになり、Windows では文字化けの原因になるので明示します。

9. クラスは「読める」ところまで

ex10_class.py
class User:
    def __init__(self, name, age=0):  # コンストラクタ
        self.name = name  # フィールド宣言は不要
        self.age = age

    def greet(self):
        return f"{self.name}({self.age}歳)です"


class Admin(User):  # 継承
    def greet(self):  # オーバーライド
        return super().greet() + "(管理者)"


print(User("佐藤", 30).greet())  # new は書かない
print(Admin("高橋", 40).greet())
print(isinstance(Admin("鈴木"), User))
出力
佐藤(30歳)です
高橋(40歳)です(管理者)
True
  • this に当たる self は省略できず、定義の第1引数に書く(呼ぶ側は渡さない)
  • private は無く、先頭 _ で「内部用」と示す慣習だけ
  • @dataclass 付きのクラスは __init__ などが自動生成される(record に近い)

10. モジュールと import

Python では 1ファイル = 1モジュール です。project/ に4ファイルを置いて試します。

calc.py
print(f"calc を読み込みました(__name__ = {__name__})")


def with_tax(price):
    return price * 110 // 100
helpers/text.py
def shout(text):
    return text.upper() + "!"
helpers/__init__.py
# 空ファイルでよい
main.py
import calc                     # calc.with_tax() と呼ぶ
from calc import with_tax       # with_tax() と名前だけで呼ぶ
import calc as c                # 別名を付ける
from helpers.text import shout  # パッケージ内のモジュールから取り込む

print(calc.with_tax(1000), with_tax(2000), c.with_tax(500))
print(shout("hello"))
$ cd project
$ python3 main.py
calc を読み込みました(__name__ = calc)
1100 2200 550
HELLO!
  • import するとモジュールのトップレベルが実行される。3回 import しても print は1回(2回目以降は読み込み済みを再利用)
  • __init__.py を置いたフォルダが パッケージ(無くても import できるが、置くのが一般的)
  • import の探索先(sys.path)の先頭は、実行したスクリプトのフォルダ

11. if __name__ == "__main__": はツールの入口

greeting.py
def main():
    print("main を実行しました")


print(f"__name__ = {__name__}")

if __name__ == "__main__":
    main()
$ python3 greeting.py
__name__ = __main__
main を実行しました
$ python3 -c "import greeting"
__name__ = greeting

__name__ には、直接実行なら "__main__"、import ならモジュール名が入ります。つまり「直接実行されたときだけ main() を呼ぶ」入口で、Java の main メソッドに当たります。既存ツールはまずこの行を検索し、呼ばれる関数をたどるのが近道です。

Java との対比まとめ

項目 Java Python
戻り値なし void return 省略で None
オーバーロード できる できない。デフォルト値・キーワード引数で代用
型チェック コンパイル時に強制 型ヒントは実行時に強制されない
例外 throw / catch raise / except
検査例外 あり(throws) なし
リソース解放 try-with-resources with 文
ブロックスコープ if / for ごとにある 無い(関数単位)
自分自身 this(省略可) self(省略不可)
入口 public static void main if __name__ == "__main__":

Java の switch に当たるのは match 文です。

ex11_match.py
def status_text(code: int) -> str:
    match code:
        case 200:
            return "OK"
        case 404 | 410:  # どちらかに一致
            return "見つからない"
        case _:  # default に当たる
            return "その他"


print(status_text(200), status_text(410), status_text(500))
出力
OK 見つからない その他

フォールスルーは無く break も不要です。3.10 以降の構文なので、3.9 以前では if / elif で書きます。

確認問題

問1 何が表示されるか

難易度:⭐

q1.py
def count_word(word, counter={}):
    counter[word] = counter.get(word, 0) + 1
    return counter


count_word("a")
count_word("b")
print(count_word("a"))
模範解答
出力
{'a': 2, 'b': 1}

デフォルト値の {} は定義時に1回だけ作られ、共有されます。counter=None にして関数内で辞書を作れば {'a': 1} になります。

問2 何が表示されるか

難易度:⭐

q2.py
def sign(x):
    if x > 0:
        return "正"
    elif x < 0:
        return "負"


print(sign(5), sign(-3), sign(0))
模範解答
出力
正 負 None

x == 0 ではどの return も通らず None が返ります。Java なら「return文が指定されていません」でコンパイルエラーになるケースです。

問3 何が表示されるか

難易度:⭐⭐

q3.py
class AppError(Exception):
    pass


class RetryableError(AppError):
    pass


try:
    raise RetryableError("timeout")
except AppError as e:
    print("AppError:", e)
except RetryableError as e:
    print("RetryableError:", e)
模範解答
出力
AppError: timeout

except は上から判定され、最初に一致したものだけが実行されます。Java ならコンパイルエラー(例外はすでに捕捉されています)ですが、Python は何も言いません。子クラスを先に書きます。

まとめ

既存ツールを読むときは、ミュータブルなデフォルト引数・except Exception の握りつぶし・入口の if __name__ == "__main__": の3つを必ず意識しましょう。

次回は 第3回:Excel の管理表と pom.xml を突き合わせて、差分を GUI に出すツールを作る。openpyxl で Excel を、標準ライブラリで pom.xml を読み、tkinter の画面に結果を出します。

参考


@kotaro_ai_lab
AI活用や開発効率化について発信しています。フォローお気軽にどうぞ!

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?