2d6f2eed14
bpo-36346: Document removal schedule of deprecate APIs (GH-20879)
...
We will remove wstr cache in Python 3.12. See PEP 623.
2021-02-23 08:06:51 +09: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
4b9aad4999
bpo-42236: Enhance init and encoding documentation (GH-23109)
...
Enhance the documentation of the Python startup, filesystem encoding
and error handling, locale encoding. Add a new "Python UTF-8 Mode"
section.
* Add "locale encoding" and "filesystem encoding and error handler"
to the glossary
* Remove documentation from Include/cpython/initconfig.h: move it to
Doc/c-api/init_config.rst.
* Doc/c-api/init_config.rst:
* Document command line options and environment variables
* Document default values.
* Add a new "Python UTF-8 Mode" section in Doc/library/os.rst.
* Add warnings to Py_DecodeLocale() and Py_EncodeLocale() docs.
* Document how Python selects the filesystem encoding and error
handler at a single place: PyConfig.filesystem_encoding and
PyConfig.filesystem_errors.
* PyConfig: move orig_argv member at the right place.
2020-11-02 16:49:54 +01:00
3a8fdb2879
bpo-41784: make PyUnicode_AsUTF8AndSize part of the limited API (GH-22252)
2020-10-19 23:17:50 +01:00
474652fe93
bpo-40204, doc: Fix syntax of C variables (GH-21846)
...
For example, fix the following Sphinx 3 errors:
Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters
Invalid C declaration: Expected identifier in nested name. [error at 5]
void \*obj
-----^
Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*'
Invalid C declaration: Expected end of definition. [error at 8]
PyObject*
--------^
The modified documentation is compatible with Sphinx 2 and Sphinx 3.
2020-08-13 22:11:50 +02:00
46d10b1237
bpo-40204: Fix duplicates in the documentation (GH-21857)
...
Fix two Sphinx 3 issues:
Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'.
Declaration is 'PyBUF_ND'.
Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'.
Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'.
2020-08-13 19:16:02 +02:00
270b4ad4df
bpo-36346: Doc: Update removal schedule of legacy Unicode (GH-21479)
...
See PEP 623 for detail.
2020-08-05 10:48:51 +09:00
b3332660ad
bpo-41123: Remove PyUnicode_AsUnicodeCopy (GH-21209)
2020-06-30 12:23:07 +09:00
f3e7ea5b8c
bpo-39500: Document PyUnicode_IsIdentifier() function (GH-18397)
...
PyUnicode_IsIdentifier() does not call Py_FatalError() anymore if the
string is not ready.
2020-02-11 14:29:33 +01:00
bf15d5b775
Correct the documented default encoding (GH-18429)
...
From the source for `PyUnicode_Decode`, the implementation is:
```
if (encoding == NULL) {
return PyUnicode_DecodeUTF8Stateful(s, size, errors, NULL);
}
```
which is pretty clearly not defaulting to ASCII.
---
I assume this needs neither a news entry nor bpo link.
2020-02-10 15:32:18 -08:00
d68b592dd6
bpo-38896: Remove PyUnicode_ClearFreeList() function (GH-17354)
...
Remove PyUnicode_ClearFreeList() function: the Unicode free list has
been removed in Python 3.3.
2019-11-23 02:30:32 +01:00
e835b31d2b
bpo-38600: NULL -> ``NULL``. (GH-17001)
...
Also fix some other formatting.
2019-10-30 21:37:16 +02: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
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
85225b6a58
bpo-31873: Update unicode.rst - 'unicode' capitalization (GH-4125)
...
Update 'unicode' capitalization. 'Unicode' is a proper noun, and as such should be capitalized.
Changed multiple instances.
2019-05-08 18:02:34 +02:00
f4b0a1c0da
bpo-31904: Add encoding support for VxWorks RTOS (GH-12051)
...
Use UTF-8 as the system encoding on VxWorks.
The main reason are:
1. The locale is frequently misconfigured.
2. Missing some functions to deal with locale in VxWorks C library.
2019-03-04 10:02:06 +01:00
57dd79e6f7
Fix documented signatures for C API functions. (GH-11236)
2018-12-19 15:31:40 +02:00
998b806366
Revert "bpo-34595: Add %T format to PyUnicode_FromFormatV() (GH-9080)" (GH-9187)
...
This reverts commit 886483e2b9
2018-09-12 00:23:25 +02:00
886483e2b9
bpo-34595: Add %T format to PyUnicode_FromFormatV() (GH-9080)
...
* Add %T format to PyUnicode_FromFormatV(), and so to
PyUnicode_FromFormat() and PyErr_Format(), to format an object type
name: equivalent to "%s" with Py_TYPE(obj)->tp_name.
* Replace Py_TYPE(obj)->tp_name with %T format in unicodeobject.c.
* Add unit test on %T format.
* Rename unicode_fromformat_write_cstr() to
unicode_fromformat_write_utf8(), to make the intent more explicit.
2018-09-07 18:00:58 +02:00
9089a26591
bpo-29240: PyUnicode_DecodeLocale() uses UTF-8 on Android ( #5272 )
...
PyUnicode_DecodeLocaleAndSize(), PyUnicode_DecodeLocale() and
PyUnicode_EncodeLocale() now use always use the UTF-8 encoding on
Android, instead of the current locale encoding.
On Android API 19, mbstowcs() and wcstombs() are broken and cannot be
used.
2018-01-22 19:07:32 +01:00
7ed7aead95
bpo-29240: Fix locale encodings in UTF-8 Mode ( #5170 )
...
Modify locale.localeconv(), time.tzname, os.strerror() and other
functions to ignore the UTF-8 Mode: always use the current locale
encoding.
Changes:
* Add _Py_DecodeLocaleEx() and _Py_EncodeLocaleEx(). On decoding or
encoding error, they return the position of the error and an error
message which are used to raise Unicode errors in
PyUnicode_DecodeLocale() and PyUnicode_EncodeLocale().
* Replace _Py_DecodeCurrentLocale() with _Py_DecodeLocaleEx().
* PyUnicode_DecodeLocale() now uses _Py_DecodeLocaleEx() for all
cases, especially for the strict error handler.
* Add _Py_DecodeUTF8Ex(): return more information on decoding error
and supports the strict error handler.
* Rename _Py_EncodeUTF8_surrogateescape() to _Py_EncodeUTF8Ex().
* Replace _Py_EncodeCurrentLocale() with _Py_EncodeLocaleEx().
* Ignore the UTF-8 mode to encode/decode localeconv(), strerror()
and time zone name.
* Remove PyUnicode_DecodeLocale(), PyUnicode_DecodeLocaleAndSize()
and PyUnicode_EncodeLocale() now ignore the UTF-8 mode: always use
the "current" locale.
* Remove _PyUnicode_DecodeCurrentLocale(),
_PyUnicode_DecodeCurrentLocaleAndSize() and
_PyUnicode_EncodeCurrentLocale().
2018-01-15 10:45:49 +01:00
e613e6add5
bpo-30708: Check for null characters in PyUnicode_AsWideCharString(). ( #2285 )
...
Raise a ValueError if the second argument is NULL and the wchar_t\*
string contains null characters.
2017-06-27 16:03:14 +03:00
88c38b32b7
bpo-28415: Note 0 conversion different between Python and C ( #885 )
2017-04-27 11:36:35 +08:00
84b8e92e46
bpo-29918: Add missed "const" modifiers in C API documentation. ( #846 )
2017-03-30 10:01:03 +03:00
c85a26628c
bpo-28749: Fixed the documentation of the mapping codec APIs. ( #487 )
...
Added the documentation for PyUnicode_Translate().
2017-03-19 08:15:17 +02:00
2a404b63d4
Issue #28769 : The result of PyUnicode_AsUTF8AndSize() and PyUnicode_AsUTF8()
...
is now of type "const char *" rather of "char *".
2017-01-22 23:07:07 +02:00
fc600834d8
Issue #29087 : Removed the documentation of non-existing UCS4 support functions.
2016-12-28 09:20:00 +02:00
44223e9550
Issue #29087 : Removed the documentation of non-existing UCS4 support functions.
2016-12-28 09:19:45 +02:00
af9181a4f2
Issue #29087 : Removed the documentation of non-existing UCS4 support functions.
2016-12-28 09:19:15 +02:00
b211068f5c
Issue #28822 : Adjust indices handling of PyUnicode_FindChar().
2016-12-20 22:52:33 +08:00
47888da90b
Issue #29009 : Merge 3.5.
2016-12-19 18:39:02 +08:00
bfbc29cb8f
Issue #29009 : Remove outdated doc of PyUnicode_RichCompare.
2016-12-19 18:35:14 +08:00
419967b832
Issue #28808 : PyUnicode_CompareWithASCIIString() now never raises exceptions.
2016-12-06 00:13:34 +02:00
9a953dbb34
Issue #28808 : PyUnicode_CompareWithASCIIString() now never raises exceptions.
2016-12-06 00:17:45 +02:00
01452af645
Issue #28750 : Fixed docs of of unicode-escape an raw-unicode-escape C API.
...
Patch by Xiang Zhang.
2016-11-20 17:21:04 +02:00
cf36835fc5
Issue #28750 : Fixed docs of of unicode-escape an raw-unicode-escape C API.
...
Patch by Xiang Zhang.
2016-11-20 17:20:19 +02:00
92b9a1f911
Issue #19569 : Suggested more appropriate replacements for deprecated Unicode
...
C API functions.
2016-11-20 12:14:08 +02:00
f675a37ed3
Issue #19569 : Suggested more appropriate replacements for deprecated Unicode
...
C API functions.
2016-11-20 12:13:44 +02:00
3b73ea1278
Issue #28701 : Replace PyUnicode_CompareWithASCIIString with _PyUnicode_EqualToASCIIString.
...
The latter function is more readable, faster and doesn't raise exceptions.
2016-11-16 10:19:20 +02:00
f4934ea77d
Issue #28701 : Replace PyUnicode_CompareWithASCIIString with _PyUnicode_EqualToASCIIString.
...
The latter function is more readable, faster and doesn't raise exceptions.
2016-11-16 10:17:58 +02: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
989db5c880
Issue #19795 : Mark up None as literal text.
2016-10-19 16:37:13 +03:00
ecf41da83e
Issue #19795 : Mark up None as literal text.
2016-10-19 16:29:26 +03:00
b8bddec4e0
Issue #28432 : Merge from 3.5
2016-10-17 00:46:37 +03:00
90e028970a
Issue #28432 : Fix first parameter name in PyUnicode_EncodeLocale documentation
...
Patch by Xiang Zhang.
2016-10-17 00:45:56 +03:00
21d9f10c94
Merge from 3.5.
2016-10-08 22:46:01 +03:00
9c0e1f83af
Issue #28379 : Added sanity checks and tests for PyUnicode_CopyCharacters().
...
Patch by Xiang Zhang.
2016-10-08 22:45:38 +03:00
b3648576cd
Issue #28295 : Fixed the documentation and added tests for PyUnicode_AsUCS4().
...
Original patch by Xiang Zhang.
2016-10-02 21:30:35 +03:00
cc164232aa
Issue #28295 : Fixed the documentation and added tests for PyUnicode_AsUCS4().
...
Original patch by Xiang Zhang.
2016-10-02 21:29:26 +03:00
cc16be85c0
Issue #27781 : Change file system encoding on Windows to UTF-8 (PEP 529)
2016-09-08 10:35:16 -07:00
47ff0734b8
more PY_LONG_LONG to long long
2016-09-08 09:15:54 -07:00
a571120410
Issue #27182 : Add support for path-like objects to PyUnicode_FSDecoder().
2016-09-06 19:36:01 -07:00
ec6ce879c7
Issue #26027 : Support path-like objects in PyUnicode-FSConverter().
...
This is to add support for os.exec*() and os.spawn*() functions. Part
of PEP 519.
2016-09-06 15:50:29 -07:00
ed4aa83ff7
require a long long data type ( closes #27961 )
2016-09-05 17:44:18 -07:00
544ae59b8e
Issue #18353 : Remove PyUnicode_WRITE_CHAR macro link from c-api/unicode.rst
...
Patch by Corey Brune.
2016-04-24 03:06:44 +03:00
6a7b3a77b4
Issue #26778 : Fixed "a/an/and" typos in code comment and documentation.
2016-04-17 08:32:47 +03:00
20d325574e
Issue #15984 : Correct PyUnicode_FromObject() and _FromEncodedObject() docs
2016-04-15 00:56:21 +00:00
6245cb3c01
Correct “an” → “a” with “Unicode”, “user”, “UTF”, etc
...
This affects documentation, code comments, and a debugging messages.
2016-04-15 02:14:19 +00:00
cd881b850c
Fixed documentation of functions with const char* arguments.
2015-06-21 17:12:16 +03:00
03863d2b29
Fixed documentation of functions with const char* arguments.
2015-06-21 17:11:21 +03:00
812bc1b86b
Merge: #23088 : Clarify null termination of bytes and strings in C API.
2015-05-13 20:32:19 -04:00
0a560a11af
#23088 : Clarify null termination of bytes and strings in C API.
...
Patch by Martin Panter, reviewed by Serhiy Storchaka and R. David Murray.
2015-05-13 20:31:53 -04:00
3be472b5f7
Closes #23181 : codepoint -> code point
2015-01-14 08:26:30 +01:00
92bf919ed0
Issue #22581 : Use more "bytes-like object" throughout the docs and comments.
2014-12-05 22:26:10 +02:00
b757c83ec6
Issue #22581 : Use more "bytes-like object" throughout the docs and comments.
2014-12-05 22:25:22 +02:00
8786ea36d0
(Merge 3.4) Closes #22580 : Fix documentation of PyUnicode_Tailmatch()
...
The result type is Py_ssize_t (and not int).
2014-10-09 11:11:49 +02:00
13d3aa502d
Closes #22580 : Fix documentation of PyUnicode_Tailmatch()
...
The result type is Py_ssize_t (and not int).
2014-10-09 11:11:25 +02:00
f6a271ae98
Issue #18395 : Rename ``_Py_char2wchar()`` to :c:func:`Py_DecodeLocale`, rename
...
``_Py_wchar2char()`` to :c:func:`Py_EncodeLocale`, and document these
functions.
2014-08-01 12:28:48 +02:00
102488b644
args doesn't need to be a tuple ( closes #17210 )
2014-07-19 16:34:33 -07:00
d3faf43f9b
Issue #23181 : More "codepoint" -> "code point".
2015-01-18 11:28:37 +02:00
780b585fbc
Quash extraneous quote.
2014-06-06 09:13:18 -05:00
d51f42372b
Issue 19195: Improved cross-references in C API documentation.
2013-10-09 13:26:57 +03:00
0b68a2d675
Issue 19195: Improved cross-references in C API documentation.
2013-10-09 13:26:17 +03:00
0738aff368
Fix a typo in PyUnicode_CopyCharacters() documentation.
2013-08-08 16:49:45 +03:00
cdd0279b0b
Fix a typo in PyUnicode_CopyCharacters() documentation.
2013-08-08 16:47:43 +03:00
8cecc8c262
Issue #7330 : Implement width and precision (ex: "%5.3s") for the format string
...
of PyUnicode_FromFormat() function, original patch written by Ysj Ray.
2013-05-06 23:11:54 +02:00
44ea77bd81
Closes #4159 : add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text.
2013-03-28 13:28:44 +01:00
f4c3a187d5
Remove redundant sentence from c-api docs (issue #16323 )
2012-11-29 15:23:15 +02:00
0fe030bb03
Issue #16323 : Fix wrong C API documentation for locale encoding.
...
Patch by Berker Peksag.
2012-11-28 12:33:58 +02:00
e7f90375b1
#16127 : remove outdated references to narrow builds. Patch by Serhiy Storchaka.
2012-10-05 03:33:31 +03:00
b79be95dac
Issue #15444 : Use proper spelling for non-ASCII contributor names.
...
Patch by Serhiy Storchaka.
2012-08-11 16:54:27 +02:00
fbd4f80979
Issue #15444 : Use proper spelling for non-ASCII contributor names.
...
Patch by Serhiy Storchaka.
2012-08-11 16:51:50 +02:00
0813168e94
Issue #14090 : fix some minor C API problems in default branch (3.3)
2012-06-03 08:07:47 +03:00
6fbd525ef5
Issue #13617 : Document that the result of the conversion of a Unicode object to
...
wchar*, Py_UNICODE* and bytes may contain embedded null characters/bytes.
Patch written by Arnaud Calmettes.
2011-12-18 19:22:31 +01:00
b2bf01d824
use full unicode mappings for upper/lower/title case ( #12736 )
...
Also broaden the category of characters that count as lowercase/uppercase.
2012-01-11 18:17:06 -05:00
606e19dda3
Fix PyUnicode_Fill() doc: return type is Py_ssize_t, not int
2012-01-04 03:59:16 +01:00
3fe553160c
Add a new PyUnicode_Fill() function
...
It is faster than the unicode_fill() function which was implemented in
formatter_unicode.c.
2012-01-04 00:33:50 +01:00
0d81c1357d
Issue #13617 : Document that the result of the conversion of a Unicode object to
...
wchar*, Py_UNICODE* and bytes may contain embedded null characters/bytes.
Patch written by Arnaud Calmettes.
2011-12-18 19:30:55 +01:00
f2ea71fcc8
Issue #13560 : Add PyUnicode_EncodeLocale()
...
* Use PyUnicode_EncodeLocale() in time.strftime() if wcsftime() is not
available
* Document my last changes in Misc/NEWS
2011-12-17 04:13:41 +01:00
af02e1c85a
Add PyUnicode_DecodeLocaleAndSize() and PyUnicode_DecodeLocale()
...
* PyUnicode_DecodeLocaleAndSize() and PyUnicode_DecodeLocale() decode a string
from the current locale encoding
* _Py_char2wchar() writes an "error code" in the size argument to indicate
if the function failed because of memory allocation failure or because of a
decoding error. The function doesn't write the error message directly to
stderr.
* Fix time.strftime() (if wcsftime() is missing): decode strftime() result
from the current locale encoding, not from the filesystem encoding.
2011-12-16 23:56:01 +01:00
bf6e560d0c
Make PyUnicode_Copy() private => _PyUnicode_Copy()
...
Undocument the function.
Make also decode_utf8_errors() as private (static).
2011-12-12 01:53:47 +01:00
b6821013df
Document PyUnicode_Copy() and PyUnicode_EncodeCodePage()
2011-12-09 00:18:11 +01:00
b4938aaf15
Document PyUnicode_WCHAR_KIND
2011-11-20 18:27:28 +01:00
57735a0d6a
Add missing prefixes
2011-10-22 22:08:46 +02:00
b965b3938a
Elaborate on representations and canonical/legacy unicode objects
2011-10-22 22:08:05 +02:00
e6b99a1832
Move deprecated functions at the end of their respective sections.
2011-10-22 21:56:20 +02:00
2da16e61f5
Fix indentation.
2011-10-07 20:58:00 +02:00
c47adb04b3
Change PyUnicode_KIND to 1,2,4. Drop _KIND_SIZE and _CHARACTER_SIZE.
2011-10-07 20:55:35 +02:00
db6c7f5c33
Update C API docs for PEP 393.
2011-10-07 11:19:11 +02:00
Inada Naoki
Antonio Cuni
Victor Stinner
Alex Gaynor
Eric Wieser
Serhiy Storchaka
Stéphane Wirtel
toonarmycaptain
pxinwr
Victor Stinner
Victor Stinner
Louie Lu
Xiang Zhang
Berker Peksag
Steve Dower
Benjamin Peterson
Brett Cannon
Martin Panter
R David Murray
Georg Brandl
Zachary Ware
Andrew Svetlov
Ezio Melotti
Antoine Pitrou
Eli Bendersky
Victor Stinner
Martin v. Löwis