# `contextvars` --- コンテキスト変数

このモジュールは、コンテキストローカルな状態を管理し、保持し、アクセスするための API を提供します。 `ContextVar` クラスは コンテキスト変数 を宣言し、取り扱うために使われます。 非同期フレームワークで現時点のコンテキストを管理するのには、 `copy_context()` 関数と `Context` クラスを使うべきです。

Context managers that have state should use Context Variables instead of `threading.local()` to prevent their state from bleeding to other code unexpectedly, when used in concurrent code.

より詳しくは PEP 567 を参照をしてください。

Added in version 3.7.

## コンテキスト変数

class contextvars.ContextVar(name[, *, default])

  このクラスは新しいコンテキスト変数を宣言するのに使われます。例えば、次の通りです:

      var: ContextVar[int] = ContextVar('var', default=42)

  必須のパラメータの name は内観やデバッグの目的で使われます。

  オプションのキーワード専用引数 default は、現在のコンテキストにその変数の値が見付からなかったときに `ContextVar.get()` から返されます。

  重要: コンテキスト変数は、モジュールのトップレベルで生成する必要があり、クロージャの中で作成すべきではありません。`Context` オブジェクトはコンテキスト変数への強参照を持っており、コンテキスト変数がガーベジコレクトされるのを防ぎます。

  name

    変数の名前。読み出し専用のプロパティです。

    Added in version 3.7.1.

  get([default])

    現在のコンテキストのコンテキスト変数の値を返します。

    現在のコンテキストのコンテキスト変数に値がなければ、メソッドは:

    - メソッドの default 引数に値が指定されていればその値を返します。さもなければ

    - コンテキスト変数が生成された時にデフォルト値が渡されていれば、その値を返します。さもなければ

    - `LookupError` を送出します。

  set(value)

    現在のコンテキストのコンテキスト変数に新しい値を設定する際に呼び出します。

    value は必須の引数で、コンテキスト変数の新しい値を指定します。

    `Token` オブジェクトを返します。このオブジェクトを `ContextVar.reset()` メソッドに渡すことで、以前の値に戻すことができます。

    For convenience, the token object can be used as a context manager to avoid calling `ContextVar.reset()` manually:

        var = ContextVar('var', default='default value')

        with var.set('new value'):
            assert var.get() == 'new value'

        assert var.get() == 'default value'

    It is a shorthand for:

        var = ContextVar('var', default='default value')

        token = var.set('new value')
        try:
            assert var.get() == 'new value'
        finally:
            var.reset(token)

        assert var.get() == 'default value'

    Added in version 3.14: Added support for using tokens as context managers.

  reset(token)

    コンテキスト変数の値を、 token を生成した `ContextVar.set()` が呼び出される前の値にリセットします。

    例えば:

        var = ContextVar('var')

        token = var.set('new value')
        # code that uses 'var'; var.get() returns 'new value'.
        var.reset(token)

        # After the reset call the var has no value again, so
        # var.get() would raise a LookupError.

    The same token cannot be used twice.

class contextvars.Token

  Token objects are returned by the `ContextVar.set()` method. They can be passed to the `ContextVar.reset()` method to revert the value of the variable to what it was before the corresponding set. A single token cannot reset a context variable more than once.

  Tokens support the context manager protocol to automatically reset context variables. See `ContextVar.set()`.

  Added in version 3.14: Added support for usage as a context manager.

  var

    読み出し専用のプロパティです。トークンを生成した `ContextVar` オブジェクトを指します。

  old_value

    読み出し専用のプロパティです。このトークンを作成した `ContextVar.set()` メソッドの呼び出しの前に持っていた値に設定されています。もし呼び出しの前に値が設定されていなければ `Token.MISSING` を指します。

  MISSING

    `Token.old_value` で利用されるマーカーオブジェクトです。

## マニュアルでのコンテキスト管理

contextvars.copy_context()

  現在の `Context` オブジェクトのコピーを返します。

  次のスニペットは、現在のコンテキストのコピーを取得し、コンテキストに設定されているすべての変数とその値を表示します:

      ctx: Context = copy_context()
      print(list(ctx.items()))

  この関数の複雑性は O(1) です。つまり、少数のコンテキスト変数を持つコンテキストと多くの変数を持つコンテキストで同程度の速度で動作します。

class contextvars.Context

  `ContextVars` とその値の対応付け。

  `Context()` は、値を持たない空のコンテキストを生成します。現在のコンテキストのコピーを得るには、`copy_context()` 関数を利用します。

  Each thread has its own effective stack of `Context` objects. The current context is the `Context` object at the top of the current thread's stack. All `Context` objects in the stacks are considered to be entered.

  Entering a context, which can be done by calling its `run()` method, makes the context the current context by pushing it onto the top of the current thread's context stack.

  Exiting from the current context, which can be done by returning from the callback passed to the `run()` method, restores the current context to what it was before the context was entered by popping the context off the top of the context stack.

  Since each thread has its own context stack, `ContextVar` objects behave in a similar fashion to `threading.local()` when values are assigned in different threads.

  Attempting to enter an already entered context, including contexts entered in other threads, raises a `RuntimeError`.

  After exiting a context, it can later be re-entered (from any thread).

  Any changes to `ContextVar` values via the `ContextVar.set()` method are recorded in the current context. The `ContextVar.get()` method returns the value associated with the current context. Exiting a context effectively reverts any changes made to context variables while the context was entered (if needed, the values can be restored by re-entering the context).

  Context は、 `collections.abc.Mapping` インターフェースを実装します。

  run(callable, *args, **kwargs)

    Enters the Context, executes `callable(*args, **kwargs)`, then exits the Context. Returns callable's return value, or propagates an exception if one occurred.

    例:

        import contextvars

        var = contextvars.ContextVar('var')
        var.set('spam')
        print(var.get())  # 'spam'

        ctx = contextvars.copy_context()

        def main():
            # 'var' was set to 'spam' before
            # calling 'copy_context()' and 'ctx.run(main)', so:
            print(var.get())  # 'spam'
            print(ctx[var])  # 'spam'

            var.set('ham')

            # Now, after setting 'var' to 'ham':
            print(var.get())  # 'ham'
            print(ctx[var])  # 'ham'

        # Any changes that the 'main' function makes to 'var'
        # will be contained in 'ctx'.
        ctx.run(main)

        # The 'main()' function was run in the 'ctx' context,
        # so changes to 'var' are contained in it:
        print(ctx[var])  # 'ham'

        # However, outside of 'ctx', 'var' is still set to 'spam':
        print(var.get())  # 'spam'

  copy()

    コンテキストオブジェクトの浅いコピーを返します。

  var in context

    context に var の値が設定されていた場合 `True` を返します; そうでない場合は `False` を返します。

  context[var]

    `ContextVar` var の値を返します。コンテキストオブジェクト内で変数が設定されていない場合は、`KeyError` を送出します。

  get(var[, default])

    var がコンテキストオブジェクトの中に値を持てば、その値を返します。さもなければ、default を返します。default を指定していなければ、`None` を返します。

  iter(context)

    コンテキストオブジェクトに格納されている変数群のイテレータを返します。

  len(proxy)

    コンテキストオブジェクトに格納されている変数の数を返します。

  keys()

    コンテキストオブジェクト中のすべての変数のリストを返します。

  values()

    コンテキストオブジェクト中のすべての変数の値のリストを返します。

  items()

    コンテキストオブジェクト中のすべての変数について、変数とその値からなる2要素のタプルのリストを返します。

## asyncio サポート

コンテキスト変数は、追加の設定なしに `asyncio` をサポートします。例えば、次の単純なechoサーバーは、クライアントを扱う Task の中でリモートクライアントのアドレスが利用できるように、コンテキスト変数を利用します:

    import asyncio
    import contextvars

    client_addr_var = contextvars.ContextVar('client_addr')

    def render_goodbye():
        # The address of the currently handled client can be accessed
        # without passing it explicitly to this function.

        client_addr = client_addr_var.get()
        return f'Good bye, client @ {client_addr}\r\n'.encode()

    async def handle_request(reader, writer):
        addr = writer.transport.get_extra_info('socket').getpeername()
        client_addr_var.set(addr)

        # In any code that we call, it is now possible to get the
        # client's address by calling 'client_addr_var.get()'.

        while True:
            line = await reader.readline()
            print(line)
            if not line.strip():
                break

        writer.write(b'HTTP/1.1 200 OK\r\n')  # status line
        writer.write(b'\r\n')  # headers
        writer.write(render_goodbye())  # body
        writer.close()

    async def main():
        srv = await asyncio.start_server(
            handle_request, '127.0.0.1', 8081)

        async with srv:
            await srv.serve_forever()

    asyncio.run(main())

    # To test it you can use telnet or curl:
    #     telnet 127.0.0.1 8081
    #     curl 127.0.0.1:8081