なぜ例外処理が必要なのか

Question

Python実践入門という書籍のP223にこのようなコードがあるのですが、debug_context関数の中でtry文が使われている必要性がわかりません。

import logging
from contextlib import contextmanager

logger = logging.getLogger(__name__)
logger.addHandler(logging.StreamHandler())

# デフォルトをINFOレベルとし、DEBUGレベルのログは無視する
logger.setLevel(logging.INFO)

@contextmanager
def debug_context():
    level = logger.level
    try:
        # ログレベルを変更する
        logger.setLevel(logging.DEBUG)
        yield
    finally:
        # もとのログレベルに戻す
        logger.setLevel(level)

def main():
    logger.info('before: info log')
    logger.debug('before: debug log')

    # DEBUGログを見たい処理をwithブロック内で実行する
    with debug_context():
        logger.info('inside the block: info log')
        logger.debug('inside the block: debug log')

    logger.info('after: info log')
    logger.debug('after: debug log')

if __name__ == '__main__':
    main()

try文の中のコードで例外が起こるところが想像できないので以下のようなコードで十分なのではと思ったのですが、

@contextmanager
def debug_context():
    level = logger.level
    logger.setLevel(logging.DEBUG)
    yield
    logger.setLevel(level)

何か理由があったりするのでしょうか。実際にtry文を除いても期待通りに動作します。

Answer 1

想像ですが、関数名がdebug_contextなので、このブロックを入れても入れなくてもデバッグログを出力する以外は同じ動作がするようにしたいということではないでしょうか。withブロックを展開すると

level = logger.level
try:
    logger.setLevel(logging.DEBUG)
    logger.info('inside the block: info log')  # ここはユーザが自由に記述
    logger.debug('inside the block: debug log')  # ここはユーザが自由に記述
finally:
    logger.setLevel(level)

となるため、ユーザが自由に記述できる部分で例外が発生してしまうとそこで停止してしまいます。

Answer 2

withスイート中で例外が発生する可能性を考慮しているのでは。

from contextlib import contextmanager

@contextmanager
def spam1():
    try:
        print('try')
        yield
    finally:
        print('finally')
    
@contextmanager
def spam2():
    print('try')
    yield
    print('finally')

    
for spam in [spam1, spam2]:
    print('-'*48)
    try:
        with spam():
            print('with')
            raise Exception
    except Exception:
        print('exception')

実行結果 Wandbox

------------------------------------------------
try
with
finally
exception
------------------------------------------------
try
with
exception

Answer 3

実際にtry文を除いても期待通りに動作します。

それは例外を発生させるというテストをしていない（質問者さんがそのテストをできていない）からです。

try-finallyがない以下のコードを、REPLやjupyterのような環境でいいので実行してみてください

import logging
from contextlib import contextmanager

logger = logging.getLogger(__name__)
logger.addHandler(logging.StreamHandler())

# デフォルトをINFOレベルとし、DEBUGレベルのログは無視する
logger.setLevel(logging.INFO)

@contextmanager
def debug_context():
    level = logger.level
    # ログレベルを変更する
    logger.setLevel(logging.DEBUG)
    yield
    # もとのログレベルに戻す
    logger.setLevel(level)

print(logger.level)  # =>20

with debug_context():
    logger.debug('inside the block: debug log')
    raise RuntimeError

print(logger.level)  # =>10

---

try-finallyがないと

    # もとのログレベルに戻す
    logger.setLevel(level)

の部分が実行されず元のレベルに戻っていないことが確認できます。

Comments

[nouken]

@contextmanagerデコレータが__enter__と__exit__を勝手に作ってくれてyield前後は必ず実行されるものと思い込んでいました。回答ありがとうございました。