Skip to content

pickle's documentation is severely outdated #45877

Closed

Description

@avassalotti
BPO 1536
Nosy @avassalotti
Dependencies
  • bpo-655802: cPickle not always same as pickle
  • bpo-956303: Update pickle docs to describe format of persistent IDs
  • 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 = 'https://github.com/avassalotti'
    closed_at = <Date 2010-06-28.20:51:54.581>
    created_at = <Date 2007-12-01.19:04:21.309>
    labels = ['type-bug', 'docs']
    title = "pickle's documentation is severely outdated"
    updated_at = <Date 2010-06-28.20:51:54.579>
    user = 'https://github.com/avassalotti'

    bugs.python.org fields:

    activity = <Date 2010-06-28.20:51:54.579>
    actor = 'alexandre.vassalotti'
    assignee = 'alexandre.vassalotti'
    closed = True
    closed_date = <Date 2010-06-28.20:51:54.581>
    closer = 'alexandre.vassalotti'
    components = ['Documentation']
    creation = <Date 2007-12-01.19:04:21.309>
    creator = 'alexandre.vassalotti'
    dependencies = ['655802', '956303']
    files = []
    hgrepos = []
    issue_num = 1536
    keywords = []
    message_count = 3.0
    messages = ['58063', '58067', '108864']
    nosy_count = 1.0
    nosy_names = ['alexandre.vassalotti']
    pr_nums = []
    priority = 'normal'
    resolution = 'fixed'
    stage = 'needs patch'
    status = 'closed'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue1536'
    versions = []

    Activity

    1. avassalotti commented on Dec 1, 2007

      @avassalotti
      MemberAuthor

      The current documentation for the pickle module (and related modules) is
      outdated and should be updated. For example, the section "Pickling and
      unpickling extension types" 1 is not only confusing, but outright
      wrong. For Python 2.6, the documentation of cPickle should be updated to
      reflect the differences between the cPickle and pickle.py modules. It
      would be also be appropriate to note that cPickle is pending removal and
      should not be used anymore.

    2. self-assigned this
      on Dec 1, 2007
    3. avassalotti commented on Dec 1, 2007

      @avassalotti
      MemberAuthor

      [I just realized that dependencies in the tracker should go the other
      way around.]

    4. avassalotti commented on Jun 28, 2010

      @avassalotti
      MemberAuthor

      The new documentation for pickle in Python 3 fixes this.

      I still believe we should outline the differences between pickle.py and cPickle. But at this point, it's unlikely I will put the time to do it. Feel free to open a new issue if you want this to be done.

    5. transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    Labels

    docsDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or error

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions