This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Documentation for new Struct object
Type: Stage:
Components: Documentation Versions: Python 2.5
process
Status: closed Resolution: accepted
Dependencies: Superseder:
Assigned To: Nosy List: akuchling, bob.ippolito, georg.brandl, jimjjewett, nnorwitz, quiver
Priority: high Keywords: patch

Created on 2006-05-24 09:26 by bob.ippolito, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
structobject.txt bob.ippolito, 2006-05-24 15:35
structobject-1.txt bob.ippolito, 2006-05-25 14:32
libstruct.diff quiver, 2006-07-10 17:26 based on structobject-1.txt
libstruct.diff quiver, 2006-07-30 17:33 2006-07-31
Messages (13)
msg50338 - (view) Author: Bob Ippolito (bob.ippolito) * (Python committer) Date: 2006-05-24 09:26
The performance enhancements to the struct module (patch #1493701) 
are implemented by having a Struct object, which is a compiled structure. 
This text file documents these new struct objects.

msg50339 - (view) Author: Bob Ippolito (bob.ippolito) * (Python committer) Date: 2006-05-24 14:54
Logged In: YES 
user_id=139309

Hold up on this patch, I need to revise it.
msg50340 - (view) Author: Bob Ippolito (bob.ippolito) * (Python committer) Date: 2006-05-24 15:35
Logged In: YES 
user_id=139309

New patch attached, fixed unpack documentation, added unpack_from method.
msg50341 - (view) Author: Jim Jewett (jimjjewett) Date: 2006-05-24 21:03
Logged In: YES 
user_id=764593

Shouldn't self.size be the number of bytes required to *pack
* the structure?  The number required to *unpack* seems 
like it ought to include tuple overhead and such...
msg50342 - (view) Author: Bob Ippolito (bob.ippolito) * (Python committer) Date: 2006-05-25 14:32
Logged In: YES 
user_id=139309

That's clearly a typo. I've attached a new version of the patch that removes those 
two letters.
msg50343 - (view) Author: Bob Ippolito (bob.ippolito) * (Python committer) Date: 2006-05-26 13:05
Logged In: YES 
user_id=139309

We're going to need to revise this patch some more to document the new 
pack_to function (for Martin Blais' hotbuf work)

Additionally we'll probably also want to revise the main struct documentation to 
talk about bounds checking and avoiding the creation of long objects.
msg50344 - (view) Author: George Yoshida (quiver) (Python committer) Date: 2006-07-10 17:26
Logged In: YES 
user_id=671362

Patch for the TeX style doc.

Bob, can you work on updating the main section right after
2.5 b2?
msg50345 - (view) Author: A.M. Kuchling (akuchling) * (Python committer) Date: 2006-07-29 19:28
Logged In: YES 
user_id=11375

Does this patch still need to be updated for pack_to(), or can it just be 
applied?
msg50346 - (view) Author: George Yoshida (quiver) (Python committer) Date: 2006-07-30 17:33
Logged In: YES 
user_id=671362

> Does this patch still need to be updated for pack_to()
I suppose so and hence updated my patch.

(1) document pack_into(pack_to is renamed to pack_into).
(2) document pack_into/pack_from as module functions
too(just like re module)

As for the function name change, I've already updated
"what's new in 2.5" in r50985.

I guess the patch is ready to be applied. Reviews are
appreciated.
msg50347 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2006-08-02 07:38
Logged In: YES 
user_id=849994

New/renamed functions need a \versionadded/changed. For
StructObjects, I'd suggest a sentence like "Struct objects
are new in version 2.5" at the top of the section.

There's no explanation how to create a Struct object. The
constructor must be explained, preferably on the module
overview page. Isn't the type name "Struct"?
msg50348 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2006-10-29 09:28
Logged In: YES 
user_id=849994

What's the status of this? It should have been in 2.5 final...
msg50349 - (view) Author: Neal Norwitz (nnorwitz) * (Python committer) Date: 2007-01-04 06:55
Even if this only documents part of the API, it seems like it would be better to get that in and finish it off later.  Anyone know what's going on with this?
msg50350 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2007-02-15 11:30
I completed the patch and committed it as rev. 53785, 53786 (2.5).
History
Date User Action Args
2022-04-11 14:56:17adminsetgithub: 43401
2006-05-24 09:26:00bob.ippolitocreate