python / python/cpython

How should contextmanager/ContextDecorator work with generators?

Open
#81,924 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

3.8 (EOL) docs
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 37743
Nosy @ncoghlan

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2019-08-01.23:33:04.730>
labels = ['3.8', 'docs']
title = 'How should contextmanager/ContextDecorator work with generators?'
updated_at = <Date 2019-09-03.10:21:10.928>
user = 'https://github.com/anntzer'

bugs.python.org fields:

activity = <Date 2019-09-03.10:21:10.928>
actor = 'Antony.Lee'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-08-01.23:33:04.730>
creator = 'Antony.Lee'
dependencies = []
files = []
hgrepos = []
issue_num = 37743
keywords = []
message_count = 2.0
messages = ['348878', '351074']
nosy_count = 1.0
nosy_names = ['ncoghlan']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue37743'
versions = ['Python 3.8']

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked BPO 37743 discussion and the existing documentation for contextmanager and ContextDecorator. Clarify the intended behavior when these utilities are used with generators, then update the relevant documentation once the behavior is decided.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.