Gregory P. Smith
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
Steve Dower
10756b10ff
gh-111140: Minor doc fixes for PyLong_AsNativeBytes (GH-115375)
2024-02-12 22:28:36 +00:00
Steve Dower
7861dfd26a
gh-111140: Adds PyLong_AsNativeBytes and PyLong_FromNative[Unsigned]Bytes functions (GH-114886)
2024-02-12 20:13:13 +00:00
Serhiy Storchaka
573acb30f2
gh-115172: Fix explicit index extries for the C API (GH-115173)
2024-02-11 12:23:30 +02:00
Victor Stinner
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
Serhiy Storchaka
fcc816dbff
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +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
Mark Shannon
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
Adam Turner
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
Gregory P. Smith
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
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
JustAnotherArchivist
03da5d0f5b
gh-59200: Clarify `PyLong_FromString` documentation (GH-94363)
2022-07-28 23:12:27 +01:00
Jelle Zijlstra
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
Antonio Cuni
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
Inada Naoki
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
Inada Naoki
e4f1fe6edb
bpo-41123: Remove PyLong_FromUnicode() (GH-21204)
2020-06-29 13:00:43 +09:00
Mark Dickinson
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
Keith Erskine
47be7d0108
PyLong_AsLongLong() docs should say 'long long' ( #18082 )
2020-01-21 19:14:13 +00:00
Sergey Fedoseev
a2ff283d51
bpo-27961: Replace PY_ULLONG_MAX with ULLONG_MAX (GH-17539)
2019-12-09 21:22:19 +01:00
Sergey Fedoseev
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
Serhiy Storchaka
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
sgal
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
Zackery Spytz
dc2476500d
bpo-37170: Fix the cast on error in PyLong_AsUnsignedLongLongMask() (GH-13860)
2019-06-06 22:39:23 +02:00
Stéphane Wirtel
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
Serhiy Storchaka
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
Serhiy Storchaka
5bb0005f9f
Make formatting of some return codes conforming to the general style. ( #5587 )
2018-02-09 13:31:19 +02:00
Gregory P. Smith
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
csabella
26896f2832
bpo-29751: Improve PyLong_FromString documentation (GH-915)
2017-04-23 20:54:08 -07:00
Serhiy Storchaka
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
Serhiy Storchaka
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
Benjamin Peterson
47ff0734b8
more PY_LONG_LONG to long long
2016-09-08 09:15:54 -07:00
Serhiy Storchaka
c679227e31
Issue #1772673 : The type of `char*` arguments now changed to `const char*`.
2013-10-19 21:03:34 +03:00
Terry Jan Reedy
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
Terry Jan Reedy
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
Mark Dickinson
b8dc3ab08b
Issue #12965 : More PyLong_As* clarifications. Thanks Stefan Krah.
2012-06-23 12:12:52 +01:00
Mark Dickinson
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
Mark Dickinson
c9aa8425c4
Issue #12965 : Merge from 3.2.
2012-06-23 12:13:15 +01:00
Mark Dickinson
93648f033b
Issue #12965 : Merge from 3.2.
2012-06-23 11:14:55 +01:00
Mark Dickinson
766e62266e
Issue #12965 : Merge from 3.2
2012-06-23 10:49:36 +01:00
Mark Dickinson
0a22924d52
Issue #12965 : Clean up C-API docs for PyLong_AsLong(AndOverflow); clarify that __int__ will be called for non-PyLongs
2012-06-23 10:49:12 +01:00
Georg Brandl
db6c7f5c33
Update C API docs for PEP 393.
2011-10-07 11:19:11 +02:00
Georg Brandl
2aff335c36
#9204 : remove mentions of removed types in the types module.
2010-10-17 10:59:41 +00:00
Georg Brandl
60203b41b0
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
Georg Brandl
67b21b7547
Consistency check for versionadded/changed directives.
2010-08-17 15:07:14 +00:00
Ezio Melotti
ea30c6f5ee
Merged revisions 77850-77851 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/trunk
........
r77850 | ezio.melotti | 2010-01-30 15:08:54 +0200 (Sat, 30 Jan 2010) | 1 line
Relocate a couple of stars and remove redundant backticks
........
r77851 | ezio.melotti | 2010-01-30 15:27:05 +0200 (Sat, 30 Jan 2010) | 1 line
Use the correct markup for args
........
2010-01-30 13:32:14 +00:00
Mark Dickinson
93f562c4f9
Merged revisions 77842 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/trunk
........
r77842 | mark.dickinson | 2010-01-30 10:08:33 +0000 (Sat, 30 Jan 2010) | 4 lines
Issue #7767 : Add new C-API function PyLong_AsLongLongAndOverflow, a
long long variant of PyLong_AsLongAndOverflow. Patch by Case Van
Horsen.
........
2010-01-30 10:30:15 +00:00
Mark Dickinson
309aa2dcb4
Keep PyLong_AsLongAndOverflow documentation and implementation in sync
...
between py3k and trunk; merge new tests from trunk to py3k.
(See issue #7528.)
2009-12-21 12:37:06 +00:00
Jeroen Ruigrok van der Werven
b70ccc348b
After discussing some more with Georg, do no migrate versionchanged:: 2.5 to
...
this branch. While I am here, also get rid of other versionchanged:: 2.x
constructs, as discussed.
2009-04-27 08:07:12 +00:00
Jeroen Ruigrok van der Werven
bd87552a34
Merged revisions 71898-71900,71910,71914-71919 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/python/trunk
........
r71898 | jeroen.ruigrok | 2009-04-25 16:24:30 +0200 (za, 25 apr 2009) | 2 lines
Reformat prior to editing.
........
r71899 | jeroen.ruigrok | 2009-04-25 16:27:00 +0200 (za, 25 apr 2009) | 3 lines
The type for ppos has been Py_ssize_t since 2.5, reflect this in the
documentation.
........
r71900 | jeroen.ruigrok | 2009-04-25 16:28:02 +0200 (za, 25 apr 2009) | 2 lines
Reformat paragraph.
........
r71910 | jeroen.ruigrok | 2009-04-25 19:59:03 +0200 (za, 25 apr 2009) | 4 lines
Issue #4129 : Belatedly document which C API functions had their argument(s) or
return type changed from int or int * to Py_ssize_t or Py_ssize_t * as this
might cause problems on 64-bit platforms.
........
r71914 | jeroen.ruigrok | 2009-04-25 20:31:20 +0200 (za, 25 apr 2009) | 2 lines
Reformat prior to editing.
........
r71915 | jeroen.ruigrok | 2009-04-25 20:46:03 +0200 (za, 25 apr 2009) | 2 lines
Issue #4129 : Document more int -> Py_ssize_t changes.
........
r71916 | jeroen.ruigrok | 2009-04-25 20:53:48 +0200 (za, 25 apr 2009) | 2 lines
Reformat prior to editing.
........
r71917 | jeroen.ruigrok | 2009-04-25 20:57:32 +0200 (za, 25 apr 2009) | 2 lines
Reference to an int type, whereas it's a Py_ssize_t as the synopsis states.
........
r71918 | jeroen.ruigrok | 2009-04-25 21:04:15 +0200 (za, 25 apr 2009) | 2 lines
Since I edited this file, reformat for future edits.
........
r71919 | jeroen.ruigrok | 2009-04-25 21:10:52 +0200 (za, 25 apr 2009) | 2 lines
Reformat prior to editing.
........
2009-04-26 21:06:15 +00:00
Georg Brandl
5081f7e976
#5566 : remove duplicate entry.
2009-03-31 15:49:02 +00:00