コンテキストマネージャの作成

Python関数の書き方

Shayne Miel

Software Architect @ Duo Security

コンテキストマネージャの定義方法は2つ

クラスベース
関数ベース

コンテキストマネージャの定義方法は2つ

クラスベース
関数ベース *

コンテキストマネージャの作り方


def my_context():

  # Add any set up code you need

  yield

  # Add any teardown code you need

関数を定義する。
（任意）必要なセットアップコードを追加。
"yield" を使う。
（任意）必要なクリーンアップコードを追加。

コンテキストマネージャの作り方

@contextlib.contextmanager
def my_context():

  # Add any set up code you need

  yield

  # Add any teardown code you need

関数を定義する。
（任意）必要なセットアップコードを追加。
"yield" を使う。
（任意）必要なクリーンアップコードを追加。
`@contextlib.contextmanager` デコレータを付ける。

"yield" キーワード

@contextlib.contextmanager
def my_context():
  print('hello')
  yield 42
  print('goodbye')

with my_context() as foo:
  print('foo is {}'.format(foo))

hello
foo is 42
goodbye

セットアップとクリーンアップ

@contextlib.contextmanager
def database(url):
  # set up database connection
  db = postgres.connect(url)

  yield db

  # tear down database connection
  db.disconnect()

url = 'http://datacamp.com/data'
with database(url) as my_db:
  course_list = my_db.execute(
    'SELECT * FROM courses'
  )

セットアップとクリーンアップ

@contextlib.contextmanager
def database(url):
  # set up database connection
  db = postgres.connect(url)

  yield db

  # tear down database connection
  db.disconnect()

url = 'http://datacamp.com/data'
with database(url) as my_db:
  course_list = my_db.execute(
    'SELECT * FROM courses'
  )

セットアップとクリーンアップ

@contextlib.contextmanager
def database(url):
  # set up database connection
  db = postgres.connect(url)

  yield db

  # tear down database connection
  db.disconnect()

url = 'http://datacamp.com/data'
with database(url) as my_db:
  course_list = my_db.execute(
    'SELECT * FROM courses'
  )

値を渡すか、Noneを渡すか

@contextlib.contextmanager
def database(url):
  # set up database connection
  db = postgres.connect(url)

  yield db

  # tear down database connection
  db.disconnect()

url = 'http://datacamp.com/data'
with database(url) as my_db:
  course_list = my_db.execute(
    'SELECT * FROM courses'
  )

@contextlib.contextmanager
def in_dir(path):
  # save current working directory
  old_dir = os.getcwd()

  # switch to new working directory
  os.chdir(path)

  yield

  # change back to previous
  # working directory
  os.chdir(old_dir)

with in_dir('/data/project_1/'):
  project_files = os.listdir()

練習しましょう！

Python関数の書き方