425587a110
gh-124385: Document and soft-deprecate PyLong_AS_LONG (GH-124386)
2024-09-27 23:40:50 +00:00
7d24ea9db3
gh-121277: Allow `.. versionadded:: next` in docs (GH-121278)
...
Make `versionchanged:: next`` expand to current (unreleased) version.
When a new CPython release is cut, the release manager will replace
all such occurences of "next" with the just-released version.
(See the issue for release-tools and devguide PRs.)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-09-25 23:30:40 +02:00
32119fc377
gh-118915: Add/fix docs entries for some new 3.13 C API (GH-124134)
2024-09-18 14:15:43 +02:00
4c6dca8292
gh-120389: Add PyLong_FromInt64() and PyLong_AsInt64() ( #120390 )
...
Add new functions to convert C <stdint.h> numbers from/to Python int:
* PyLong_FromInt32()
* PyLong_FromUInt32()
* PyLong_FromInt64()
* PyLong_FromUInt64()
* PyLong_AsInt32()
* PyLong_AsUInt32()
* PyLong_AsInt64()
* PyLong_AsUInt64()
2024-08-28 10:16:13 +00:00
ce4b9c8464
gh-121477: mention new PyLong_*Bytes() functions in PyLong_FromString() ( #121478 )
...
* gh-121477: mention new PyLong_*Bytes() functions in PyLong_FromString()
* Update Doc/c-api/long.rst
---------
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2024-08-17 09:13:31 +00:00
d91ac525ef
gh-122613: Document PyLong_GetInfo() (part of Limited API) (GH-#122280)
2024-08-03 13:20:10 +02:00
2894aa14f2
gh-121115: Skip __index__ in PyLong_AsNativeBytes by default (GH-121118)
2024-06-28 16:26:21 +01:00
61d3ab32da
gh-116560: Add PyLong_GetSign() public function ( #116561 )
...
Co-authored-by: Victor Stinner <vstinner@python.org>
2024-06-03 14:06:31 +02:00
b744fa5d3e
gh-111140: minor docs typos cleanup in the C example API calls. ( #118612 )
2024-05-05 21:43:42 +00:00
687616877b
gh-111140: PyLong_From/AsNativeBytes: Take *flags* rather than just *endianness* (GH-116053)
2024-04-05 16:21:16 +02:00
e39795f2cb
Docs: PyUnstable_Long_IsCompact() docs now mention PyLong_AsNativeBytes() ( #116634 )
2024-03-14 00:01:13 +01:00
fac99b8b0d
gh-111140: Improve PyLong_AsNativeBytes API doc example & improve the test ( #115380 )
...
This expands the examples to cover both realistic use cases for the API.
I noticed thing in the test that could be done better so I added those as well: We need to guarantee that all bytes of the result are overwritten and that too many are not written. Tests now pre-fills the result with data in order to ensure that.
Co-authored-by: Steve Dower <steve.dower@microsoft.com>
2024-02-22 03:27:16 +00:00
10756b10ff
gh-111140: Minor doc fixes for PyLong_AsNativeBytes (GH-115375)
2024-02-12 22:28:36 +00:00
7861dfd26a
gh-111140: Adds PyLong_AsNativeBytes and PyLong_FromNative[Unsigned]Bytes functions (GH-114886)
2024-02-12 20:13:13 +00:00
573acb30f2
gh-115172: Fix explicit index extries for the C API (GH-115173)
2024-02-11 12:23:30 +02:00
be436e08b8
gh-108444: Add PyLong_AsInt() public function ( #108445 )
...
* Rename _PyLong_AsInt() to PyLong_AsInt().
* Add documentation.
* Add test.
* For now, keep _PyLong_AsInt() as an alias to PyLong_AsInt().
2023-08-24 23:55:30 +02:00
fcc816dbff
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
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
93923793f6
GH-101291: Add low level, unstable API for pylong (GH-101685)
...
Co-authored-by: Petr Viktorin <encukou@gmail.com>
2023-05-21 14:45:48 +01:00
6ab463684b
GH-97950: Use new-style index directive ('object') ( #104158 )
...
* Uncomment object removal in pairindextypes
* Use new-style index directive ('object') - C API
* Use new-style index directive ('object') - Library
* Use new-style index directive ('object') - Reference
* Use new-style index directive ('object') - Tutorial
2023-05-04 13:04:41 +03:00
e244401ce5
[docs] Mention how to get/set a bigint PyLong via the C API ( #101270 )
...
We don't need direct C APIs to get at a bigint representation of PyLong but we
do want the few people who need to understand how.
Additional Author: CAM-Gerlach
2023-01-23 21:20:53 -08:00
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
03da5d0f5b
gh-59200: Clarify `PyLong_FromString` documentation (GH-94363)
2022-07-28 23:12:27 +01:00
897bc6f928
More minor fixes to C API docs (GH-31525)
...
* wording fixes in type.rst
* grammar and punctuation in sys.rst
* set: grammar fixes
* structures: capitalization fix
* grammar fixes for sequence
* objects: point to Py_TYPE instead of direct object access
* numbers: add more explicit Python equivalences
* method: add missing period
* memory: grammar fix
* mapping: grammar fixes
* long: grammar fix
* iter: fix grammar for PyAIter_Check
* init: grammar fix
2022-04-02 12:31:05 -07:00
315fc52db1
bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602)
...
I think that none of these API calls can fail, but only few of them are
documented as such. Add the sentence "This function always succeeds" (which is
the same already used e.g. by PyNumber_Check) to all of them.
2021-01-06 12:38:26 +01:00
9c84417122
bpo-41211: Doc: Fix PyLong_FromUnicodeObject (GH-21325)
...
It doesn't use PyUnicode_EncodeDecimal. It uses a private API instead.
2020-07-05 13:01:48 +09:00
e4f1fe6edb
bpo-41123: Remove PyLong_FromUnicode() (GH-21204)
2020-06-29 13:00:43 +09:00
20941de0dd
bpo-37999: Fix outdated __int__ and nb_int references in comments (GH-20449)
...
* Fix outdated __int__ and nb_int references in comments
* Also update C-API documentation
* Add back missing 'method' word
* Remove .. deprecated notices
2020-05-27 13:43:17 +01:00
47be7d0108
PyLong_AsLongLong() docs should say 'long long' ( #18082 )
2020-01-21 19:14:13 +00:00
a2ff283d51
bpo-27961: Replace PY_ULLONG_MAX with ULLONG_MAX (GH-17539)
2019-12-09 21:22:19 +01:00
1f9f69dd4c
bpo-27961: Replace PY_LLONG_MAX, PY_LLONG_MIN and PY_ULLONG_MAX with standard macros (GH-15385)
...
Use standard constants LLONG_MIN, LLONG_MAX and ULLONG_MAX.
2019-12-05 15:55:28 +01:00
25fc088607
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950)
...
Replace all *NULL* with ``NULL``.
2019-10-30 12:03:20 +02:00
1d8b04edfd
bpo-37599: Remove a vague statement in documentation of Integer Objects ( #14786 )
...
* Remove a vague statement in documentation
* Remove another vague sentence
A sentence starting with "So it should be possible..." shouldn't be in the docs either.
Co-Authored-By: Kyle Stanley <aeros167@gmail.com>
* Include the removal of the previous line
Co-Authored-By: Kyle Stanley <aeros167@gmail.com>
* Remove an extra space
2019-07-16 08:15:17 -07:00
dc2476500d
bpo-37170: Fix the cast on error in PyLong_AsUnsignedLongLongMask() (GH-13860)
2019-06-06 22:39:23 +02:00
cbb6484573
Doc: Replace the deprecated highlightlang directive by highlight. ( #13377 )
...
highlightlang is deprecated since April 2018 in Sphinx.
See https://github.com/sphinx-doc/sphinx/pull/4845
2019-05-17 15:25:34 +05:30
6a44f6eef3
bpo-36048: Use __index__() instead of __int__() for implicit conversion if available. (GH-11952)
...
Deprecate using the __int__() method in implicit conversions of Python
numbers to C integers.
2019-02-25 17:57:58 +02:00
5bb0005f9f
Make formatting of some return codes conforming to the general style. ( #5587 )
2018-02-09 13:31:19 +02:00
f5b04a360e
Document the error return of PyLong_As* APIs. ( #5396 )
...
Document the error return of PyLong_As* APIs.
A frequent Python C API usage error is neglecting to check the return
value and/or PyErr_Occurred().
2018-01-28 17:48:31 -08:00
26896f2832
bpo-29751: Improve PyLong_FromString documentation (GH-915)
2017-04-23 20:54:08 -07:00
159f97b2d7
Issue #28496 : Mark up constants 0, 1 and -1 that denote return values or
...
special input values as literal text.
2016-10-27 21:42:15 +03:00
1ecf7d204d
Issue #28496 : Mark up constants 0, 1 and -1 that denote return values or
...
special input values as literal text.
2016-10-27 21:41:19 +03:00
47ff0734b8
more PY_LONG_LONG to long long
2016-09-08 09:15:54 -07:00
c679227e31
Issue #1772673 : The type of `char*` arguments now changed to `const char*`.
2013-10-19 21:03:34 +03:00
caeb6bea9b
Merge with 3.2: Issue #17047 : removed doubled words in Doc/*,
...
Mac/*, and Tool/* found by Serhiy Storchaka and Matthew Barnett
2013-03-11 17:26:33 -04:00
65e69b3718
Issue #17047 : removed doubled words in Doc/*, Mac/*, and Tool/*
...
found by Serhiy Storchaka and Matthew Barnett
2013-03-11 17:23:46 -04:00
b8dc3ab08b
Issue #12965 : More PyLong_As* clarifications. Thanks Stefan Krah.
2012-06-23 12:12:52 +01:00
f0acfeeccf
Issue #12965 : Clean up C-API docs for PyLong_AsLongLong(AndOverflow); clarify that __int__ will be called for non-PyLongs
2012-06-23 11:14:22 +01:00
c9aa8425c4
Issue #12965 : Merge from 3.2.
2012-06-23 12:13:15 +01:00
93648f033b
Issue #12965 : Merge from 3.2.
2012-06-23 11:14:55 +01:00
766e62266e
Issue #12965 : Merge from 3.2
2012-06-23 10:49:36 +01:00
Petr Viktorin
Victor Stinner
Sergey B Kirpichev
Steve Dower
Gregory P. Smith
Serhiy Storchaka
F3eQnxN3RriK
Mark Shannon
Adam Turner
JustAnotherArchivist
Jelle Zijlstra
Antonio Cuni
Inada Naoki
Mark Dickinson
Keith Erskine
Sergey Fedoseev
sgal
Zackery Spytz
Stéphane Wirtel
csabella
Benjamin Peterson
Terry Jan Reedy