Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1 | .. highlightlang:: c |
| 2 | |
| 3 | .. _unicodeobjects: |
| 4 | |
| 5 | Unicode Objects and Codecs |
| 6 | -------------------------- |
| 7 | |
Antoine Pitrou | fbd4f80 | 2012-08-11 16:51:50 +0200 | [diff] [blame] | 8 | .. sectionauthor:: Marc-André Lemburg <mal@lemburg.com> |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 9 | .. sectionauthor:: Georg Brandl <georg@python.org> |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 10 | |
| 11 | Unicode Objects |
| 12 | ^^^^^^^^^^^^^^^ |
| 13 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 14 | Since the implementation of :pep:`393` in Python 3.3, Unicode objects internally |
| 15 | use a variety of representations, in order to allow handling the complete range |
| 16 | of Unicode characters while staying memory efficient. There are special cases |
| 17 | for strings where all code points are below 128, 256, or 65536; otherwise, code |
| 18 | points must be below 1114112 (which is the full Unicode range). |
| 19 | |
| 20 | :c:type:`Py_UNICODE*` and UTF-8 representations are created on demand and cached |
Antoine Pitrou | b965b39 | 2011-10-22 22:08:05 +0200 | [diff] [blame] | 21 | in the Unicode object. The :c:type:`Py_UNICODE*` representation is deprecated |
| 22 | and inefficient; it should be avoided in performance- or memory-sensitive |
| 23 | situations. |
| 24 | |
| 25 | Due to the transition between the old APIs and the new APIs, unicode objects |
| 26 | can internally be in two states depending on how they were created: |
| 27 | |
| 28 | * "canonical" unicode objects are all objects created by a non-deprecated |
| 29 | unicode API. They use the most efficient representation allowed by the |
| 30 | implementation. |
| 31 | |
| 32 | * "legacy" unicode objects have been created through one of the deprecated |
| 33 | APIs (typically :c:func:`PyUnicode_FromUnicode`) and only bear the |
| 34 | :c:type:`Py_UNICODE*` representation; you will have to call |
| 35 | :c:func:`PyUnicode_READY` on them before calling any other API. |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 36 | |
| 37 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 38 | Unicode Type |
| 39 | """""""""""" |
| 40 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 41 | These are the basic Unicode object types used for the Unicode implementation in |
| 42 | Python: |
| 43 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 44 | .. c:type:: Py_UCS4 |
| 45 | Py_UCS2 |
| 46 | Py_UCS1 |
| 47 | |
| 48 | These types are typedefs for unsigned integer types wide enough to contain |
| 49 | characters of 32 bits, 16 bits and 8 bits, respectively. When dealing with |
| 50 | single Unicode characters, use :c:type:`Py_UCS4`. |
| 51 | |
| 52 | .. versionadded:: 3.3 |
| 53 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 54 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 55 | .. c:type:: Py_UNICODE |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 56 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 57 | This is a typedef of :c:type:`wchar_t`, which is a 16-bit type or 32-bit type |
| 58 | depending on the platform. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 59 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 60 | .. versionchanged:: 3.3 |
| 61 | In previous versions, this was a 16-bit type or a 32-bit type depending on |
| 62 | whether you selected a "narrow" or "wide" Unicode version of Python at |
| 63 | build time. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 64 | |
| 65 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 66 | .. c:type:: PyASCIIObject |
| 67 | PyCompactUnicodeObject |
| 68 | PyUnicodeObject |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 69 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 70 | These subtypes of :c:type:`PyObject` represent a Python Unicode object. In |
| 71 | almost all cases, they shouldn't be used directly, since all API functions |
| 72 | that deal with Unicode objects take and return :c:type:`PyObject` pointers. |
| 73 | |
| 74 | .. versionadded:: 3.3 |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 75 | |
| 76 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 77 | .. c:var:: PyTypeObject PyUnicode_Type |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 78 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 79 | This instance of :c:type:`PyTypeObject` represents the Python Unicode type. It |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 80 | is exposed to Python code as ``str``. |
| 81 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 82 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 83 | The following APIs are really C macros and can be used to do fast checks and to |
| 84 | access internal read-only data of Unicode objects: |
| 85 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 86 | .. c:function:: int PyUnicode_Check(PyObject *o) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 87 | |
| 88 | Return true if the object *o* is a Unicode object or an instance of a Unicode |
| 89 | subtype. |
| 90 | |
| 91 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 92 | .. c:function:: int PyUnicode_CheckExact(PyObject *o) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 93 | |
| 94 | Return true if the object *o* is a Unicode object, but not an instance of a |
| 95 | subtype. |
| 96 | |
| 97 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 98 | .. c:function:: int PyUnicode_READY(PyObject *o) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 99 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 100 | Ensure the string object *o* is in the "canonical" representation. This is |
| 101 | required before using any of the access macros described below. |
| 102 | |
| 103 | .. XXX expand on when it is not required |
| 104 | |
| 105 | Returns 0 on success and -1 with an exception set on failure, which in |
| 106 | particular happens if memory allocation fails. |
| 107 | |
| 108 | .. versionadded:: 3.3 |
| 109 | |
| 110 | |
| 111 | .. c:function:: Py_ssize_t PyUnicode_GET_LENGTH(PyObject *o) |
| 112 | |
| 113 | Return the length of the Unicode string, in code points. *o* has to be a |
| 114 | Unicode object in the "canonical" representation (not checked). |
| 115 | |
| 116 | .. versionadded:: 3.3 |
| 117 | |
| 118 | |
| 119 | .. c:function:: Py_UCS1* PyUnicode_1BYTE_DATA(PyObject *o) |
| 120 | Py_UCS2* PyUnicode_2BYTE_DATA(PyObject *o) |
| 121 | Py_UCS4* PyUnicode_4BYTE_DATA(PyObject *o) |
| 122 | |
| 123 | Return a pointer to the canonical representation cast to UCS1, UCS2 or UCS4 |
| 124 | integer types for direct character access. No checks are performed if the |
| 125 | canonical representation has the correct character size; use |
Martin v. Löwis | 2da16e6 | 2011-10-07 20:58:00 +0200 | [diff] [blame] | 126 | :c:func:`PyUnicode_KIND` to select the right macro. Make sure |
Martin v. Löwis | c47adb0 | 2011-10-07 20:55:35 +0200 | [diff] [blame] | 127 | :c:func:`PyUnicode_READY` has been called before accessing this. |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 128 | |
| 129 | .. versionadded:: 3.3 |
| 130 | |
| 131 | |
Victor Stinner | b4938aa | 2011-11-20 18:27:28 +0100 | [diff] [blame] | 132 | .. c:macro:: PyUnicode_WCHAR_KIND |
| 133 | PyUnicode_1BYTE_KIND |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 134 | PyUnicode_2BYTE_KIND |
| 135 | PyUnicode_4BYTE_KIND |
| 136 | |
| 137 | Return values of the :c:func:`PyUnicode_KIND` macro. |
| 138 | |
| 139 | .. versionadded:: 3.3 |
| 140 | |
| 141 | |
| 142 | .. c:function:: int PyUnicode_KIND(PyObject *o) |
| 143 | |
| 144 | Return one of the PyUnicode kind constants (see above) that indicate how many |
| 145 | bytes per character this Unicode object uses to store its data. *o* has to |
| 146 | be a Unicode object in the "canonical" representation (not checked). |
| 147 | |
| 148 | .. XXX document "0" return value? |
| 149 | |
| 150 | .. versionadded:: 3.3 |
| 151 | |
| 152 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 153 | .. c:function:: void* PyUnicode_DATA(PyObject *o) |
| 154 | |
| 155 | Return a void pointer to the raw unicode buffer. *o* has to be a Unicode |
| 156 | object in the "canonical" representation (not checked). |
| 157 | |
| 158 | .. versionadded:: 3.3 |
| 159 | |
| 160 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 161 | .. c:function:: void PyUnicode_WRITE(int kind, void *data, Py_ssize_t index, \ |
| 162 | Py_UCS4 value) |
| 163 | |
| 164 | Write into a canonical representation *data* (as obtained with |
| 165 | :c:func:`PyUnicode_DATA`). This macro does not do any sanity checks and is |
| 166 | intended for usage in loops. The caller should cache the *kind* value and |
| 167 | *data* pointer as obtained from other macro calls. *index* is the index in |
| 168 | the string (starts at 0) and *value* is the new code point value which should |
| 169 | be written to that location. |
| 170 | |
| 171 | .. versionadded:: 3.3 |
| 172 | |
| 173 | |
| 174 | .. c:function:: Py_UCS4 PyUnicode_READ(int kind, void *data, Py_ssize_t index) |
| 175 | |
| 176 | Read a code point from a canonical representation *data* (as obtained with |
| 177 | :c:func:`PyUnicode_DATA`). No checks or ready calls are performed. |
| 178 | |
| 179 | .. versionadded:: 3.3 |
| 180 | |
| 181 | |
| 182 | .. c:function:: Py_UCS4 PyUnicode_READ_CHAR(PyObject *o, Py_ssize_t index) |
| 183 | |
| 184 | Read a character from a Unicode object *o*, which must be in the "canonical" |
| 185 | representation. This is less efficient than :c:func:`PyUnicode_READ` if you |
| 186 | do multiple consecutive reads. |
| 187 | |
| 188 | .. versionadded:: 3.3 |
| 189 | |
| 190 | |
| 191 | .. c:function:: PyUnicode_MAX_CHAR_VALUE(PyObject *o) |
| 192 | |
| 193 | Return the maximum code point that is suitable for creating another string |
| 194 | based on *o*, which must be in the "canonical" representation. This is |
| 195 | always an approximation but more efficient than iterating over the string. |
| 196 | |
| 197 | .. versionadded:: 3.3 |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 198 | |
Christian Heimes | a156e09 | 2008-02-16 07:38:31 +0000 | [diff] [blame] | 199 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 200 | .. c:function:: int PyUnicode_ClearFreeList() |
Christian Heimes | a156e09 | 2008-02-16 07:38:31 +0000 | [diff] [blame] | 201 | |
| 202 | Clear the free list. Return the total number of freed items. |
| 203 | |
Alexandre Vassalotti | 6d3dfc3 | 2009-07-29 19:54:39 +0000 | [diff] [blame] | 204 | |
Antoine Pitrou | e6b99a1 | 2011-10-22 21:56:20 +0200 | [diff] [blame] | 205 | .. c:function:: Py_ssize_t PyUnicode_GET_SIZE(PyObject *o) |
| 206 | |
| 207 | Return the size of the deprecated :c:type:`Py_UNICODE` representation, in |
| 208 | code units (this includes surrogate pairs as 2 units). *o* has to be a |
| 209 | Unicode object (not checked). |
| 210 | |
| 211 | .. deprecated-removed:: 3.3 4.0 |
| 212 | Part of the old-style Unicode API, please migrate to using |
| 213 | :c:func:`PyUnicode_GET_LENGTH`. |
| 214 | |
| 215 | |
| 216 | .. c:function:: Py_ssize_t PyUnicode_GET_DATA_SIZE(PyObject *o) |
| 217 | |
| 218 | Return the size of the deprecated :c:type:`Py_UNICODE` representation in |
| 219 | bytes. *o* has to be a Unicode object (not checked). |
| 220 | |
| 221 | .. deprecated-removed:: 3.3 4.0 |
| 222 | Part of the old-style Unicode API, please migrate to using |
| 223 | :c:func:`PyUnicode_GET_LENGTH`. |
| 224 | |
| 225 | |
| 226 | .. c:function:: Py_UNICODE* PyUnicode_AS_UNICODE(PyObject *o) |
| 227 | const char* PyUnicode_AS_DATA(PyObject *o) |
| 228 | |
| 229 | Return a pointer to a :c:type:`Py_UNICODE` representation of the object. The |
| 230 | ``AS_DATA`` form casts the pointer to :c:type:`const char *`. *o* has to be |
| 231 | a Unicode object (not checked). |
| 232 | |
| 233 | .. versionchanged:: 3.3 |
| 234 | This macro is now inefficient -- because in many cases the |
| 235 | :c:type:`Py_UNICODE` representation does not exist and needs to be created |
| 236 | -- and can fail (return *NULL* with an exception set). Try to port the |
| 237 | code to use the new :c:func:`PyUnicode_nBYTE_DATA` macros or use |
| 238 | :c:func:`PyUnicode_WRITE` or :c:func:`PyUnicode_READ`. |
| 239 | |
| 240 | .. deprecated-removed:: 3.3 4.0 |
| 241 | Part of the old-style Unicode API, please migrate to using the |
| 242 | :c:func:`PyUnicode_nBYTE_DATA` family of macros. |
| 243 | |
| 244 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 245 | Unicode Character Properties |
| 246 | """""""""""""""""""""""""""" |
| 247 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 248 | Unicode provides many different character properties. The most often needed ones |
| 249 | are available through these macros which are mapped to C functions depending on |
| 250 | the Python configuration. |
| 251 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 252 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 253 | .. c:function:: int Py_UNICODE_ISSPACE(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 254 | |
| 255 | Return 1 or 0 depending on whether *ch* is a whitespace character. |
| 256 | |
| 257 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 258 | .. c:function:: int Py_UNICODE_ISLOWER(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 259 | |
| 260 | Return 1 or 0 depending on whether *ch* is a lowercase character. |
| 261 | |
| 262 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 263 | .. c:function:: int Py_UNICODE_ISUPPER(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 264 | |
| 265 | Return 1 or 0 depending on whether *ch* is an uppercase character. |
| 266 | |
| 267 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 268 | .. c:function:: int Py_UNICODE_ISTITLE(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 269 | |
| 270 | Return 1 or 0 depending on whether *ch* is a titlecase character. |
| 271 | |
| 272 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 273 | .. c:function:: int Py_UNICODE_ISLINEBREAK(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 274 | |
| 275 | Return 1 or 0 depending on whether *ch* is a linebreak character. |
| 276 | |
| 277 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 278 | .. c:function:: int Py_UNICODE_ISDECIMAL(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 279 | |
| 280 | Return 1 or 0 depending on whether *ch* is a decimal character. |
| 281 | |
| 282 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 283 | .. c:function:: int Py_UNICODE_ISDIGIT(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 284 | |
| 285 | Return 1 or 0 depending on whether *ch* is a digit character. |
| 286 | |
| 287 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 288 | .. c:function:: int Py_UNICODE_ISNUMERIC(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 289 | |
| 290 | Return 1 or 0 depending on whether *ch* is a numeric character. |
| 291 | |
| 292 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 293 | .. c:function:: int Py_UNICODE_ISALPHA(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 294 | |
| 295 | Return 1 or 0 depending on whether *ch* is an alphabetic character. |
| 296 | |
| 297 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 298 | .. c:function:: int Py_UNICODE_ISALNUM(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 299 | |
| 300 | Return 1 or 0 depending on whether *ch* is an alphanumeric character. |
| 301 | |
Georg Brandl | 559e5d7 | 2008-06-11 18:37:52 +0000 | [diff] [blame] | 302 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 303 | .. c:function:: int Py_UNICODE_ISPRINTABLE(Py_UNICODE ch) |
Georg Brandl | 559e5d7 | 2008-06-11 18:37:52 +0000 | [diff] [blame] | 304 | |
| 305 | Return 1 or 0 depending on whether *ch* is a printable character. |
| 306 | Nonprintable characters are those characters defined in the Unicode character |
| 307 | database as "Other" or "Separator", excepting the ASCII space (0x20) which is |
| 308 | considered printable. (Note that printable characters in this context are |
| 309 | those which should not be escaped when :func:`repr` is invoked on a string. |
| 310 | It has no bearing on the handling of strings written to :data:`sys.stdout` or |
| 311 | :data:`sys.stderr`.) |
| 312 | |
| 313 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 314 | These APIs can be used for fast direct character conversions: |
| 315 | |
| 316 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 317 | .. c:function:: Py_UNICODE Py_UNICODE_TOLOWER(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 318 | |
| 319 | Return the character *ch* converted to lower case. |
| 320 | |
Benjamin Peterson | b2bf01d | 2012-01-11 18:17:06 -0500 | [diff] [blame] | 321 | .. deprecated:: 3.3 |
| 322 | This function uses simple case mappings. |
| 323 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 324 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 325 | .. c:function:: Py_UNICODE Py_UNICODE_TOUPPER(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 326 | |
| 327 | Return the character *ch* converted to upper case. |
| 328 | |
Benjamin Peterson | b2bf01d | 2012-01-11 18:17:06 -0500 | [diff] [blame] | 329 | .. deprecated:: 3.3 |
| 330 | This function uses simple case mappings. |
| 331 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 332 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 333 | .. c:function:: Py_UNICODE Py_UNICODE_TOTITLE(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 334 | |
| 335 | Return the character *ch* converted to title case. |
| 336 | |
Benjamin Peterson | b2bf01d | 2012-01-11 18:17:06 -0500 | [diff] [blame] | 337 | .. deprecated:: 3.3 |
| 338 | This function uses simple case mappings. |
| 339 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 340 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 341 | .. c:function:: int Py_UNICODE_TODECIMAL(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 342 | |
| 343 | Return the character *ch* converted to a decimal positive integer. Return |
| 344 | ``-1`` if this is not possible. This macro does not raise exceptions. |
| 345 | |
| 346 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 347 | .. c:function:: int Py_UNICODE_TODIGIT(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 348 | |
| 349 | Return the character *ch* converted to a single digit integer. Return ``-1`` if |
| 350 | this is not possible. This macro does not raise exceptions. |
| 351 | |
| 352 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 353 | .. c:function:: double Py_UNICODE_TONUMERIC(Py_UNICODE ch) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 354 | |
| 355 | Return the character *ch* converted to a double. Return ``-1.0`` if this is not |
| 356 | possible. This macro does not raise exceptions. |
| 357 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 358 | |
Ezio Melotti | 8c9375b | 2011-08-22 20:03:25 +0300 | [diff] [blame] | 359 | These APIs can be used to work with surrogates: |
| 360 | |
| 361 | .. c:macro:: Py_UNICODE_IS_SURROGATE(ch) |
| 362 | |
| 363 | Check if *ch* is a surrogate (``0xD800 <= ch <= 0xDFFF``). |
| 364 | |
| 365 | .. c:macro:: Py_UNICODE_IS_HIGH_SURROGATE(ch) |
| 366 | |
| 367 | Check if *ch* is an high surrogate (``0xD800 <= ch <= 0xDBFF``). |
| 368 | |
| 369 | .. c:macro:: Py_UNICODE_IS_LOW_SURROGATE(ch) |
| 370 | |
| 371 | Check if *ch* is a low surrogate (``0xDC00 <= ch <= 0xDFFF``). |
| 372 | |
| 373 | .. c:macro:: Py_UNICODE_JOIN_SURROGATES(high, low) |
| 374 | |
| 375 | Join two surrogate characters and return a single Py_UCS4 value. |
| 376 | *high* and *low* are respectively the leading and trailing surrogates in a |
| 377 | surrogate pair. |
| 378 | |
| 379 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 380 | Creating and accessing Unicode strings |
| 381 | """""""""""""""""""""""""""""""""""""" |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 382 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 383 | To create Unicode objects and access their basic sequence properties, use these |
| 384 | APIs: |
| 385 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 386 | .. c:function:: PyObject* PyUnicode_New(Py_ssize_t size, Py_UCS4 maxchar) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 387 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 388 | Create a new Unicode object. *maxchar* should be the true maximum code point |
| 389 | to be placed in the string. As an approximation, it can be rounded up to the |
| 390 | nearest value in the sequence 127, 255, 65535, 1114111. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 391 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 392 | This is the recommended way to allocate a new Unicode object. Objects |
| 393 | created using this function are not resizable. |
| 394 | |
| 395 | .. versionadded:: 3.3 |
| 396 | |
| 397 | |
| 398 | .. c:function:: PyObject* PyUnicode_FromKindAndData(int kind, const void *buffer, \ |
| 399 | Py_ssize_t size) |
| 400 | |
| 401 | Create a new Unicode object with the given *kind* (possible values are |
| 402 | :c:macro:`PyUnicode_1BYTE_KIND` etc., as returned by |
| 403 | :c:func:`PyUnicode_KIND`). The *buffer* must point to an array of *size* |
| 404 | units of 1, 2 or 4 bytes per character, as given by the kind. |
| 405 | |
| 406 | .. versionadded:: 3.3 |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 407 | |
| 408 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 409 | .. c:function:: PyObject* PyUnicode_FromStringAndSize(const char *u, Py_ssize_t size) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 410 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 411 | Create a Unicode object from the char buffer *u*. The bytes will be |
| 412 | interpreted as being UTF-8 encoded. The buffer is copied into the new |
| 413 | object. If the buffer is not *NULL*, the return value might be a shared |
| 414 | object, i.e. modification of the data is not allowed. |
| 415 | |
| 416 | If *u* is *NULL*, this function behaves like :c:func:`PyUnicode_FromUnicode` |
| 417 | with the buffer set to *NULL*. This usage is deprecated in favor of |
| 418 | :c:func:`PyUnicode_New`. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 419 | |
| 420 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 421 | .. c:function:: PyObject *PyUnicode_FromString(const char *u) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 422 | |
| 423 | Create a Unicode object from an UTF-8 encoded null-terminated char buffer |
| 424 | *u*. |
| 425 | |
| 426 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 427 | .. c:function:: PyObject* PyUnicode_FromFormat(const char *format, ...) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 428 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 429 | Take a C :c:func:`printf`\ -style *format* string and a variable number of |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 430 | arguments, calculate the size of the resulting Python unicode string and return |
| 431 | a string with the values formatted into it. The variable arguments must be C |
| 432 | types and must correspond exactly to the format characters in the *format* |
Victor Stinner | 1205f27 | 2010-09-11 00:54:47 +0000 | [diff] [blame] | 433 | ASCII-encoded string. The following format characters are allowed: |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 434 | |
Mark Dickinson | 6ce4a9a | 2009-11-16 17:00:11 +0000 | [diff] [blame] | 435 | .. % This should be exactly the same as the table in PyErr_Format. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 436 | .. % The descriptions for %zd and %zu are wrong, but the truth is complicated |
| 437 | .. % because not all compilers support the %z width modifier -- we fake it |
| 438 | .. % when necessary via interpolating PY_FORMAT_SIZE_T. |
Mark Dickinson | 6ce4a9a | 2009-11-16 17:00:11 +0000 | [diff] [blame] | 439 | .. % Similar comments apply to the %ll width modifier and |
| 440 | .. % PY_FORMAT_LONG_LONG. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 441 | |
| 442 | +-------------------+---------------------+--------------------------------+ |
| 443 | | Format Characters | Type | Comment | |
| 444 | +===================+=====================+================================+ |
| 445 | | :attr:`%%` | *n/a* | The literal % character. | |
| 446 | +-------------------+---------------------+--------------------------------+ |
| 447 | | :attr:`%c` | int | A single character, | |
| 448 | | | | represented as an C int. | |
| 449 | +-------------------+---------------------+--------------------------------+ |
| 450 | | :attr:`%d` | int | Exactly equivalent to | |
| 451 | | | | ``printf("%d")``. | |
| 452 | +-------------------+---------------------+--------------------------------+ |
| 453 | | :attr:`%u` | unsigned int | Exactly equivalent to | |
| 454 | | | | ``printf("%u")``. | |
| 455 | +-------------------+---------------------+--------------------------------+ |
| 456 | | :attr:`%ld` | long | Exactly equivalent to | |
| 457 | | | | ``printf("%ld")``. | |
| 458 | +-------------------+---------------------+--------------------------------+ |
Victor Stinner | 0fbe226 | 2011-03-02 00:10:34 +0000 | [diff] [blame] | 459 | | :attr:`%li` | long | Exactly equivalent to | |
| 460 | | | | ``printf("%li")``. | |
| 461 | +-------------------+---------------------+--------------------------------+ |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 462 | | :attr:`%lu` | unsigned long | Exactly equivalent to | |
| 463 | | | | ``printf("%lu")``. | |
| 464 | +-------------------+---------------------+--------------------------------+ |
Mark Dickinson | 6ce4a9a | 2009-11-16 17:00:11 +0000 | [diff] [blame] | 465 | | :attr:`%lld` | long long | Exactly equivalent to | |
| 466 | | | | ``printf("%lld")``. | |
| 467 | +-------------------+---------------------+--------------------------------+ |
Victor Stinner | 0fbe226 | 2011-03-02 00:10:34 +0000 | [diff] [blame] | 468 | | :attr:`%lli` | long long | Exactly equivalent to | |
| 469 | | | | ``printf("%lli")``. | |
| 470 | +-------------------+---------------------+--------------------------------+ |
Mark Dickinson | 6ce4a9a | 2009-11-16 17:00:11 +0000 | [diff] [blame] | 471 | | :attr:`%llu` | unsigned long long | Exactly equivalent to | |
| 472 | | | | ``printf("%llu")``. | |
| 473 | +-------------------+---------------------+--------------------------------+ |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 474 | | :attr:`%zd` | Py_ssize_t | Exactly equivalent to | |
| 475 | | | | ``printf("%zd")``. | |
| 476 | +-------------------+---------------------+--------------------------------+ |
Victor Stinner | 0fbe226 | 2011-03-02 00:10:34 +0000 | [diff] [blame] | 477 | | :attr:`%zi` | Py_ssize_t | Exactly equivalent to | |
| 478 | | | | ``printf("%zi")``. | |
| 479 | +-------------------+---------------------+--------------------------------+ |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 480 | | :attr:`%zu` | size_t | Exactly equivalent to | |
| 481 | | | | ``printf("%zu")``. | |
| 482 | +-------------------+---------------------+--------------------------------+ |
| 483 | | :attr:`%i` | int | Exactly equivalent to | |
| 484 | | | | ``printf("%i")``. | |
| 485 | +-------------------+---------------------+--------------------------------+ |
| 486 | | :attr:`%x` | int | Exactly equivalent to | |
| 487 | | | | ``printf("%x")``. | |
| 488 | +-------------------+---------------------+--------------------------------+ |
| 489 | | :attr:`%s` | char\* | A null-terminated C character | |
| 490 | | | | array. | |
| 491 | +-------------------+---------------------+--------------------------------+ |
| 492 | | :attr:`%p` | void\* | The hex representation of a C | |
| 493 | | | | pointer. Mostly equivalent to | |
| 494 | | | | ``printf("%p")`` except that | |
| 495 | | | | it is guaranteed to start with | |
| 496 | | | | the literal ``0x`` regardless | |
| 497 | | | | of what the platform's | |
| 498 | | | | ``printf`` yields. | |
| 499 | +-------------------+---------------------+--------------------------------+ |
Georg Brandl | 559e5d7 | 2008-06-11 18:37:52 +0000 | [diff] [blame] | 500 | | :attr:`%A` | PyObject\* | The result of calling | |
| 501 | | | | :func:`ascii`. | |
| 502 | +-------------------+---------------------+--------------------------------+ |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 503 | | :attr:`%U` | PyObject\* | A unicode object. | |
| 504 | +-------------------+---------------------+--------------------------------+ |
| 505 | | :attr:`%V` | PyObject\*, char \* | A unicode object (which may be | |
| 506 | | | | *NULL*) and a null-terminated | |
| 507 | | | | C character array as a second | |
| 508 | | | | parameter (which will be used, | |
| 509 | | | | if the first parameter is | |
| 510 | | | | *NULL*). | |
| 511 | +-------------------+---------------------+--------------------------------+ |
| 512 | | :attr:`%S` | PyObject\* | The result of calling | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 513 | | | | :c:func:`PyObject_Str`. | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 514 | +-------------------+---------------------+--------------------------------+ |
| 515 | | :attr:`%R` | PyObject\* | The result of calling | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 516 | | | | :c:func:`PyObject_Repr`. | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 517 | +-------------------+---------------------+--------------------------------+ |
| 518 | |
| 519 | An unrecognized format character causes all the rest of the format string to be |
| 520 | copied as-is to the result string, and any extra arguments discarded. |
| 521 | |
Mark Dickinson | 6ce4a9a | 2009-11-16 17:00:11 +0000 | [diff] [blame] | 522 | .. note:: |
| 523 | |
| 524 | The `"%lld"` and `"%llu"` format specifiers are only available |
Georg Brandl | ef871f6 | 2010-03-12 10:06:40 +0000 | [diff] [blame] | 525 | when :const:`HAVE_LONG_LONG` is defined. |
Mark Dickinson | 6ce4a9a | 2009-11-16 17:00:11 +0000 | [diff] [blame] | 526 | |
| 527 | .. versionchanged:: 3.2 |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 528 | Support for ``"%lld"`` and ``"%llu"`` added. |
Mark Dickinson | 6ce4a9a | 2009-11-16 17:00:11 +0000 | [diff] [blame] | 529 | |
Victor Stinner | 0fbe226 | 2011-03-02 00:10:34 +0000 | [diff] [blame] | 530 | .. versionchanged:: 3.3 |
| 531 | Support for ``"%li"``, ``"%lli"`` and ``"%zi"`` added. |
| 532 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 533 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 534 | .. c:function:: PyObject* PyUnicode_FromFormatV(const char *format, va_list vargs) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 535 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 536 | Identical to :c:func:`PyUnicode_FromFormat` except that it takes exactly two |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 537 | arguments. |
| 538 | |
Alexander Belopolsky | 942af5a | 2010-12-04 03:38:46 +0000 | [diff] [blame] | 539 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 540 | .. c:function:: PyObject* PyUnicode_FromEncodedObject(PyObject *obj, \ |
| 541 | const char *encoding, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 542 | |
| 543 | Coerce an encoded object *obj* to an Unicode object and return a reference with |
| 544 | incremented refcount. |
| 545 | |
Georg Brandl | 952867a | 2010-06-27 10:17:12 +0000 | [diff] [blame] | 546 | :class:`bytes`, :class:`bytearray` and other char buffer compatible objects |
Ezio Melotti | 95cd91c | 2011-04-14 07:43:53 +0300 | [diff] [blame] | 547 | are decoded according to the given *encoding* and using the error handling |
| 548 | defined by *errors*. Both can be *NULL* to have the interface use the default |
Georg Brandl | 952867a | 2010-06-27 10:17:12 +0000 | [diff] [blame] | 549 | values (see the next section for details). |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 550 | |
| 551 | All other objects, including Unicode objects, cause a :exc:`TypeError` to be |
| 552 | set. |
| 553 | |
| 554 | The API returns *NULL* if there was an error. The caller is responsible for |
| 555 | decref'ing the returned objects. |
| 556 | |
| 557 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 558 | .. c:function:: Py_ssize_t PyUnicode_GetLength(PyObject *unicode) |
| 559 | |
| 560 | Return the length of the Unicode object, in code points. |
| 561 | |
| 562 | .. versionadded:: 3.3 |
| 563 | |
| 564 | |
| 565 | .. c:function:: int PyUnicode_CopyCharacters(PyObject *to, Py_ssize_t to_start, \ |
| 566 | PyObject *to, Py_ssize_t from_start, Py_ssize_t how_many) |
| 567 | |
| 568 | Copy characters from one Unicode object into another. This function performs |
| 569 | character conversion when necessary and falls back to :c:func:`memcpy` if |
| 570 | possible. Returns ``-1`` and sets an exception on error, otherwise returns |
| 571 | ``0``. |
| 572 | |
| 573 | .. versionadded:: 3.3 |
| 574 | |
| 575 | |
Victor Stinner | 606e19d | 2012-01-04 03:59:16 +0100 | [diff] [blame] | 576 | .. c:function:: Py_ssize_t PyUnicode_Fill(PyObject *unicode, Py_ssize_t start, \ |
Victor Stinner | 3fe5531 | 2012-01-04 00:33:50 +0100 | [diff] [blame] | 577 | Py_ssize_t length, Py_UCS4 fill_char) |
| 578 | |
| 579 | Fill a string with a character: write *fill_char* into |
| 580 | ``unicode[start:start+length]``. |
| 581 | |
| 582 | Fail if *fill_char* is bigger than the string maximum character, or if the |
| 583 | string has more than 1 reference. |
| 584 | |
| 585 | Return the number of written character, or return ``-1`` and raise an |
| 586 | exception on error. |
| 587 | |
| 588 | .. versionadded:: 3.3 |
| 589 | |
| 590 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 591 | .. c:function:: int PyUnicode_WriteChar(PyObject *unicode, Py_ssize_t index, \ |
| 592 | Py_UCS4 character) |
| 593 | |
| 594 | Write a character to a string. The string must have been created through |
| 595 | :c:func:`PyUnicode_New`. Since Unicode strings are supposed to be immutable, |
| 596 | the string must not be shared, or have been hashed yet. |
| 597 | |
| 598 | This function checks that *unicode* is a Unicode object, that the index is |
| 599 | not out of bounds, and that the object can be modified safely (i.e. that it |
| 600 | its reference count is one), in contrast to the macro version |
| 601 | :c:func:`PyUnicode_WRITE_CHAR`. |
| 602 | |
| 603 | .. versionadded:: 3.3 |
| 604 | |
| 605 | |
| 606 | .. c:function:: Py_UCS4 PyUnicode_ReadChar(PyObject *unicode, Py_ssize_t index) |
| 607 | |
| 608 | Read a character from a string. This function checks that *unicode* is a |
| 609 | Unicode object and the index is not out of bounds, in contrast to the macro |
| 610 | version :c:func:`PyUnicode_READ_CHAR`. |
| 611 | |
| 612 | .. versionadded:: 3.3 |
| 613 | |
| 614 | |
| 615 | .. c:function:: PyObject* PyUnicode_Substring(PyObject *str, Py_ssize_t start, \ |
| 616 | Py_ssize_t end) |
| 617 | |
| 618 | Return a substring of *str*, from character index *start* (included) to |
| 619 | character index *end* (excluded). Negative indices are not supported. |
| 620 | |
| 621 | .. versionadded:: 3.3 |
| 622 | |
| 623 | |
| 624 | .. c:function:: Py_UCS4* PyUnicode_AsUCS4(PyObject *u, Py_UCS4 *buffer, \ |
| 625 | Py_ssize_t buflen, int copy_null) |
| 626 | |
| 627 | Copy the string *u* into a UCS4 buffer, including a null character, if |
| 628 | *copy_null* is set. Returns *NULL* and sets an exception on error (in |
| 629 | particular, a :exc:`ValueError` if *buflen* is smaller than the length of |
| 630 | *u*). *buffer* is returned on success. |
| 631 | |
| 632 | .. versionadded:: 3.3 |
| 633 | |
| 634 | |
| 635 | .. c:function:: Py_UCS4* PyUnicode_AsUCS4Copy(PyObject *u) |
| 636 | |
| 637 | Copy the string *u* into a new UCS4 buffer that is allocated using |
| 638 | :c:func:`PyMem_Malloc`. If this fails, *NULL* is returned with a |
| 639 | :exc:`MemoryError` set. |
| 640 | |
| 641 | .. versionadded:: 3.3 |
| 642 | |
| 643 | |
| 644 | Deprecated Py_UNICODE APIs |
| 645 | """""""""""""""""""""""""" |
| 646 | |
| 647 | .. deprecated-removed:: 3.3 4.0 |
| 648 | |
| 649 | These API functions are deprecated with the implementation of :pep:`393`. |
| 650 | Extension modules can continue using them, as they will not be removed in Python |
| 651 | 3.x, but need to be aware that their use can now cause performance and memory hits. |
| 652 | |
| 653 | |
| 654 | .. c:function:: PyObject* PyUnicode_FromUnicode(const Py_UNICODE *u, Py_ssize_t size) |
| 655 | |
| 656 | Create a Unicode object from the Py_UNICODE buffer *u* of the given size. *u* |
| 657 | may be *NULL* which causes the contents to be undefined. It is the user's |
| 658 | responsibility to fill in the needed data. The buffer is copied into the new |
| 659 | object. |
| 660 | |
| 661 | If the buffer is not *NULL*, the return value might be a shared object. |
| 662 | Therefore, modification of the resulting Unicode object is only allowed when |
| 663 | *u* is *NULL*. |
| 664 | |
| 665 | If the buffer is *NULL*, :c:func:`PyUnicode_READY` must be called once the |
| 666 | string content has been filled before using any of the access macros such as |
| 667 | :c:func:`PyUnicode_KIND`. |
| 668 | |
| 669 | Please migrate to using :c:func:`PyUnicode_FromKindAndData` or |
| 670 | :c:func:`PyUnicode_New`. |
| 671 | |
| 672 | |
| 673 | .. c:function:: Py_UNICODE* PyUnicode_AsUnicode(PyObject *unicode) |
| 674 | |
| 675 | Return a read-only pointer to the Unicode object's internal |
Victor Stinner | 0d81c13 | 2011-12-18 19:30:55 +0100 | [diff] [blame] | 676 | :c:type:`Py_UNICODE` buffer, or *NULL* on error. This will create the |
| 677 | :c:type:`Py_UNICODE*` representation of the object if it is not yet |
| 678 | available. Note that the resulting :c:type:`Py_UNICODE` string may contain |
| 679 | embedded null characters, which would cause the string to be truncated when |
| 680 | used in most C functions. |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 681 | |
| 682 | Please migrate to using :c:func:`PyUnicode_AsUCS4`, |
| 683 | :c:func:`PyUnicode_Substring`, :c:func:`PyUnicode_ReadChar` or similar new |
| 684 | APIs. |
| 685 | |
| 686 | |
| 687 | .. c:function:: PyObject* PyUnicode_TransformDecimalToASCII(Py_UNICODE *s, Py_ssize_t size) |
| 688 | |
| 689 | Create a Unicode object by replacing all decimal digits in |
| 690 | :c:type:`Py_UNICODE` buffer of the given *size* by ASCII digits 0--9 |
| 691 | according to their decimal value. Return *NULL* if an exception occurs. |
| 692 | |
| 693 | |
| 694 | .. c:function:: Py_UNICODE* PyUnicode_AsUnicodeAndSize(PyObject *unicode, Py_ssize_t *size) |
| 695 | |
| 696 | Like :c:func:`PyUnicode_AsUnicode`, but also saves the :c:func:`Py_UNICODE` |
Victor Stinner | 0d81c13 | 2011-12-18 19:30:55 +0100 | [diff] [blame] | 697 | array length in *size*. Note that the resulting :c:type:`Py_UNICODE*` string |
| 698 | may contain embedded null characters, which would cause the string to be |
| 699 | truncated when used in most C functions. |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 700 | |
| 701 | .. versionadded:: 3.3 |
| 702 | |
| 703 | |
| 704 | .. c:function:: Py_UNICODE* PyUnicode_AsUnicodeCopy(PyObject *unicode) |
| 705 | |
| 706 | Create a copy of a Unicode string ending with a nul character. Return *NULL* |
| 707 | and raise a :exc:`MemoryError` exception on memory allocation failure, |
Victor Stinner | 0d81c13 | 2011-12-18 19:30:55 +0100 | [diff] [blame] | 708 | otherwise return a new allocated buffer (use :c:func:`PyMem_Free` to free |
| 709 | the buffer). Note that the resulting :c:type:`Py_UNICODE*` string may |
| 710 | contain embedded null characters, which would cause the string to be |
| 711 | truncated when used in most C functions. |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 712 | |
| 713 | .. versionadded:: 3.2 |
| 714 | |
| 715 | Please migrate to using :c:func:`PyUnicode_AsUCS4Copy` or similar new APIs. |
| 716 | |
| 717 | |
| 718 | .. c:function:: Py_ssize_t PyUnicode_GetSize(PyObject *unicode) |
| 719 | |
| 720 | Return the size of the deprecated :c:type:`Py_UNICODE` representation, in |
| 721 | code units (this includes surrogate pairs as 2 units). |
| 722 | |
| 723 | Please migrate to using :c:func:`PyUnicode_GetLength`. |
| 724 | |
| 725 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 726 | .. c:function:: PyObject* PyUnicode_FromObject(PyObject *obj) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 727 | |
| 728 | Shortcut for ``PyUnicode_FromEncodedObject(obj, NULL, "strict")`` which is used |
| 729 | throughout the interpreter whenever coercion to Unicode is needed. |
| 730 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 731 | |
Victor Stinner | af02e1c | 2011-12-16 23:56:01 +0100 | [diff] [blame] | 732 | Locale Encoding |
| 733 | """"""""""""""" |
| 734 | |
| 735 | The current locale encoding can be used to decode text from the operating |
| 736 | system. |
| 737 | |
Andrew Svetlov | 0fe030b | 2012-11-28 12:33:58 +0200 | [diff] [blame] | 738 | .. c:function:: PyObject* PyUnicode_DecodeLocaleAndSize(const char *str, \ |
| 739 | Py_ssize_t len, \ |
| 740 | const char *errors) |
Victor Stinner | af02e1c | 2011-12-16 23:56:01 +0100 | [diff] [blame] | 741 | |
Andrew Svetlov | 0fe030b | 2012-11-28 12:33:58 +0200 | [diff] [blame] | 742 | Decode a string from the current locale encoding. The supported |
| 743 | error handlers are ``"strict"`` and ``"surrogateescape"`` |
| 744 | (:pep:`383`). The decoder uses ``"strict"`` error handler if |
Andrew Svetlov | f4c3a18 | 2012-11-29 15:23:15 +0200 | [diff] [blame] | 745 | *errors* is ``NULL``. *str* must end with a null character but |
Andrew Svetlov | 0fe030b | 2012-11-28 12:33:58 +0200 | [diff] [blame] | 746 | cannot contain embedded null characters. |
Victor Stinner | af02e1c | 2011-12-16 23:56:01 +0100 | [diff] [blame] | 747 | |
| 748 | .. seealso:: |
| 749 | |
| 750 | Use :c:func:`PyUnicode_DecodeFSDefaultAndSize` to decode a string from |
| 751 | :c:data:`Py_FileSystemDefaultEncoding` (the locale encoding read at |
| 752 | Python startup). |
| 753 | |
| 754 | .. versionadded:: 3.3 |
| 755 | |
| 756 | |
Andrew Svetlov | 0fe030b | 2012-11-28 12:33:58 +0200 | [diff] [blame] | 757 | .. c:function:: PyObject* PyUnicode_DecodeLocale(const char *str, const char *errors) |
Victor Stinner | af02e1c | 2011-12-16 23:56:01 +0100 | [diff] [blame] | 758 | |
| 759 | Similar to :c:func:`PyUnicode_DecodeLocaleAndSize`, but compute the string |
| 760 | length using :c:func:`strlen`. |
| 761 | |
| 762 | .. versionadded:: 3.3 |
| 763 | |
| 764 | |
Andrew Svetlov | 0fe030b | 2012-11-28 12:33:58 +0200 | [diff] [blame] | 765 | .. c:function:: PyObject* PyUnicode_EncodeLocale(PyObject *unicode, const char *errors) |
Victor Stinner | f2ea71f | 2011-12-17 04:13:41 +0100 | [diff] [blame] | 766 | |
Andrew Svetlov | 0fe030b | 2012-11-28 12:33:58 +0200 | [diff] [blame] | 767 | Encode a Unicode object to the current locale encoding. The |
| 768 | supported error handlers are ``"strict"`` and ``"surrogateescape"`` |
| 769 | (:pep:`383`). The encoder uses ``"strict"`` error handler if |
| 770 | *errors* is ``NULL``. Return a :class:`bytes` object. *str* cannot |
| 771 | contain embedded null characters. |
Victor Stinner | f2ea71f | 2011-12-17 04:13:41 +0100 | [diff] [blame] | 772 | |
| 773 | .. seealso:: |
| 774 | |
| 775 | Use :c:func:`PyUnicode_EncodeFSDefault` to encode a string to |
| 776 | :c:data:`Py_FileSystemDefaultEncoding` (the locale encoding read at |
| 777 | Python startup). |
| 778 | |
| 779 | .. versionadded:: 3.3 |
| 780 | |
| 781 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 782 | File System Encoding |
| 783 | """""""""""""""""""" |
| 784 | |
| 785 | To encode and decode file names and other environment strings, |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 786 | :c:data:`Py_FileSystemEncoding` should be used as the encoding, and |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 787 | ``"surrogateescape"`` should be used as the error handler (:pep:`383`). To |
| 788 | encode file names during argument parsing, the ``"O&"`` converter should be |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 789 | used, passing :c:func:`PyUnicode_FSConverter` as the conversion function: |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 790 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 791 | .. c:function:: int PyUnicode_FSConverter(PyObject* obj, void* result) |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 792 | |
Victor Stinner | 47fcb5b | 2010-08-13 23:59:58 +0000 | [diff] [blame] | 793 | ParseTuple converter: encode :class:`str` objects to :class:`bytes` using |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 794 | :c:func:`PyUnicode_EncodeFSDefault`; :class:`bytes` objects are output as-is. |
| 795 | *result* must be a :c:type:`PyBytesObject*` which must be released when it is |
Victor Stinner | 47fcb5b | 2010-08-13 23:59:58 +0000 | [diff] [blame] | 796 | no longer used. |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 797 | |
| 798 | .. versionadded:: 3.1 |
| 799 | |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 800 | |
Victor Stinner | 47fcb5b | 2010-08-13 23:59:58 +0000 | [diff] [blame] | 801 | To decode file names during argument parsing, the ``"O&"`` converter should be |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 802 | used, passing :c:func:`PyUnicode_FSDecoder` as the conversion function: |
Victor Stinner | 47fcb5b | 2010-08-13 23:59:58 +0000 | [diff] [blame] | 803 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 804 | .. c:function:: int PyUnicode_FSDecoder(PyObject* obj, void* result) |
Victor Stinner | 47fcb5b | 2010-08-13 23:59:58 +0000 | [diff] [blame] | 805 | |
| 806 | ParseTuple converter: decode :class:`bytes` objects to :class:`str` using |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 807 | :c:func:`PyUnicode_DecodeFSDefaultAndSize`; :class:`str` objects are output |
| 808 | as-is. *result* must be a :c:type:`PyUnicodeObject*` which must be released |
Victor Stinner | 47fcb5b | 2010-08-13 23:59:58 +0000 | [diff] [blame] | 809 | when it is no longer used. |
| 810 | |
| 811 | .. versionadded:: 3.2 |
| 812 | |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 813 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 814 | .. c:function:: PyObject* PyUnicode_DecodeFSDefaultAndSize(const char *s, Py_ssize_t size) |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 815 | |
Victor Stinner | 62165d6 | 2010-10-09 10:34:37 +0000 | [diff] [blame] | 816 | Decode a string using :c:data:`Py_FileSystemDefaultEncoding` and the |
Andrew Svetlov | 0fe030b | 2012-11-28 12:33:58 +0200 | [diff] [blame] | 817 | ``"surrogateescape"`` error handler, or ``"strict"`` on Windows. |
Victor Stinner | 62165d6 | 2010-10-09 10:34:37 +0000 | [diff] [blame] | 818 | |
Victor Stinner | f3170cc | 2010-10-15 12:04:23 +0000 | [diff] [blame] | 819 | If :c:data:`Py_FileSystemDefaultEncoding` is not set, fall back to the |
| 820 | locale encoding. |
Victor Stinner | 62165d6 | 2010-10-09 10:34:37 +0000 | [diff] [blame] | 821 | |
Victor Stinner | af02e1c | 2011-12-16 23:56:01 +0100 | [diff] [blame] | 822 | .. seealso:: |
| 823 | |
| 824 | :c:data:`Py_FileSystemDefaultEncoding` is initialized at startup from the |
| 825 | locale encoding and cannot be modified later. If you need to decode a |
| 826 | string from the current locale encoding, use |
| 827 | :c:func:`PyUnicode_DecodeLocaleAndSize`. |
| 828 | |
Victor Stinner | 62165d6 | 2010-10-09 10:34:37 +0000 | [diff] [blame] | 829 | .. versionchanged:: 3.2 |
Andrew Svetlov | 0fe030b | 2012-11-28 12:33:58 +0200 | [diff] [blame] | 830 | Use ``"strict"`` error handler on Windows. |
Victor Stinner | 62165d6 | 2010-10-09 10:34:37 +0000 | [diff] [blame] | 831 | |
| 832 | |
| 833 | .. c:function:: PyObject* PyUnicode_DecodeFSDefault(const char *s) |
| 834 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 835 | Decode a null-terminated string using :c:data:`Py_FileSystemDefaultEncoding` |
Andrew Svetlov | 0fe030b | 2012-11-28 12:33:58 +0200 | [diff] [blame] | 836 | and the ``"surrogateescape"`` error handler, or ``"strict"`` on Windows. |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 837 | |
Victor Stinner | f3170cc | 2010-10-15 12:04:23 +0000 | [diff] [blame] | 838 | If :c:data:`Py_FileSystemDefaultEncoding` is not set, fall back to the |
| 839 | locale encoding. |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 840 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 841 | Use :c:func:`PyUnicode_DecodeFSDefaultAndSize` if you know the string length. |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 842 | |
Victor Stinner | 62165d6 | 2010-10-09 10:34:37 +0000 | [diff] [blame] | 843 | .. versionchanged:: 3.2 |
Andrew Svetlov | 0fe030b | 2012-11-28 12:33:58 +0200 | [diff] [blame] | 844 | Use ``"strict"`` error handler on Windows. |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 845 | |
| 846 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 847 | .. c:function:: PyObject* PyUnicode_EncodeFSDefault(PyObject *unicode) |
Victor Stinner | ae6265f | 2010-05-15 16:27:27 +0000 | [diff] [blame] | 848 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 849 | Encode a Unicode object to :c:data:`Py_FileSystemDefaultEncoding` with the |
Andrew Svetlov | 0fe030b | 2012-11-28 12:33:58 +0200 | [diff] [blame] | 850 | ``"surrogateescape"`` error handler, or ``"strict"`` on Windows, and return |
Victor Stinner | 6fbd525 | 2011-12-18 19:22:31 +0100 | [diff] [blame] | 851 | :class:`bytes`. Note that the resulting :class:`bytes` object may contain |
| 852 | null bytes. |
Victor Stinner | ae6265f | 2010-05-15 16:27:27 +0000 | [diff] [blame] | 853 | |
Victor Stinner | f3170cc | 2010-10-15 12:04:23 +0000 | [diff] [blame] | 854 | If :c:data:`Py_FileSystemDefaultEncoding` is not set, fall back to the |
| 855 | locale encoding. |
Victor Stinner | ae6265f | 2010-05-15 16:27:27 +0000 | [diff] [blame] | 856 | |
Victor Stinner | f2ea71f | 2011-12-17 04:13:41 +0100 | [diff] [blame] | 857 | .. seealso:: |
| 858 | |
| 859 | :c:data:`Py_FileSystemDefaultEncoding` is initialized at startup from the |
| 860 | locale encoding and cannot be modified later. If you need to encode a |
| 861 | string to the current locale encoding, use |
| 862 | :c:func:`PyUnicode_EncodeLocale`. |
| 863 | |
Victor Stinner | ae6265f | 2010-05-15 16:27:27 +0000 | [diff] [blame] | 864 | .. versionadded:: 3.2 |
| 865 | |
| 866 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 867 | wchar_t Support |
| 868 | """"""""""""""" |
| 869 | |
Ezio Melotti | c1f0577 | 2011-04-14 07:50:25 +0300 | [diff] [blame] | 870 | :c:type:`wchar_t` support for platforms which support it: |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 871 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 872 | .. c:function:: PyObject* PyUnicode_FromWideChar(const wchar_t *w, Py_ssize_t size) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 873 | |
Ezio Melotti | c1f0577 | 2011-04-14 07:50:25 +0300 | [diff] [blame] | 874 | Create a Unicode object from the :c:type:`wchar_t` buffer *w* of the given *size*. |
Ezio Melotti | 95cd91c | 2011-04-14 07:43:53 +0300 | [diff] [blame] | 875 | Passing -1 as the *size* indicates that the function must itself compute the length, |
Martin v. Löwis | 790465f | 2008-04-05 20:41:37 +0000 | [diff] [blame] | 876 | using wcslen. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 877 | Return *NULL* on failure. |
| 878 | |
| 879 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 880 | .. c:function:: Py_ssize_t PyUnicode_AsWideChar(PyUnicodeObject *unicode, wchar_t *w, Py_ssize_t size) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 881 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 882 | Copy the Unicode object contents into the :c:type:`wchar_t` buffer *w*. At most |
| 883 | *size* :c:type:`wchar_t` characters are copied (excluding a possibly trailing |
| 884 | 0-termination character). Return the number of :c:type:`wchar_t` characters |
Victor Stinner | 0d81c13 | 2011-12-18 19:30:55 +0100 | [diff] [blame] | 885 | copied or -1 in case of an error. Note that the resulting :c:type:`wchar_t*` |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 886 | string may or may not be 0-terminated. It is the responsibility of the caller |
Victor Stinner | 0d81c13 | 2011-12-18 19:30:55 +0100 | [diff] [blame] | 887 | to make sure that the :c:type:`wchar_t*` string is 0-terminated in case this is |
Victor Stinner | 6fbd525 | 2011-12-18 19:22:31 +0100 | [diff] [blame] | 888 | required by the application. Also, note that the :c:type:`wchar_t*` string |
| 889 | might contain null characters, which would cause the string to be truncated |
| 890 | when used with most C functions. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 891 | |
| 892 | |
Victor Stinner | beb4135b | 2010-10-07 01:02:42 +0000 | [diff] [blame] | 893 | .. c:function:: wchar_t* PyUnicode_AsWideCharString(PyObject *unicode, Py_ssize_t *size) |
Victor Stinner | 137c34c | 2010-09-29 10:25:54 +0000 | [diff] [blame] | 894 | |
| 895 | Convert the Unicode object to a wide character string. The output string |
| 896 | always ends with a nul character. If *size* is not *NULL*, write the number |
Victor Stinner | 1c24bd0 | 2010-10-02 11:03:13 +0000 | [diff] [blame] | 897 | of wide characters (excluding the trailing 0-termination character) into |
| 898 | *\*size*. |
Victor Stinner | 137c34c | 2010-09-29 10:25:54 +0000 | [diff] [blame] | 899 | |
Victor Stinner | 6fbd525 | 2011-12-18 19:22:31 +0100 | [diff] [blame] | 900 | Returns a buffer allocated by :c:func:`PyMem_Alloc` (use |
| 901 | :c:func:`PyMem_Free` to free it) on success. On error, returns *NULL*, |
| 902 | *\*size* is undefined and raises a :exc:`MemoryError`. Note that the |
Victor Stinner | 0d81c13 | 2011-12-18 19:30:55 +0100 | [diff] [blame] | 903 | resulting :c:type:`wchar_t` string might contain null characters, which |
Victor Stinner | 6fbd525 | 2011-12-18 19:22:31 +0100 | [diff] [blame] | 904 | would cause the string to be truncated when used with most C functions. |
Victor Stinner | 137c34c | 2010-09-29 10:25:54 +0000 | [diff] [blame] | 905 | |
| 906 | .. versionadded:: 3.2 |
| 907 | |
| 908 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 909 | UCS4 Support |
| 910 | """""""""""" |
| 911 | |
| 912 | .. versionadded:: 3.3 |
| 913 | |
| 914 | .. XXX are these meant to be public? |
| 915 | |
| 916 | .. c:function:: size_t Py_UCS4_strlen(const Py_UCS4 *u) |
| 917 | Py_UCS4* Py_UCS4_strcpy(Py_UCS4 *s1, const Py_UCS4 *s2) |
| 918 | Py_UCS4* Py_UCS4_strncpy(Py_UCS4 *s1, const Py_UCS4 *s2, size_t n) |
| 919 | Py_UCS4* Py_UCS4_strcat(Py_UCS4 *s1, const Py_UCS4 *s2) |
| 920 | int Py_UCS4_strcmp(const Py_UCS4 *s1, const Py_UCS4 *s2) |
| 921 | int Py_UCS4_strncmp(const Py_UCS4 *s1, const Py_UCS4 *s2, size_t n) |
Antoine Pitrou | 57735a0 | 2011-10-22 22:08:46 +0200 | [diff] [blame] | 922 | Py_UCS4* Py_UCS4_strchr(const Py_UCS4 *s, Py_UCS4 c) |
| 923 | Py_UCS4* Py_UCS4_strrchr(const Py_UCS4 *s, Py_UCS4 c) |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 924 | |
| 925 | These utility functions work on strings of :c:type:`Py_UCS4` characters and |
| 926 | otherwise behave like the C standard library functions with the same name. |
| 927 | |
| 928 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 929 | .. _builtincodecs: |
| 930 | |
| 931 | Built-in Codecs |
| 932 | ^^^^^^^^^^^^^^^ |
| 933 | |
Georg Brandl | 22b3431 | 2009-07-26 14:54:51 +0000 | [diff] [blame] | 934 | Python provides a set of built-in codecs which are written in C for speed. All of |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 935 | these codecs are directly usable via the following functions. |
| 936 | |
Ezio Melotti | 95cd91c | 2011-04-14 07:43:53 +0300 | [diff] [blame] | 937 | Many of the following APIs take two arguments encoding and errors, and they |
| 938 | have the same semantics as the ones of the built-in :func:`str` string object |
| 939 | constructor. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 940 | |
Martin v. Löwis | c15bdef | 2009-05-29 14:47:46 +0000 | [diff] [blame] | 941 | Setting encoding to *NULL* causes the default encoding to be used |
| 942 | which is ASCII. The file system calls should use |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 943 | :c:func:`PyUnicode_FSConverter` for encoding file names. This uses the |
| 944 | variable :c:data:`Py_FileSystemDefaultEncoding` internally. This |
Ezio Melotti | 95cd91c | 2011-04-14 07:43:53 +0300 | [diff] [blame] | 945 | variable should be treated as read-only: on some systems, it will be a |
Martin v. Löwis | c15bdef | 2009-05-29 14:47:46 +0000 | [diff] [blame] | 946 | pointer to a static string, on others, it will change at run-time |
| 947 | (such as when the application invokes setlocale). |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 948 | |
| 949 | Error handling is set by errors which may also be set to *NULL* meaning to use |
| 950 | the default handling defined for the codec. Default error handling for all |
Georg Brandl | 22b3431 | 2009-07-26 14:54:51 +0000 | [diff] [blame] | 951 | built-in codecs is "strict" (:exc:`ValueError` is raised). |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 952 | |
| 953 | The codecs all use a similar interface. Only deviation from the following |
| 954 | generic ones are documented for simplicity. |
| 955 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 956 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 957 | Generic Codecs |
| 958 | """""""""""""" |
| 959 | |
| 960 | These are the generic codec APIs: |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 961 | |
| 962 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 963 | .. c:function:: PyObject* PyUnicode_Decode(const char *s, Py_ssize_t size, \ |
| 964 | const char *encoding, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 965 | |
| 966 | Create a Unicode object by decoding *size* bytes of the encoded string *s*. |
| 967 | *encoding* and *errors* have the same meaning as the parameters of the same name |
Georg Brandl | 22b3431 | 2009-07-26 14:54:51 +0000 | [diff] [blame] | 968 | in the :func:`unicode` built-in function. The codec to be used is looked up |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 969 | using the Python codec registry. Return *NULL* if an exception was raised by |
| 970 | the codec. |
| 971 | |
| 972 | |
Antoine Pitrou | e6b99a1 | 2011-10-22 21:56:20 +0200 | [diff] [blame] | 973 | .. c:function:: PyObject* PyUnicode_AsEncodedString(PyObject *unicode, \ |
| 974 | const char *encoding, const char *errors) |
| 975 | |
| 976 | Encode a Unicode object and return the result as Python bytes object. |
| 977 | *encoding* and *errors* have the same meaning as the parameters of the same |
| 978 | name in the Unicode :meth:`encode` method. The codec to be used is looked up |
| 979 | using the Python codec registry. Return *NULL* if an exception was raised by |
| 980 | the codec. |
| 981 | |
| 982 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 983 | .. c:function:: PyObject* PyUnicode_Encode(const Py_UNICODE *s, Py_ssize_t size, \ |
| 984 | const char *encoding, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 985 | |
Ezio Melotti | c1f0577 | 2011-04-14 07:50:25 +0300 | [diff] [blame] | 986 | Encode the :c:type:`Py_UNICODE` buffer *s* of the given *size* and return a Python |
Benjamin Peterson | b6eba4f | 2009-01-13 23:14:04 +0000 | [diff] [blame] | 987 | bytes object. *encoding* and *errors* have the same meaning as the |
| 988 | parameters of the same name in the Unicode :meth:`encode` method. The codec |
| 989 | to be used is looked up using the Python codec registry. Return *NULL* if an |
| 990 | exception was raised by the codec. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 991 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 992 | .. deprecated-removed:: 3.3 4.0 |
| 993 | Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using |
| 994 | :c:func:`PyUnicode_AsEncodedString`. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 995 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 996 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 997 | UTF-8 Codecs |
| 998 | """""""""""" |
| 999 | |
| 1000 | These are the UTF-8 codec APIs: |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1001 | |
| 1002 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1003 | .. c:function:: PyObject* PyUnicode_DecodeUTF8(const char *s, Py_ssize_t size, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1004 | |
| 1005 | Create a Unicode object by decoding *size* bytes of the UTF-8 encoded string |
| 1006 | *s*. Return *NULL* if an exception was raised by the codec. |
| 1007 | |
| 1008 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1009 | .. c:function:: PyObject* PyUnicode_DecodeUTF8Stateful(const char *s, Py_ssize_t size, \ |
| 1010 | const char *errors, Py_ssize_t *consumed) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1011 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1012 | If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeUTF8`. If |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1013 | *consumed* is not *NULL*, trailing incomplete UTF-8 byte sequences will not be |
| 1014 | treated as an error. Those bytes will not be decoded and the number of bytes |
| 1015 | that have been decoded will be stored in *consumed*. |
| 1016 | |
| 1017 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1018 | .. c:function:: PyObject* PyUnicode_AsUTF8String(PyObject *unicode) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1019 | |
Benjamin Peterson | b6eba4f | 2009-01-13 23:14:04 +0000 | [diff] [blame] | 1020 | Encode a Unicode object using UTF-8 and return the result as Python bytes |
| 1021 | object. Error handling is "strict". Return *NULL* if an exception was |
| 1022 | raised by the codec. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1023 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1024 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1025 | .. c:function:: char* PyUnicode_AsUTF8AndSize(PyObject *unicode, Py_ssize_t *size) |
| 1026 | |
| 1027 | Return a pointer to the default encoding (UTF-8) of the Unicode object, and |
| 1028 | store the size of the encoded representation (in bytes) in *size*. *size* |
| 1029 | can be *NULL*, in this case no size will be stored. |
| 1030 | |
| 1031 | In the case of an error, *NULL* is returned with an exception set and no |
| 1032 | *size* is stored. |
| 1033 | |
| 1034 | This caches the UTF-8 representation of the string in the Unicode object, and |
| 1035 | subsequent calls will return a pointer to the same buffer. The caller is not |
| 1036 | responsible for deallocating the buffer. |
| 1037 | |
| 1038 | .. versionadded:: 3.3 |
| 1039 | |
| 1040 | |
| 1041 | .. c:function:: char* PyUnicode_AsUTF8(PyObject *unicode) |
| 1042 | |
| 1043 | As :c:func:`PyUnicode_AsUTF8AndSize`, but does not store the size. |
| 1044 | |
| 1045 | .. versionadded:: 3.3 |
| 1046 | |
| 1047 | |
Antoine Pitrou | e6b99a1 | 2011-10-22 21:56:20 +0200 | [diff] [blame] | 1048 | .. c:function:: PyObject* PyUnicode_EncodeUTF8(const Py_UNICODE *s, Py_ssize_t size, const char *errors) |
| 1049 | |
| 1050 | Encode the :c:type:`Py_UNICODE` buffer *s* of the given *size* using UTF-8 and |
| 1051 | return a Python bytes object. Return *NULL* if an exception was raised by |
| 1052 | the codec. |
| 1053 | |
| 1054 | .. deprecated-removed:: 3.3 4.0 |
| 1055 | Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using |
| 1056 | :c:func:`PyUnicode_AsUTF8String` or :c:func:`PyUnicode_AsUTF8AndSize`. |
| 1057 | |
| 1058 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 1059 | UTF-32 Codecs |
| 1060 | """"""""""""" |
| 1061 | |
| 1062 | These are the UTF-32 codec APIs: |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1063 | |
| 1064 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1065 | .. c:function:: PyObject* PyUnicode_DecodeUTF32(const char *s, Py_ssize_t size, \ |
| 1066 | const char *errors, int *byteorder) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1067 | |
Ezio Melotti | 95cd91c | 2011-04-14 07:43:53 +0300 | [diff] [blame] | 1068 | Decode *size* bytes from a UTF-32 encoded buffer string and return the |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1069 | corresponding Unicode object. *errors* (if non-*NULL*) defines the error |
| 1070 | handling. It defaults to "strict". |
| 1071 | |
| 1072 | If *byteorder* is non-*NULL*, the decoder starts decoding using the given byte |
| 1073 | order:: |
| 1074 | |
| 1075 | *byteorder == -1: little endian |
| 1076 | *byteorder == 0: native order |
| 1077 | *byteorder == 1: big endian |
| 1078 | |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 1079 | If ``*byteorder`` is zero, and the first four bytes of the input data are a |
| 1080 | byte order mark (BOM), the decoder switches to this byte order and the BOM is |
| 1081 | not copied into the resulting Unicode string. If ``*byteorder`` is ``-1`` or |
| 1082 | ``1``, any byte order mark is copied to the output. |
| 1083 | |
| 1084 | After completion, *\*byteorder* is set to the current byte order at the end |
| 1085 | of input data. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1086 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1087 | If *byteorder* is *NULL*, the codec starts in native order mode. |
| 1088 | |
| 1089 | Return *NULL* if an exception was raised by the codec. |
| 1090 | |
| 1091 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1092 | .. c:function:: PyObject* PyUnicode_DecodeUTF32Stateful(const char *s, Py_ssize_t size, \ |
| 1093 | const char *errors, int *byteorder, Py_ssize_t *consumed) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1094 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1095 | If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeUTF32`. If |
| 1096 | *consumed* is not *NULL*, :c:func:`PyUnicode_DecodeUTF32Stateful` will not treat |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1097 | trailing incomplete UTF-32 byte sequences (such as a number of bytes not divisible |
| 1098 | by four) as an error. Those bytes will not be decoded and the number of bytes |
| 1099 | that have been decoded will be stored in *consumed*. |
| 1100 | |
| 1101 | |
Antoine Pitrou | e6b99a1 | 2011-10-22 21:56:20 +0200 | [diff] [blame] | 1102 | .. c:function:: PyObject* PyUnicode_AsUTF32String(PyObject *unicode) |
| 1103 | |
| 1104 | Return a Python byte string using the UTF-32 encoding in native byte |
| 1105 | order. The string always starts with a BOM mark. Error handling is "strict". |
| 1106 | Return *NULL* if an exception was raised by the codec. |
| 1107 | |
| 1108 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1109 | .. c:function:: PyObject* PyUnicode_EncodeUTF32(const Py_UNICODE *s, Py_ssize_t size, \ |
| 1110 | const char *errors, int byteorder) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1111 | |
| 1112 | Return a Python bytes object holding the UTF-32 encoded value of the Unicode |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 1113 | data in *s*. Output is written according to the following byte order:: |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1114 | |
| 1115 | byteorder == -1: little endian |
| 1116 | byteorder == 0: native byte order (writes a BOM mark) |
| 1117 | byteorder == 1: big endian |
| 1118 | |
| 1119 | If byteorder is ``0``, the output string will always start with the Unicode BOM |
| 1120 | mark (U+FEFF). In the other two modes, no BOM mark is prepended. |
| 1121 | |
| 1122 | If *Py_UNICODE_WIDE* is not defined, surrogate pairs will be output |
| 1123 | as a single codepoint. |
| 1124 | |
| 1125 | Return *NULL* if an exception was raised by the codec. |
| 1126 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1127 | .. deprecated-removed:: 3.3 4.0 |
| 1128 | Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using |
| 1129 | :c:func:`PyUnicode_AsUTF32String`. |
| 1130 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1131 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 1132 | UTF-16 Codecs |
| 1133 | """"""""""""" |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1134 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 1135 | These are the UTF-16 codec APIs: |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1136 | |
| 1137 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1138 | .. c:function:: PyObject* PyUnicode_DecodeUTF16(const char *s, Py_ssize_t size, \ |
| 1139 | const char *errors, int *byteorder) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1140 | |
Ezio Melotti | 95cd91c | 2011-04-14 07:43:53 +0300 | [diff] [blame] | 1141 | Decode *size* bytes from a UTF-16 encoded buffer string and return the |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1142 | corresponding Unicode object. *errors* (if non-*NULL*) defines the error |
| 1143 | handling. It defaults to "strict". |
| 1144 | |
| 1145 | If *byteorder* is non-*NULL*, the decoder starts decoding using the given byte |
| 1146 | order:: |
| 1147 | |
| 1148 | *byteorder == -1: little endian |
| 1149 | *byteorder == 0: native order |
| 1150 | *byteorder == 1: big endian |
| 1151 | |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 1152 | If ``*byteorder`` is zero, and the first two bytes of the input data are a |
| 1153 | byte order mark (BOM), the decoder switches to this byte order and the BOM is |
| 1154 | not copied into the resulting Unicode string. If ``*byteorder`` is ``-1`` or |
| 1155 | ``1``, any byte order mark is copied to the output (where it will result in |
| 1156 | either a ``\ufeff`` or a ``\ufffe`` character). |
| 1157 | |
| 1158 | After completion, *\*byteorder* is set to the current byte order at the end |
| 1159 | of input data. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1160 | |
| 1161 | If *byteorder* is *NULL*, the codec starts in native order mode. |
| 1162 | |
| 1163 | Return *NULL* if an exception was raised by the codec. |
| 1164 | |
| 1165 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1166 | .. c:function:: PyObject* PyUnicode_DecodeUTF16Stateful(const char *s, Py_ssize_t size, \ |
| 1167 | const char *errors, int *byteorder, Py_ssize_t *consumed) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1168 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1169 | If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeUTF16`. If |
| 1170 | *consumed* is not *NULL*, :c:func:`PyUnicode_DecodeUTF16Stateful` will not treat |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1171 | trailing incomplete UTF-16 byte sequences (such as an odd number of bytes or a |
| 1172 | split surrogate pair) as an error. Those bytes will not be decoded and the |
| 1173 | number of bytes that have been decoded will be stored in *consumed*. |
| 1174 | |
| 1175 | |
Antoine Pitrou | e6b99a1 | 2011-10-22 21:56:20 +0200 | [diff] [blame] | 1176 | .. c:function:: PyObject* PyUnicode_AsUTF16String(PyObject *unicode) |
| 1177 | |
| 1178 | Return a Python byte string using the UTF-16 encoding in native byte |
| 1179 | order. The string always starts with a BOM mark. Error handling is "strict". |
| 1180 | Return *NULL* if an exception was raised by the codec. |
| 1181 | |
| 1182 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1183 | .. c:function:: PyObject* PyUnicode_EncodeUTF16(const Py_UNICODE *s, Py_ssize_t size, \ |
| 1184 | const char *errors, int byteorder) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1185 | |
Benjamin Peterson | b6eba4f | 2009-01-13 23:14:04 +0000 | [diff] [blame] | 1186 | Return a Python bytes object holding the UTF-16 encoded value of the Unicode |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 1187 | data in *s*. Output is written according to the following byte order:: |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1188 | |
| 1189 | byteorder == -1: little endian |
| 1190 | byteorder == 0: native byte order (writes a BOM mark) |
| 1191 | byteorder == 1: big endian |
| 1192 | |
| 1193 | If byteorder is ``0``, the output string will always start with the Unicode BOM |
| 1194 | mark (U+FEFF). In the other two modes, no BOM mark is prepended. |
| 1195 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1196 | If *Py_UNICODE_WIDE* is defined, a single :c:type:`Py_UNICODE` value may get |
| 1197 | represented as a surrogate pair. If it is not defined, each :c:type:`Py_UNICODE` |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1198 | values is interpreted as an UCS-2 character. |
| 1199 | |
| 1200 | Return *NULL* if an exception was raised by the codec. |
| 1201 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1202 | .. deprecated-removed:: 3.3 4.0 |
| 1203 | Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using |
| 1204 | :c:func:`PyUnicode_AsUTF16String`. |
| 1205 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1206 | |
Georg Brandl | 8477f82 | 2010-08-02 20:05:19 +0000 | [diff] [blame] | 1207 | UTF-7 Codecs |
| 1208 | """""""""""" |
| 1209 | |
| 1210 | These are the UTF-7 codec APIs: |
| 1211 | |
| 1212 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1213 | .. c:function:: PyObject* PyUnicode_DecodeUTF7(const char *s, Py_ssize_t size, const char *errors) |
Georg Brandl | 8477f82 | 2010-08-02 20:05:19 +0000 | [diff] [blame] | 1214 | |
| 1215 | Create a Unicode object by decoding *size* bytes of the UTF-7 encoded string |
| 1216 | *s*. Return *NULL* if an exception was raised by the codec. |
| 1217 | |
| 1218 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1219 | .. c:function:: PyObject* PyUnicode_DecodeUTF7Stateful(const char *s, Py_ssize_t size, \ |
| 1220 | const char *errors, Py_ssize_t *consumed) |
Georg Brandl | 8477f82 | 2010-08-02 20:05:19 +0000 | [diff] [blame] | 1221 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1222 | If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeUTF7`. If |
Georg Brandl | 8477f82 | 2010-08-02 20:05:19 +0000 | [diff] [blame] | 1223 | *consumed* is not *NULL*, trailing incomplete UTF-7 base-64 sections will not |
| 1224 | be treated as an error. Those bytes will not be decoded and the number of |
| 1225 | bytes that have been decoded will be stored in *consumed*. |
| 1226 | |
| 1227 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1228 | .. c:function:: PyObject* PyUnicode_EncodeUTF7(const Py_UNICODE *s, Py_ssize_t size, \ |
| 1229 | int base64SetO, int base64WhiteSpace, const char *errors) |
Georg Brandl | 8477f82 | 2010-08-02 20:05:19 +0000 | [diff] [blame] | 1230 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1231 | Encode the :c:type:`Py_UNICODE` buffer of the given size using UTF-7 and |
Georg Brandl | 8477f82 | 2010-08-02 20:05:19 +0000 | [diff] [blame] | 1232 | return a Python bytes object. Return *NULL* if an exception was raised by |
| 1233 | the codec. |
| 1234 | |
| 1235 | If *base64SetO* is nonzero, "Set O" (punctuation that has no otherwise |
| 1236 | special meaning) will be encoded in base-64. If *base64WhiteSpace* is |
| 1237 | nonzero, whitespace will be encoded in base-64. Both are set to zero for the |
| 1238 | Python "utf-7" codec. |
| 1239 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1240 | .. deprecated-removed:: 3.3 4.0 |
| 1241 | Part of the old-style :c:type:`Py_UNICODE` API. |
| 1242 | |
| 1243 | .. XXX replace with what? |
| 1244 | |
Georg Brandl | 8477f82 | 2010-08-02 20:05:19 +0000 | [diff] [blame] | 1245 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 1246 | Unicode-Escape Codecs |
| 1247 | """"""""""""""""""""" |
| 1248 | |
| 1249 | These are the "Unicode Escape" codec APIs: |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1250 | |
| 1251 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1252 | .. c:function:: PyObject* PyUnicode_DecodeUnicodeEscape(const char *s, \ |
| 1253 | Py_ssize_t size, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1254 | |
| 1255 | Create a Unicode object by decoding *size* bytes of the Unicode-Escape encoded |
| 1256 | string *s*. Return *NULL* if an exception was raised by the codec. |
| 1257 | |
| 1258 | |
Antoine Pitrou | e6b99a1 | 2011-10-22 21:56:20 +0200 | [diff] [blame] | 1259 | .. c:function:: PyObject* PyUnicode_AsUnicodeEscapeString(PyObject *unicode) |
| 1260 | |
| 1261 | Encode a Unicode object using Unicode-Escape and return the result as Python |
| 1262 | string object. Error handling is "strict". Return *NULL* if an exception was |
| 1263 | raised by the codec. |
| 1264 | |
| 1265 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1266 | .. c:function:: PyObject* PyUnicode_EncodeUnicodeEscape(const Py_UNICODE *s, Py_ssize_t size) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1267 | |
Ezio Melotti | c1f0577 | 2011-04-14 07:50:25 +0300 | [diff] [blame] | 1268 | Encode the :c:type:`Py_UNICODE` buffer of the given *size* using Unicode-Escape and |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1269 | return a Python string object. Return *NULL* if an exception was raised by the |
| 1270 | codec. |
| 1271 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1272 | .. deprecated-removed:: 3.3 4.0 |
| 1273 | Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using |
| 1274 | :c:func:`PyUnicode_AsUnicodeEscapeString`. |
| 1275 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1276 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 1277 | Raw-Unicode-Escape Codecs |
| 1278 | """"""""""""""""""""""""" |
| 1279 | |
| 1280 | These are the "Raw Unicode Escape" codec APIs: |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1281 | |
| 1282 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1283 | .. c:function:: PyObject* PyUnicode_DecodeRawUnicodeEscape(const char *s, \ |
| 1284 | Py_ssize_t size, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1285 | |
| 1286 | Create a Unicode object by decoding *size* bytes of the Raw-Unicode-Escape |
| 1287 | encoded string *s*. Return *NULL* if an exception was raised by the codec. |
| 1288 | |
| 1289 | |
Antoine Pitrou | e6b99a1 | 2011-10-22 21:56:20 +0200 | [diff] [blame] | 1290 | .. c:function:: PyObject* PyUnicode_AsRawUnicodeEscapeString(PyObject *unicode) |
| 1291 | |
| 1292 | Encode a Unicode object using Raw-Unicode-Escape and return the result as |
| 1293 | Python string object. Error handling is "strict". Return *NULL* if an exception |
| 1294 | was raised by the codec. |
| 1295 | |
| 1296 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1297 | .. c:function:: PyObject* PyUnicode_EncodeRawUnicodeEscape(const Py_UNICODE *s, \ |
| 1298 | Py_ssize_t size, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1299 | |
Ezio Melotti | c1f0577 | 2011-04-14 07:50:25 +0300 | [diff] [blame] | 1300 | Encode the :c:type:`Py_UNICODE` buffer of the given *size* using Raw-Unicode-Escape |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1301 | and return a Python string object. Return *NULL* if an exception was raised by |
| 1302 | the codec. |
| 1303 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1304 | .. deprecated-removed:: 3.3 4.0 |
| 1305 | Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using |
| 1306 | :c:func:`PyUnicode_AsRawUnicodeEscapeString`. |
| 1307 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1308 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 1309 | Latin-1 Codecs |
| 1310 | """""""""""""" |
| 1311 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1312 | These are the Latin-1 codec APIs: Latin-1 corresponds to the first 256 Unicode |
| 1313 | ordinals and only these are accepted by the codecs during encoding. |
| 1314 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1315 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1316 | .. c:function:: PyObject* PyUnicode_DecodeLatin1(const char *s, Py_ssize_t size, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1317 | |
| 1318 | Create a Unicode object by decoding *size* bytes of the Latin-1 encoded string |
| 1319 | *s*. Return *NULL* if an exception was raised by the codec. |
| 1320 | |
| 1321 | |
Antoine Pitrou | e6b99a1 | 2011-10-22 21:56:20 +0200 | [diff] [blame] | 1322 | .. c:function:: PyObject* PyUnicode_AsLatin1String(PyObject *unicode) |
| 1323 | |
| 1324 | Encode a Unicode object using Latin-1 and return the result as Python bytes |
| 1325 | object. Error handling is "strict". Return *NULL* if an exception was |
| 1326 | raised by the codec. |
| 1327 | |
| 1328 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1329 | .. c:function:: PyObject* PyUnicode_EncodeLatin1(const Py_UNICODE *s, Py_ssize_t size, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1330 | |
Ezio Melotti | c1f0577 | 2011-04-14 07:50:25 +0300 | [diff] [blame] | 1331 | Encode the :c:type:`Py_UNICODE` buffer of the given *size* using Latin-1 and |
Benjamin Peterson | b6eba4f | 2009-01-13 23:14:04 +0000 | [diff] [blame] | 1332 | return a Python bytes object. Return *NULL* if an exception was raised by |
| 1333 | the codec. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1334 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1335 | .. deprecated-removed:: 3.3 4.0 |
| 1336 | Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using |
| 1337 | :c:func:`PyUnicode_AsLatin1String`. |
| 1338 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1339 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 1340 | ASCII Codecs |
| 1341 | """""""""""" |
| 1342 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1343 | These are the ASCII codec APIs. Only 7-bit ASCII data is accepted. All other |
| 1344 | codes generate errors. |
| 1345 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1346 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1347 | .. c:function:: PyObject* PyUnicode_DecodeASCII(const char *s, Py_ssize_t size, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1348 | |
| 1349 | Create a Unicode object by decoding *size* bytes of the ASCII encoded string |
| 1350 | *s*. Return *NULL* if an exception was raised by the codec. |
| 1351 | |
| 1352 | |
Antoine Pitrou | e6b99a1 | 2011-10-22 21:56:20 +0200 | [diff] [blame] | 1353 | .. c:function:: PyObject* PyUnicode_AsASCIIString(PyObject *unicode) |
| 1354 | |
| 1355 | Encode a Unicode object using ASCII and return the result as Python bytes |
| 1356 | object. Error handling is "strict". Return *NULL* if an exception was |
| 1357 | raised by the codec. |
| 1358 | |
| 1359 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1360 | .. c:function:: PyObject* PyUnicode_EncodeASCII(const Py_UNICODE *s, Py_ssize_t size, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1361 | |
Ezio Melotti | c1f0577 | 2011-04-14 07:50:25 +0300 | [diff] [blame] | 1362 | Encode the :c:type:`Py_UNICODE` buffer of the given *size* using ASCII and |
Benjamin Peterson | b6eba4f | 2009-01-13 23:14:04 +0000 | [diff] [blame] | 1363 | return a Python bytes object. Return *NULL* if an exception was raised by |
| 1364 | the codec. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1365 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1366 | .. deprecated-removed:: 3.3 4.0 |
| 1367 | Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using |
| 1368 | :c:func:`PyUnicode_AsASCIIString`. |
| 1369 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1370 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 1371 | Character Map Codecs |
| 1372 | """""""""""""""""""" |
| 1373 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1374 | This codec is special in that it can be used to implement many different codecs |
| 1375 | (and this is in fact what was done to obtain most of the standard codecs |
| 1376 | included in the :mod:`encodings` package). The codec uses mapping to encode and |
| 1377 | decode characters. |
| 1378 | |
| 1379 | Decoding mappings must map single string characters to single Unicode |
| 1380 | characters, integers (which are then interpreted as Unicode ordinals) or None |
| 1381 | (meaning "undefined mapping" and causing an error). |
| 1382 | |
| 1383 | Encoding mappings must map single Unicode characters to single string |
| 1384 | characters, integers (which are then interpreted as Latin-1 ordinals) or None |
| 1385 | (meaning "undefined mapping" and causing an error). |
| 1386 | |
| 1387 | The mapping objects provided must only support the __getitem__ mapping |
| 1388 | interface. |
| 1389 | |
| 1390 | If a character lookup fails with a LookupError, the character is copied as-is |
| 1391 | meaning that its ordinal value will be interpreted as Unicode or Latin-1 ordinal |
| 1392 | resp. Because of this, mappings only need to contain those mappings which map |
| 1393 | characters to different code points. |
| 1394 | |
Ezio Melotti | 95cd91c | 2011-04-14 07:43:53 +0300 | [diff] [blame] | 1395 | These are the mapping codec APIs: |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1396 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1397 | .. c:function:: PyObject* PyUnicode_DecodeCharmap(const char *s, Py_ssize_t size, \ |
| 1398 | PyObject *mapping, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1399 | |
| 1400 | Create a Unicode object by decoding *size* bytes of the encoded string *s* using |
| 1401 | the given *mapping* object. Return *NULL* if an exception was raised by the |
| 1402 | codec. If *mapping* is *NULL* latin-1 decoding will be done. Else it can be a |
| 1403 | dictionary mapping byte or a unicode string, which is treated as a lookup table. |
| 1404 | Byte values greater that the length of the string and U+FFFE "characters" are |
| 1405 | treated as "undefined mapping". |
| 1406 | |
| 1407 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1408 | .. c:function:: PyObject* PyUnicode_AsCharmapString(PyObject *unicode, PyObject *mapping) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1409 | |
| 1410 | Encode a Unicode object using the given *mapping* object and return the result |
| 1411 | as Python string object. Error handling is "strict". Return *NULL* if an |
| 1412 | exception was raised by the codec. |
| 1413 | |
| 1414 | The following codec API is special in that maps Unicode to Unicode. |
| 1415 | |
| 1416 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1417 | .. c:function:: PyObject* PyUnicode_TranslateCharmap(const Py_UNICODE *s, Py_ssize_t size, \ |
| 1418 | PyObject *table, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1419 | |
Ezio Melotti | c1f0577 | 2011-04-14 07:50:25 +0300 | [diff] [blame] | 1420 | Translate a :c:type:`Py_UNICODE` buffer of the given *size* by applying a |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1421 | character mapping *table* to it and return the resulting Unicode object. Return |
| 1422 | *NULL* when an exception was raised by the codec. |
| 1423 | |
| 1424 | The *mapping* table must map Unicode ordinal integers to Unicode ordinal |
| 1425 | integers or None (causing deletion of the character). |
| 1426 | |
| 1427 | Mapping tables need only provide the :meth:`__getitem__` interface; dictionaries |
| 1428 | and sequences work well. Unmapped character ordinals (ones which cause a |
| 1429 | :exc:`LookupError`) are left untouched and are copied as-is. |
| 1430 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1431 | .. deprecated-removed:: 3.3 4.0 |
| 1432 | Part of the old-style :c:type:`Py_UNICODE` API. |
| 1433 | |
| 1434 | .. XXX replace with what? |
Jeroen Ruigrok van der Werven | 47a7d70 | 2009-04-27 05:43:17 +0000 | [diff] [blame] | 1435 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 1436 | |
Antoine Pitrou | e6b99a1 | 2011-10-22 21:56:20 +0200 | [diff] [blame] | 1437 | .. c:function:: PyObject* PyUnicode_EncodeCharmap(const Py_UNICODE *s, Py_ssize_t size, \ |
| 1438 | PyObject *mapping, const char *errors) |
| 1439 | |
| 1440 | Encode the :c:type:`Py_UNICODE` buffer of the given *size* using the given |
| 1441 | *mapping* object and return a Python string object. Return *NULL* if an |
| 1442 | exception was raised by the codec. |
| 1443 | |
| 1444 | .. deprecated-removed:: 3.3 4.0 |
| 1445 | Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using |
| 1446 | :c:func:`PyUnicode_AsCharmapString`. |
| 1447 | |
| 1448 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 1449 | MBCS codecs for Windows |
| 1450 | """"""""""""""""""""""" |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1451 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1452 | These are the MBCS codec APIs. They are currently only available on Windows and |
| 1453 | use the Win32 MBCS converters to implement the conversions. Note that MBCS (or |
| 1454 | DBCS) is a class of encodings, not just one. The target encoding is defined by |
| 1455 | the user settings on the machine running the codec. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1456 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1457 | .. c:function:: PyObject* PyUnicode_DecodeMBCS(const char *s, Py_ssize_t size, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1458 | |
| 1459 | Create a Unicode object by decoding *size* bytes of the MBCS encoded string *s*. |
| 1460 | Return *NULL* if an exception was raised by the codec. |
| 1461 | |
| 1462 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1463 | .. c:function:: PyObject* PyUnicode_DecodeMBCSStateful(const char *s, int size, \ |
| 1464 | const char *errors, int *consumed) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1465 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1466 | If *consumed* is *NULL*, behave like :c:func:`PyUnicode_DecodeMBCS`. If |
| 1467 | *consumed* is not *NULL*, :c:func:`PyUnicode_DecodeMBCSStateful` will not decode |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1468 | trailing lead byte and the number of bytes that have been decoded will be stored |
| 1469 | in *consumed*. |
| 1470 | |
| 1471 | |
Antoine Pitrou | e6b99a1 | 2011-10-22 21:56:20 +0200 | [diff] [blame] | 1472 | .. c:function:: PyObject* PyUnicode_AsMBCSString(PyObject *unicode) |
| 1473 | |
| 1474 | Encode a Unicode object using MBCS and return the result as Python bytes |
| 1475 | object. Error handling is "strict". Return *NULL* if an exception was |
| 1476 | raised by the codec. |
| 1477 | |
| 1478 | |
Victor Stinner | b682101 | 2011-12-09 00:18:11 +0100 | [diff] [blame] | 1479 | .. c:function:: PyObject* PyUnicode_EncodeCodePage(int code_page, PyObject *unicode, const char *errors) |
| 1480 | |
| 1481 | Encode the Unicode object using the specified code page and return a Python |
| 1482 | bytes object. Return *NULL* if an exception was raised by the codec. Use |
| 1483 | :c:data:`CP_ACP` code page to get the MBCS encoder. |
| 1484 | |
| 1485 | .. versionadded:: 3.3 |
| 1486 | |
| 1487 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1488 | .. c:function:: PyObject* PyUnicode_EncodeMBCS(const Py_UNICODE *s, Py_ssize_t size, const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1489 | |
Ezio Melotti | c1f0577 | 2011-04-14 07:50:25 +0300 | [diff] [blame] | 1490 | Encode the :c:type:`Py_UNICODE` buffer of the given *size* using MBCS and return |
Benjamin Peterson | b6eba4f | 2009-01-13 23:14:04 +0000 | [diff] [blame] | 1491 | a Python bytes object. Return *NULL* if an exception was raised by the |
| 1492 | codec. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1493 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1494 | .. deprecated-removed:: 3.3 4.0 |
| 1495 | Part of the old-style :c:type:`Py_UNICODE` API; please migrate to using |
Victor Stinner | b682101 | 2011-12-09 00:18:11 +0100 | [diff] [blame] | 1496 | :c:func:`PyUnicode_AsMBCSString` or :c:func:`PyUnicode_EncodeCodePage`. |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1497 | |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1498 | |
Victor Stinner | 77c3862 | 2010-05-14 15:58:55 +0000 | [diff] [blame] | 1499 | Methods & Slots |
| 1500 | """"""""""""""" |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1501 | |
| 1502 | |
| 1503 | .. _unicodemethodsandslots: |
| 1504 | |
| 1505 | Methods and Slot Functions |
| 1506 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 1507 | |
| 1508 | The following APIs are capable of handling Unicode objects and strings on input |
| 1509 | (we refer to them as strings in the descriptions) and return Unicode objects or |
| 1510 | integers as appropriate. |
| 1511 | |
| 1512 | They all return *NULL* or ``-1`` if an exception occurs. |
| 1513 | |
| 1514 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1515 | .. c:function:: PyObject* PyUnicode_Concat(PyObject *left, PyObject *right) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1516 | |
| 1517 | Concat two strings giving a new Unicode string. |
| 1518 | |
| 1519 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1520 | .. c:function:: PyObject* PyUnicode_Split(PyObject *s, PyObject *sep, Py_ssize_t maxsplit) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1521 | |
Ezio Melotti | 95cd91c | 2011-04-14 07:43:53 +0300 | [diff] [blame] | 1522 | Split a string giving a list of Unicode strings. If *sep* is *NULL*, splitting |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1523 | will be done at all whitespace substrings. Otherwise, splits occur at the given |
| 1524 | separator. At most *maxsplit* splits will be done. If negative, no limit is |
| 1525 | set. Separators are not included in the resulting list. |
| 1526 | |
| 1527 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1528 | .. c:function:: PyObject* PyUnicode_Splitlines(PyObject *s, int keepend) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1529 | |
| 1530 | Split a Unicode string at line breaks, returning a list of Unicode strings. |
| 1531 | CRLF is considered to be one line break. If *keepend* is 0, the Line break |
| 1532 | characters are not included in the resulting strings. |
| 1533 | |
| 1534 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1535 | .. c:function:: PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, \ |
| 1536 | const char *errors) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1537 | |
| 1538 | Translate a string by applying a character mapping table to it and return the |
| 1539 | resulting Unicode object. |
| 1540 | |
| 1541 | The mapping table must map Unicode ordinal integers to Unicode ordinal integers |
| 1542 | or None (causing deletion of the character). |
| 1543 | |
| 1544 | Mapping tables need only provide the :meth:`__getitem__` interface; dictionaries |
| 1545 | and sequences work well. Unmapped character ordinals (ones which cause a |
| 1546 | :exc:`LookupError`) are left untouched and are copied as-is. |
| 1547 | |
| 1548 | *errors* has the usual meaning for codecs. It may be *NULL* which indicates to |
| 1549 | use the default error handling. |
| 1550 | |
| 1551 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1552 | .. c:function:: PyObject* PyUnicode_Join(PyObject *separator, PyObject *seq) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1553 | |
Ezio Melotti | 95cd91c | 2011-04-14 07:43:53 +0300 | [diff] [blame] | 1554 | Join a sequence of strings using the given *separator* and return the resulting |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1555 | Unicode string. |
| 1556 | |
| 1557 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1558 | .. c:function:: int PyUnicode_Tailmatch(PyObject *str, PyObject *substr, \ |
| 1559 | Py_ssize_t start, Py_ssize_t end, int direction) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1560 | |
Ezio Melotti | 95cd91c | 2011-04-14 07:43:53 +0300 | [diff] [blame] | 1561 | Return 1 if *substr* matches ``str[start:end]`` at the given tail end |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1562 | (*direction* == -1 means to do a prefix match, *direction* == 1 a suffix match), |
| 1563 | 0 otherwise. Return ``-1`` if an error occurred. |
| 1564 | |
| 1565 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1566 | .. c:function:: Py_ssize_t PyUnicode_Find(PyObject *str, PyObject *substr, \ |
| 1567 | Py_ssize_t start, Py_ssize_t end, int direction) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1568 | |
Ezio Melotti | 95cd91c | 2011-04-14 07:43:53 +0300 | [diff] [blame] | 1569 | Return the first position of *substr* in ``str[start:end]`` using the given |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1570 | *direction* (*direction* == 1 means to do a forward search, *direction* == -1 a |
| 1571 | backward search). The return value is the index of the first match; a value of |
| 1572 | ``-1`` indicates that no match was found, and ``-2`` indicates that an error |
| 1573 | occurred and an exception has been set. |
| 1574 | |
| 1575 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1576 | .. c:function:: Py_ssize_t PyUnicode_FindChar(PyObject *str, Py_UCS4 ch, \ |
| 1577 | Py_ssize_t start, Py_ssize_t end, int direction) |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 1578 | |
| 1579 | Return the first position of the character *ch* in ``str[start:end]`` using |
| 1580 | the given *direction* (*direction* == 1 means to do a forward search, |
| 1581 | *direction* == -1 a backward search). The return value is the index of the |
| 1582 | first match; a value of ``-1`` indicates that no match was found, and ``-2`` |
| 1583 | indicates that an error occurred and an exception has been set. |
| 1584 | |
Georg Brandl | ee12f44 | 2011-09-28 21:51:06 +0200 | [diff] [blame] | 1585 | .. versionadded:: 3.3 |
| 1586 | |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 1587 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1588 | .. c:function:: Py_ssize_t PyUnicode_Count(PyObject *str, PyObject *substr, \ |
| 1589 | Py_ssize_t start, Py_ssize_t end) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1590 | |
| 1591 | Return the number of non-overlapping occurrences of *substr* in |
| 1592 | ``str[start:end]``. Return ``-1`` if an error occurred. |
| 1593 | |
| 1594 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1595 | .. c:function:: PyObject* PyUnicode_Replace(PyObject *str, PyObject *substr, \ |
| 1596 | PyObject *replstr, Py_ssize_t maxcount) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1597 | |
| 1598 | Replace at most *maxcount* occurrences of *substr* in *str* with *replstr* and |
| 1599 | return the resulting Unicode object. *maxcount* == -1 means replace all |
| 1600 | occurrences. |
| 1601 | |
| 1602 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1603 | .. c:function:: int PyUnicode_Compare(PyObject *left, PyObject *right) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1604 | |
| 1605 | Compare two strings and return -1, 0, 1 for less than, equal, and greater than, |
| 1606 | respectively. |
| 1607 | |
| 1608 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1609 | .. c:function:: int PyUnicode_CompareWithASCIIString(PyObject *uni, char *string) |
Benjamin Peterson | c22ed14 | 2008-07-01 19:12:34 +0000 | [diff] [blame] | 1610 | |
| 1611 | Compare a unicode object, *uni*, with *string* and return -1, 0, 1 for less |
Victor Stinner | 80e788a | 2010-12-28 23:39:51 +0000 | [diff] [blame] | 1612 | than, equal, and greater than, respectively. It is best to pass only |
| 1613 | ASCII-encoded strings, but the function interprets the input string as |
| 1614 | ISO-8859-1 if it contains non-ASCII characters". |
Benjamin Peterson | c22ed14 | 2008-07-01 19:12:34 +0000 | [diff] [blame] | 1615 | |
| 1616 | |
Eli Bendersky | 0813168 | 2012-06-03 08:07:47 +0300 | [diff] [blame] | 1617 | .. c:function:: PyObject* PyUnicode_RichCompare(PyObject *left, PyObject *right, int op) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1618 | |
| 1619 | Rich compare two unicode strings and return one of the following: |
| 1620 | |
| 1621 | * ``NULL`` in case an exception was raised |
| 1622 | * :const:`Py_True` or :const:`Py_False` for successful comparisons |
| 1623 | * :const:`Py_NotImplemented` in case the type combination is unknown |
| 1624 | |
| 1625 | Note that :const:`Py_EQ` and :const:`Py_NE` comparisons can cause a |
| 1626 | :exc:`UnicodeWarning` in case the conversion of the arguments to Unicode fails |
| 1627 | with a :exc:`UnicodeDecodeError`. |
| 1628 | |
| 1629 | Possible values for *op* are :const:`Py_GT`, :const:`Py_GE`, :const:`Py_EQ`, |
| 1630 | :const:`Py_NE`, :const:`Py_LT`, and :const:`Py_LE`. |
| 1631 | |
| 1632 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1633 | .. c:function:: PyObject* PyUnicode_Format(PyObject *format, PyObject *args) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1634 | |
| 1635 | Return a new string object from *format* and *args*; this is analogous to |
| 1636 | ``format % args``. The *args* argument must be a tuple. |
| 1637 | |
| 1638 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1639 | .. c:function:: int PyUnicode_Contains(PyObject *container, PyObject *element) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1640 | |
| 1641 | Check whether *element* is contained in *container* and return true or false |
| 1642 | accordingly. |
| 1643 | |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1644 | *element* has to coerce to a one element Unicode string. ``-1`` is returned |
| 1645 | if there was an error. |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1646 | |
| 1647 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1648 | .. c:function:: void PyUnicode_InternInPlace(PyObject **string) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1649 | |
| 1650 | Intern the argument *\*string* in place. The argument must be the address of a |
| 1651 | pointer variable pointing to a Python unicode string object. If there is an |
| 1652 | existing interned string that is the same as *\*string*, it sets *\*string* to |
| 1653 | it (decrementing the reference count of the old string object and incrementing |
| 1654 | the reference count of the interned string object), otherwise it leaves |
| 1655 | *\*string* alone and interns it (incrementing its reference count). |
| 1656 | (Clarification: even though there is a lot of talk about reference counts, think |
| 1657 | of this function as reference-count-neutral; you own the object after the call |
| 1658 | if and only if you owned it before the call.) |
| 1659 | |
| 1660 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1661 | .. c:function:: PyObject* PyUnicode_InternFromString(const char *v) |
Georg Brandl | 54a3faa | 2008-01-20 09:30:57 +0000 | [diff] [blame] | 1662 | |
Georg Brandl | 60203b4 | 2010-10-06 10:11:56 +0000 | [diff] [blame] | 1663 | A combination of :c:func:`PyUnicode_FromString` and |
Georg Brandl | db6c7f5 | 2011-10-07 11:19:11 +0200 | [diff] [blame] | 1664 | :c:func:`PyUnicode_InternInPlace`, returning either a new unicode string |
| 1665 | object that has been interned, or a new ("owned") reference to an earlier |
| 1666 | interned string object with the same value. |