Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not obvious that new required attrs of sys.implementation must have a PEP. #81465

Closed
ericsnowcurrently opened this issue Jun 14, 2019 · 6 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes docs Documentation in the Doc dir easy

Comments

@ericsnowcurrently
Copy link
Member

BPO 37284
Nosy @ericsnowcurrently, @csabella, @miss-islington, @potomak
PRs
  • bpo-37284: Add note to sys.implementation doc #14328
  • [3.8] bpo-37284: Add note to sys.implementation doc (GH-14328) #14783
  • [3.7] bpo-37284: Add note to sys.implementation doc (GH-14328) #14784
  • 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 = <Date 2019-07-15.14:47:22.774>
    created_at = <Date 2019-06-14.18:02:41.302>
    labels = ['easy', '3.7', '3.8', '3.9', 'docs']
    title = 'Not obvious that new required attrs of sys.implementation must have a PEP.'
    updated_at = <Date 2019-07-15.14:47:52.716>
    user = 'https://github.com/ericsnowcurrently'

    bugs.python.org fields:

    activity = <Date 2019-07-15.14:47:52.716>
    actor = 'eric.snow'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2019-07-15.14:47:22.774>
    closer = 'eric.snow'
    components = ['Documentation']
    creation = <Date 2019-06-14.18:02:41.302>
    creator = 'eric.snow'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 37284
    keywords = ['patch', 'easy']
    message_count = 6.0
    messages = ['345624', '346313', '347964', '347965', '347966', '347967']
    nosy_count = 5.0
    nosy_names = ['docs@python', 'eric.snow', 'cheryl.sabella', 'miss-islington', 'potomak']
    pr_nums = ['14328', '14783', '14784']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue37284'
    versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

    @ericsnowcurrently
    Copy link
    Member Author

    PEP-421 added sys.implementation for Python implementors to provide values required by stdlib code (e.g. importlib). That PEP indicates that any new required attributes must go through the PEP process. [1] That requirement isn't obvious.

    To fix that we should add a brief note to the sys.implementation docs [2] identifying the requirement.

    [1] https://www.python.org/dev/peps/pep-0421/#adding-new-required-attributes
    [2] https://docs.python.org/3/library/sys.html#sys.implementation

    @ericsnowcurrently ericsnowcurrently added 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes labels Jun 14, 2019
    @ericsnowcurrently ericsnowcurrently added docs Documentation in the Doc dir easy labels Jun 14, 2019
    @potomak
    Copy link
    Mannequin

    potomak mannequin commented Jun 23, 2019

    Hi,

    I'd like to claim this task if nobody else already started working on it.

    @miss-islington
    Copy link
    Contributor

    New changeset 52693c1 by Miss Islington (bot) (Giovanni Cappellotto) in branch 'master':
    bpo-37284: Add note to sys.implementation doc (GH-14328)
    52693c1

    @miss-islington
    Copy link
    Contributor

    New changeset 134f796 by Miss Islington (bot) in branch '3.7':
    bpo-37284: Add note to sys.implementation doc (GH-14328)
    134f796

    @miss-islington
    Copy link
    Contributor

    New changeset 1ff4c42 by Miss Islington (bot) in branch '3.8':
    bpo-37284: Add note to sys.implementation doc (GH-14328)
    1ff4c42

    @ericsnowcurrently
    Copy link
    Member Author

    @potomak, thanks for doing this!

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes docs Documentation in the Doc dir easy
    Projects
    None yet
    Development

    No branches or pull requests

    2 participants