python / python/cpython

inspect.getdoc could examine the __class__ cell for dynamically generated subclasses

Open
#82,784 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.9 (EOL) stdlib
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 38603
Nosy @1st1, @anntzer
PRs
  • python/cpython#16957
  • 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-10-27.15:24:34.311>
    labels = ['library', '3.9']
    title = 'inspect.getdoc could examine the __class__ cell for dynamically generated subclasses'
    updated_at = <Date 2019-11-24.20:44:00.320>
    user = 'https://github.com/anntzer'
    

    bugs.python.org fields:

    activity = <Date 2019-11-24.20:44:00.320>
    actor = 'BTaskaya'
    assignee = 'none'
    closed = False
    closed_date = None
    closer = None
    components = ['Library (Lib)']
    creation = <Date 2019-10-27.15:24:34.311>
    creator = 'Antony.Lee'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 38603
    keywords = ['patch']
    message_count = 1.0
    messages = ['355472']
    nosy_count = 2.0
    nosy_names = ['yselivanov', 'Antony.Lee']
    pr_nums = ['16957']
    priority = 'normal'
    resolution = None
    stage = 'patch review'
    status = 'open'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue38603'
    versions = ['Python 3.9']
    

    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 by reading the implementation and tests for inspect.getdoc in the CPython repository, then review the linked pull request python/cpython#16957 for the prior approach. Reproduce the dynamically generated subclass case described in the issue and confirm that the resulting documentation is examined through the class cell.

    Written by the indexing model from the issue text.

    Assessment

    Tech stack
    python
    Domain
    tooling
    Issue type
    Bug
    Difficulty
    3/5
    Estimated time
    1-2 days
    Activity status
    Stale
    Clarity
    Mostly clear
    Newbie friendliness
    25/100

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.