File: test_contextmanager.py

package info (click to toggle)
python-opentelemetry 1.39.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,952 kB
  • sloc: python: 53,083; sh: 398; makefile: 142; sql: 39
file content (68 lines) | stat: -rw-r--r-- 2,160 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# Copyright The OpenTelemetry Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import asyncio
import unittest
from typing import Callable, Iterator

from opentelemetry.util._decorator import _agnosticcontextmanager


@_agnosticcontextmanager
def cm() -> Iterator[int]:
    yield 3


@_agnosticcontextmanager
def cm_call_when_done(f: Callable[[], None]) -> Iterator[int]:
    yield 3
    f()


class TestContextManager(unittest.TestCase):
    def test_sync_with(self):
        with cm() as val:
            self.assertEqual(val, 3)

    def test_decorate_sync_func(self):
        @cm()
        def sync_func(a: str) -> str:
            return a + a

        res = sync_func("a")
        self.assertEqual(res, "aa")

    def test_decorate_async_func(self):
        # Test that a universal context manager decorating an async function runs it's cleanup
        # code after the entire async function coroutine finishes. This silently fails when
        # using the normal @contextmanager decorator, which runs it's __exit__() after the
        # un-started coroutine is returned.
        #
        # To see this behavior, change cm_call_when_done() to
        # be decorated with @contextmanager.

        events = []

        @cm_call_when_done(lambda: events.append("cm_done"))
        async def async_func(a: str) -> str:
            events.append("start_async_func")
            await asyncio.sleep(0)
            events.append("finish_sleep")
            return a + a

        res = asyncio.run(async_func("a"))
        self.assertEqual(res, "aa")
        self.assertEqual(
            events, ["start_async_func", "finish_sleep", "cm_done"]
        )