.. _contextmanager-generator-missing-cleanup:

contextmanager-generator-missing-cleanup / W0135
================================================

**Message emitted:**

``The context used in function %r will not be exited.``

**Description:**

*Used when a contextmanager is used inside a generator function and the cleanup is not handled.*

**Problematic code:**

.. literalinclude:: /data/messages/c/contextmanager-generator-missing-cleanup/bad.py
   :language: python

**Correct code:**

.. literalinclude:: /data/messages/c/contextmanager-generator-missing-cleanup/good.py
   :language: python


**Additional details:**

Instantiating and using a contextmanager inside a generator function can
result in unexpected behavior if there is an expectation that the context is only
available for the generator function. In the case that the generator is not closed or destroyed
then the context manager is held suspended as is.

This message warns on the generator function instead of the contextmanager function
because the ways to use a contextmanager are many.
A contextmanager can be used as a decorator (which immediately has ``__enter__``/``__exit__`` applied)
and the use of ``as ...`` or discard of the return value also implies whether the context needs cleanup or not.
So for this message, warning the invoker of the contextmanager is important.

The check can create false positives if ``yield`` is used inside an ``if-else`` block without custom cleanup. Use ``pylint: disable`` for these.

.. code-block:: python

    from contextlib import contextmanager

    @contextmanager
    def good_cm_no_cleanup():
        contextvar = "acquired context"
        print("cm enter")
        if some_condition:
            yield contextvar
        else:
            yield contextvar


    def good_cm_no_cleanup_genfunc():
        # pylint: disable-next=contextmanager-generator-missing-cleanup
        with good_cm_no_cleanup() as context:
            yield context * 2

**Related links:**

- `Rationale <https://discuss.python.org/t/preventing-yield-inside-certain-context-managers/1091>`_
- `CPython Issue <https://github.com/python/cpython/issues/81924#issuecomment-1093830682>`_


Created by the `basic <https://github.com/pylint-dev/pylint/blob/main/pylint/checkers/base/function_checker.py>`__ checker.