Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-04-15 08:11:10 +00:00
Code Issues Projects Releases Packages Wiki Activity
130703 commits 6 branches 653 tags 4.2 GiB
Commit graph

66 commits

Author SHA1 Message Date
Petr Viktorin
1114d7f7f8
gh-108907: ctypes: Document _type_ codes (GH-145837) 
Add `_SimpleCData._type_` docs.

Add type codes to the summary table.

Cross-link `struct`, `array`, and `ctypes`; throw in `numpy` too.
(Anyone wanting to add a code should be aware of those.)

Add `py_object`, and `VARIANT_BOOL` for completeness.
 2026-03-23 13:41:38 +01:00
Ned Batchelder
638d22c6e7
Docs: module pages should not link to themselves (#144505) 
* Docs: module pages should not link to themselves

* fix header punctuation
 2026-02-06 06:48:27 -05:00
Sergey B Kirpichev
d78768e3d6
gh-121249: fix complex formatting codes in the struct docs (note 10) (GH-133249) 
This amends 85f89cb.
 2025-05-02 18:27:07 +02:00
Sergey B Kirpichev
f425509349
gh-121249: unconditionally support complex types in struct (GH-132864) 
Co-authored-by: Lisandro Dalcin <dalcinl@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
 2025-05-02 18:24:52 +02:00
Sergey B Kirpichev
85f89cb3e6
gh-121249: adjust formatting codes for complex types in struct/ctypes (#132827) 
* F - for float _Complex
* D - for double _Complex
* G - for long double _Complex (not supported by the struct module)
 2025-04-23 15:38:24 +02:00
Sergey B Kirpichev
7487db4c7a
gh-121249: Support _Complex types in the struct module (#121613) 
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
 2024-10-07 13:53:02 +02:00
Sergey B Kirpichev
b0f462d4c8
gh-123110: correct note about _Bool in the struct module docs (GH-123111) 2024-08-18 16:58:58 +03:00
Ned Batchelder
bcb435ee8f
docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
Simon A. Eugster
177b9cb52e
Docs: Add explanation about little/big endian (#109841) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
 2024-02-18 23:50:09 -08:00
denballakh
e407cea193
gh-107406: Add better struct.Struct repr (#107407) 2023-08-26 15:24:16 +05:30
Serhiy Storchaka
f8b7fe2f26
gh-106948: Add standard external names to nitpick_ignore (GH-106949) 
It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH".
 2023-07-22 21:35:22 +03:00
F3eQnxN3RriK
a8ae73965b
gh-101100: Docs: Fix references to several numeric dunders (#106278) 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
 2023-06-30 15:27:09 +01:00
Rafael Fontenelle
68ed2a2a3f
GH-103484: Fix redirected permanently URLs (#104001) 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Oleg Iarygin <dralife@yandex.ru>
 2023-05-02 09:34:44 +03:00
Terry Jan Reedy
8f647477f0
Fix syntax error in struct doc example (#102160) 
Missing closing ) reported on Discuss by Chukwudi Nwachukwu.
 2023-02-22 18:55:03 -05:00
Peter Jiping Xie
db757f0e44
gh-101386: fix typos found by codespell (#101387) 2023-01-28 11:57:40 +02:00
Sandeep Subramanian
ac7a0a9f9e
GH-87002: fix caching documentation in struct module (#24164) 2022-12-31 22:27:58 +05:30
Skip Montanaro
22d91c16bb
gh-99146 struct module documentation should have more predictable examples/warnings (GH-99141) 
* nail down a couple examples to have more predictable output

* update a number of things, but this is really just a stash...

* added an applications section to describe typical uses for native and machine-independent formats

* make sure all format strings use a format prefix character

* responding to comments from @gpshead. Not likely finished yet.

* This got more involved than I expected...

* respond to several PR comments
* a lot of wordsmithing
* try and be more consistent in use of ``x`` vs ``'x'``
* expand examples a bit
* update the "see also" to be more up-to-date
* original examples relied on import * so present all examples as if

* reformat based on @gpshead comment (missed before)

* responding to comments

* missed this

* one more suggested edit

* wordsmithing
 2022-11-22 18:06:36 +00:00
Stanley
8cd21c2c5d
gh-65002: Make note that null bytes are used to pad bytes (#98635) 2022-10-28 12:21:28 +02:00
Adam Turner
0031e62973
gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (#97768) 
:c:type:`<C type>` -> :c:expr:`<C type>`

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
 2022-10-05 11:01:14 -07:00
Ned Batchelder
3440d197a5
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) 
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
 2022-07-05 11:16:10 +02:00
Oleg Iarygin
f62ff97f31
gh-93851: Fix all broken links in Doc/ (GH-93853) 2022-06-21 20:55:18 +02:00
CAM Gerlach
a5ba0f4ebc
Doc: Update references and examples of old, unsupported OSes and uarches (GH-92791) 2022-06-09 15:55:06 +02:00
Stargirl Flowers
fb27187203
[doc] struct: update note about network byte order form to be more helpful (GH-22201) 
Update the sentence to provide some context on why network byte order is defined as big endian.
 2020-09-11 08:20:12 -07:00
Christophe Nanteuil
3c5dec65e9
Remove redundant references in struct doc (GH-18053) 2020-02-10 12:17:54 -08:00
Sergey Fedoseev
a38e9d1399 bpo-27961: Remove leftovers from the times when long long wasn't required (GH-15388) 2019-08-22 16:28:28 +01:00
Pablo Galindo
54edb04aa6 bpo-37134: Add PEP570 notation to the documentation (GH-13743) 2019-06-05 13:24:28 -07:00
Serhiy Storchaka
913876d824
bpo-35054: Add yet more index entries for symbols. (GH-10121) 2018-10-28 13:41:26 +02:00
Serhiy Storchaka
ddb961d2ab
bpo-35054: Add more index entries for symbols. (GH-10064) 2018-10-26 09:00:49 +03:00
Zackery Spytz
3666b3c1f6 bpo-33032: Mention the implicit cache in struct.Struct() docs (GH-7700) 
Mention the implicit cache in struct.Struct() docs.

Consistent with the re.compile documentation note.
 2018-09-10 21:37:33 -07:00
Xiang Zhang
c10b288f34
bpo-30249: Improve struct.unpack_from() error messages (GH-6059) 2018-03-11 02:58:52 +08:00
Victor Stinner
f87b85f808 bpo-21071: struct.Struct.format type is now str (#845) 2017-06-23 15:11:12 +02:00
Victor Stinner
3f2d10132d Issue #29300: Convert _struct module to Argument Clinic 
* The struct module now requires contiguous buffers.
* Convert most functions and methods of the _struct module to Argument Clinic
* Use "Py_buffer" type for the "buffer" argument. Argument Clinic is
  responsible to create and release the Py_buffer object.
* Use "PyStructObject *" type for self to avoid explicit conversions.
* Add an unit test on the _struct.Struct.unpack_from() method to test passing
  arguments as keywords.
* Rephrase docstrings.
* Rename "fmt" argument to "format" in docstrings and the documentation.

As a side effect, functions and methods which used METH_VARARGS calling
convention like struct.pack() now use the METH_FASTCALL calling convention
which avoids the creation of temporary tuple to pass positional arguments and
so is faster. For example, struct.pack("i", 1) becomes 1.56x faster (-36%)::

    $ ./python -m perf timeit \
        -s 'import struct; pack=struct.pack' 'pack("i", 1)' \
        --compare-to=../default-ref/python
    Median +- std dev: 119 ns +- 1 ns -> 76.8 ns +- 0.4 ns: 1.56x faster (-36%)
    Significant (t=295.91)

Patch co-written with Serhiy Storchaka.
 2017-02-02 12:09:30 +01:00
Yury Selivanov
3479b5f888 Issue #28635: Fix a couple of missing/incorrect versionchanged tags 
Patch by Elvis Pranskevichus.
 2016-11-10 13:25:26 -05:00
Mark Dickinson
7c4e409d07 Issue #11734: Add support for IEEE 754 half-precision floats to the struct module. Original patch by Eli Stevens. 2016-09-03 17:21:29 +01:00
Terry Jan Reedy
fa089b9b0b Issue #22558: Add remaining doc links to source code for Python-coded modules. 
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
 2016-06-11 15:02:54 -04:00
Martin Panter
b030991a5f Issue #26535: Correct docs regarding the struct buffer size 2016-04-15 23:03:54 +00:00
Georg Brandl
f30132fdc9 #22613: explain what "buffer" is in the struct documentation (thanks Jacques Ducasse) 2014-10-31 09:46:41 +01:00
Serhiy Storchaka
0e90e99188 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:19:53 +02:00
Serhiy Storchaka
fbc1c26803 Issue #19795: Improved markup of True/False constants. 2013-11-29 12:17:13 +02:00
Antoine Pitrou
9f14681959 Issue #17804: New function `struct.iter_unpack` allows for streaming struct unpacking. 2013-04-27 00:20:04 +02:00
Antoine Pitrou
45d9c91d4b Issue #3163: The struct module gets new format characters 'n' and 'N' 
supporting C integer types `ssize_t` and `size_t`, respectively.
 2011-10-06 15:27:40 +02:00
Senthil Kumaran
ad3882a2b0 Fix closes Issue11436 - Minor clarification to struct documentation for 's' format character. 2011-07-17 17:29:17 +08:00
Victor Stinner
da9ec995f6 Issue #10783: struct.pack() doesn't encode implicitly unicode to UTF-8 
* Replace "bytes" by "bytes object" in struct error messages
 * Document the API change in What's new in Python 3.2
 * Fix test_wave
 * Remove also ugly implicit conversions in test_struct
 2010-12-28 13:26:42 +00:00
Senthil Kumaran
916bd38a06 Fixing some sphinx inline directives - detected using `make check`. 2010-10-15 12:55:19 +00:00
Georg Brandl
60203b41b0 Migrate to Sphinx 1.0 C language constructs. 2010-10-06 10:11:56 +00:00
Georg Brandl
93eb42e805 Emphasize role of count for Pascal string. 2010-07-10 10:23:40 +00:00
Mark Dickinson
719e4e3ba5 Merged revisions 82379 via svnmerge from 
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r82379 | mark.dickinson | 2010-06-29 21:09:12 +0100 (Tue, 29 Jun 2010) | 1 line

  Issue #1789:  clarify that the 'size' column in struct docs refers to standard size.
........
 2010-06-29 20:10:42 +00:00
Mark Dickinson
cb532f13e3 Merged revisions 81992 via svnmerge from 
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r81992 | mark.dickinson | 2010-06-15 09:33:03 +0100 (Tue, 15 Jun 2010) | 3 lines

  Issue #8469:  Further clarifications and improvements to struct module
  documentation.  Thanks Mads Kiilerich.
........
 2010-06-15 08:42:37 +00:00
Mark Dickinson
cfd56f2dc6 Issue #8469: Reorder struct module sections for clarity; other minor tweaks. 2010-06-12 18:37:54 +00:00
Mark Dickinson
7a70b2c450 Issue #8469: add standard sizes to struct docs table. 2010-06-12 18:20:47 +00:00