Document whether it's safe to use bytes for struct format string

Open
#60,553 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the linked format-bytes.patch and dependency bpo-21071 to understand the bytes-versus-string behavior of struct.Struct.format. Locate the relevant struct documentation and confirm the intended safety guidance; done means the docs clearly state whether using bytes is supported and under what conditions.

Written by the indexing model from the issue text.

Description

extension-modules
BPO 16349
Nosy @rhettinger, @terryjreedy, @mdickinson, @tiran, @meadori, @takluyver, @vadmium, @serhiy-storchaka
Dependencies
  • bpo-21071: struct.Struct.format is bytes, but should be str
    		•
    Files
  • format-bytes.patch
    		•

    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 2012-10-28.12:43:42.567>
labels = ['extension-modules']
title = "Document whether it's safe to use bytes for struct format string"
updated_at = <Date 2017-04-29.02:46:51.063>
user = 'https://github.com/takluyver'

    bugs.python.org fields:

    activity = <Date 2017-04-29.02:46:51.063>
actor = 'martin.panter'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Extension Modules']
creation = <Date 2012-10-28.12:43:42.567>
creator = 'takluyver'
dependencies = ['21071']
files = ['37489']
hgrepos = []
issue_num = 16349
keywords = ['patch']
message_count = 13.0
messages = ['174042', '174083', '174584', '174680', '174682', '174711', '176681', '176701', '176702', '216656', '232767', '232858', '292554']
nosy_count = 9.0
nosy_names = ['rhettinger', 'terry.reedy', 'mark.dickinson', 'christian.heimes', 'Arfrever', 'meador.inge', 'takluyver', 'martin.panter', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue16349'
versions = ['Python 3.2', 'Python 3.3', 'Python 3.4']

    Dominant language
    Python
    Stars
    77.2k
    Forks
    36k
    Avg merge
    1d 9h
    Merged PRs (30d)
    558

    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.

    More from python/cpython

    All issues in python/cpython

    Similar issues

    More Python issues

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.