Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 1 | **************************** |
| 2 | What's New In Python 3.10 |
| 3 | **************************** |
| 4 | |
| 5 | :Release: |release| |
| 6 | :Date: |today| |
| 7 | |
| 8 | .. Rules for maintenance: |
| 9 | |
| 10 | * Anyone can add text to this document. Do not spend very much time |
| 11 | on the wording of your changes, because your text will probably |
| 12 | get rewritten to some degree. |
| 13 | |
| 14 | * The maintainer will go through Misc/NEWS periodically and add |
| 15 | changes; it's therefore more important to add your changes to |
| 16 | Misc/NEWS than to this file. |
| 17 | |
| 18 | * This is not a complete list of every single change; completeness |
| 19 | is the purpose of Misc/NEWS. Some changes I consider too small |
| 20 | or esoteric to include. If such a change is added to the text, |
| 21 | I'll just remove it. (This is another reason you shouldn't spend |
| 22 | too much time on writing your addition.) |
| 23 | |
| 24 | * If you want to draw your new text to the attention of the |
| 25 | maintainer, add 'XXX' to the beginning of the paragraph or |
| 26 | section. |
| 27 | |
| 28 | * It's OK to just add a fragmentary note about a change. For |
| 29 | example: "XXX Describe the transmogrify() function added to the |
| 30 | socket module." The maintainer will research the change and |
| 31 | write the necessary text. |
| 32 | |
| 33 | * You can comment out your additions if you like, but it's not |
| 34 | necessary (especially when a final release is some months away). |
| 35 | |
| 36 | * Credit the author of a patch or bugfix. Just the name is |
| 37 | sufficient; the e-mail address isn't necessary. |
| 38 | |
| 39 | * It's helpful to add the bug/patch number as a comment: |
| 40 | |
| 41 | XXX Describe the transmogrify() function added to the socket |
| 42 | module. |
| 43 | (Contributed by P.Y. Developer in :issue:`12345`.) |
| 44 | |
| 45 | This saves the maintainer the effort of going through the Mercurial log |
| 46 | when researching a change. |
| 47 | |
| 48 | This article explains the new features in Python 3.10, compared to 3.9. |
| 49 | |
Ned Deily | 29251b7 | 2020-05-19 07:39:29 -0400 | [diff] [blame] | 50 | For full details, see the :ref:`changelog <changelog>`. |
Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 51 | |
| 52 | .. note:: |
| 53 | |
| 54 | Prerelease users should be aware that this document is currently in draft |
| 55 | form. It will be updated substantially as Python 3.10 moves towards release, |
| 56 | so it's worth checking back even after reading earlier versions. |
| 57 | |
| 58 | |
| 59 | Summary -- Release highlights |
| 60 | ============================= |
| 61 | |
| 62 | .. This section singles out the most important changes in Python 3.10. |
| 63 | Brevity is key. |
| 64 | |
| 65 | |
| 66 | .. PEP-sized items next. |
| 67 | |
| 68 | |
| 69 | |
| 70 | New Features |
| 71 | ============ |
| 72 | |
Batuhan Taskaya | 044a104 | 2020-10-06 23:03:02 +0300 | [diff] [blame] | 73 | .. _whatsnew310-pep563: |
| 74 | |
Pablo Galindo | 7c8e0b0 | 2021-01-25 23:15:51 +0000 | [diff] [blame] | 75 | Parenthesized context managers |
| 76 | ------------------------------ |
| 77 | |
| 78 | Using enclosing parentheses for continuation across multiple lines |
| 79 | in context managers is now supported. This allows formatting a long |
| 80 | collection of context managers in multiple lines in a similar way |
| 81 | as it was previously possible with import statements. For instance, |
| 82 | all these examples are now valid: |
| 83 | |
| 84 | .. code-block:: python |
| 85 | |
| 86 | with (CtxManager() as example): |
| 87 | ... |
| 88 | |
| 89 | with ( |
| 90 | CtxManager1(), |
| 91 | CtxManager2() |
| 92 | ): |
| 93 | ... |
| 94 | |
| 95 | with (CtxManager1() as example, |
| 96 | CtxManager2()): |
| 97 | ... |
| 98 | |
| 99 | with (CtxManager1(), |
| 100 | CtxManager2() as example): |
| 101 | ... |
| 102 | |
| 103 | with ( |
| 104 | CtxManager1() as example1, |
| 105 | CtxManager2() as example2 |
| 106 | ): |
| 107 | ... |
| 108 | |
| 109 | it is also possible to use a trailing comma at the end of the |
| 110 | enclosed group: |
| 111 | |
| 112 | .. code-block:: python |
| 113 | |
| 114 | with ( |
| 115 | CtxManager1() as example1, |
| 116 | CtxManager2() as example2, |
| 117 | CtxManager3() as example3, |
| 118 | ): |
| 119 | ... |
| 120 | |
| 121 | This new syntax uses the non LL(1) capacities of the new parser. |
| 122 | Check :pep:`617` for more details. |
| 123 | |
| 124 | (Contributed by Guido van Rossum, Pablo Galindo and Lysandros Nikolaou |
| 125 | in :issue:`12782` and :issue:`40334`.) |
| 126 | |
| 127 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 128 | Better error messages in the parser |
| 129 | ----------------------------------- |
Batuhan Taskaya | 044a104 | 2020-10-06 23:03:02 +0300 | [diff] [blame] | 130 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 131 | When parsing code that contains unclosed parentheses or brackets the interpreter |
| 132 | now includes the location of the unclosed bracket of parentheses instead of displaying |
| 133 | *SyntaxError: unexpected EOF while parsing* or pointing to some incorrect location. |
| 134 | For instance, consider the following code (notice the unclosed '{'): |
Batuhan Taskaya | 044a104 | 2020-10-06 23:03:02 +0300 | [diff] [blame] | 135 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 136 | .. code-block:: python |
Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 137 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 138 | expected = {9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4, |
| 139 | 38: 4, 39: 4, 45: 5, 46: 5, 47: 5, 48: 5, 49: 5, 54: 6, |
| 140 | some_other_code = foo() |
Dennis Sweeney | 3ee0e48 | 2020-06-12 13:19:25 -0400 | [diff] [blame] | 141 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 142 | previous versions of the interpreter reported confusing places as the location of |
| 143 | the syntax error: |
Ram Rachum | 59cf853 | 2020-06-19 23:39:22 +0300 | [diff] [blame] | 144 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 145 | .. code-block:: text |
Mikhail Golubev | 4f3c250 | 2020-10-08 00:44:31 +0300 | [diff] [blame] | 146 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 147 | File "example.py", line 3 |
| 148 | some_other_code = foo() |
| 149 | ^ |
| 150 | SyntaxError: invalid syntax |
Mikhail Golubev | 4f3c250 | 2020-10-08 00:44:31 +0300 | [diff] [blame] | 151 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 152 | but in Python3.10 a more informative error is emitted: |
Mikhail Golubev | 4f3c250 | 2020-10-08 00:44:31 +0300 | [diff] [blame] | 153 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 154 | .. code-block:: text |
Mikhail Golubev | 4f3c250 | 2020-10-08 00:44:31 +0300 | [diff] [blame] | 155 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 156 | File "example.py", line 1 |
| 157 | expected = {9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4, |
| 158 | ^ |
| 159 | SyntaxError: '{' was never closed |
Fidget-Spinner | 8e1dd55 | 2020-10-05 12:40:52 +0800 | [diff] [blame] | 160 | |
| 161 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 162 | In a similar way, errors involving unclosed string literals (single and triple |
| 163 | quoted) now point to the start of the string instead of reporting EOF/EOL. |
Fidget-Spinner | 8e1dd55 | 2020-10-05 12:40:52 +0800 | [diff] [blame] | 164 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 165 | These improvements are inspired by previous work in the PyPy interpreter. |
Fidget-Spinner | 8e1dd55 | 2020-10-05 12:40:52 +0800 | [diff] [blame] | 166 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 167 | (Contributed by Pablo Galindo in :issue:`42864` and Batuhan Taskaya in |
| 168 | :issue:`40176`.) |
Fidget-Spinner | 8e1dd55 | 2020-10-05 12:40:52 +0800 | [diff] [blame] | 169 | |
Mark Shannon | 6086ae7 | 2021-03-16 13:43:58 +0000 | [diff] [blame] | 170 | PEP 626: Precise line numbers for debugging and other tools |
| 171 | ----------------------------------------------------------- |
| 172 | |
| 173 | PEP 626 brings more precise and reliable line numbers for debugging, profiling and coverage tools. |
| 174 | Tracing events, with the correct line number, are generated for all lines of code executed and only for lines of code that are executed. |
| 175 | |
| 176 | The ``f_lineo`` attribute of frame objects will always contain the expected line number. |
| 177 | |
Mark Shannon | 148bc05 | 2021-03-19 17:30:24 +0000 | [diff] [blame] | 178 | The ``co_lnotab`` attribute of code objects is deprecated and will be removed in 3.12. |
| 179 | Code that needs to convert from offset to line number should use the new ``co_lines()`` method instead. |
Ken Jin | 11276cd | 2021-01-02 08:45:50 +0800 | [diff] [blame] | 180 | |
Carol Willing | 41934b3 | 2021-02-28 15:43:17 -0800 | [diff] [blame] | 181 | PEP 634: Structural Pattern Matching |
| 182 | ------------------------------------ |
| 183 | |
| 184 | Structural pattern matching has been added in the form of a *match statement* |
| 185 | and *case statements* of patterns with associated actions. Patterns |
| 186 | consist of sequences, mappings, primitive data types as well as class instances. |
| 187 | Pattern matching enables programs to extract information from complex data types, |
| 188 | branch on the structure of data, and apply specific actions based on different |
| 189 | forms of data. |
| 190 | |
| 191 | Syntax and operations |
| 192 | ~~~~~~~~~~~~~~~~~~~~~ |
| 193 | |
| 194 | The generic syntax of pattern matching is:: |
| 195 | |
| 196 | match subject: |
| 197 | case <pattern_1>: |
| 198 | <action_1> |
| 199 | case <pattern_2>: |
| 200 | <action_2> |
| 201 | case <pattern_3>: |
| 202 | <action_3> |
| 203 | case _: |
| 204 | <action_wildcard> |
| 205 | |
| 206 | A match statement takes an expression and compares its value to successive |
| 207 | patterns given as one or more case blocks. Specifically, pattern matching |
| 208 | operates by: |
| 209 | |
| 210 | 1. using data with type and shape (the ``subject``) |
| 211 | 2. evaluating the ``subject`` in the ``match`` statement |
| 212 | 3. comparing the subject with each pattern in a ``case`` statement |
| 213 | from top to bottom until a match is confirmed. |
| 214 | 4. executing the action associated with the pattern of the confirmed |
| 215 | match |
| 216 | 5. If an exact match is not confirmed, the last case, a wildcard ``_``, |
| 217 | if provided, will be used as the matching case. If an exact match is |
| 218 | not confirmed and a wildcard case does not exists, the entire match |
| 219 | block is a no-op. |
| 220 | |
| 221 | Declarative approach |
| 222 | ~~~~~~~~~~~~~~~~~~~~ |
| 223 | |
| 224 | Readers may be aware of pattern matching through the simple example of matching |
| 225 | a subject (data object) to a literal (pattern) with the switch statement found |
| 226 | in C, Java or JavaScript (and many other languages). Often the switch statement |
| 227 | is used for comparison of an object/expression with case statements containing |
| 228 | literals. |
| 229 | |
| 230 | More powerful examples of pattern matching can be found in languages, such as |
| 231 | Scala and Elixir. With structural pattern matching, the approach is "declarative" and |
| 232 | explicitly states the conditions (the patterns) for data to match. |
| 233 | |
| 234 | While an "imperative" series of instructions using nested "if" statements |
| 235 | could be used to accomplish something similar to structural pattern matching, |
| 236 | it is less clear than the "declarative" approach. Instead the "declarative" |
| 237 | approach states the conditions to meet for a match and is more readable through |
| 238 | its explicit patterns. While structural pattern matching can be used in its |
| 239 | simplest form comparing a variable to a literal in a case statement, its |
| 240 | true value for Python lies in its handling of the subject's type and shape. |
| 241 | |
| 242 | Simple pattern: match to a literal |
| 243 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 244 | |
| 245 | Let's look at this example as pattern matching in its simplest form: a value, |
| 246 | the subject, being matched to several literals, the patterns. In the example |
| 247 | below, ``status`` is the subject of the match statement. The patterns are |
| 248 | each of the case statements, where literals represent request status codes. |
| 249 | The associated action to the case is executed after a match:: |
| 250 | |
| 251 | def http_error(status): |
| 252 | match status: |
| 253 | case 400: |
| 254 | return "Bad request" |
| 255 | case 404: |
| 256 | return "Not found" |
| 257 | case 418: |
| 258 | return "I'm a teapot" |
| 259 | case _: |
| 260 | return "Something's wrong with the Internet" |
| 261 | |
| 262 | If the above function is passed a ``status`` of 418, "I'm a teapot" is returned. |
| 263 | If the above function is passed a ``status`` of 500, the case statement with |
| 264 | ``_`` will match as a wildcard, and "Something's wrong with the Internet" is |
| 265 | returned. |
| 266 | Note the last block: the variable name, ``_``, acts as a *wildcard* and insures |
| 267 | the subject will always match. The use of ``_`` is optional. |
| 268 | |
| 269 | You can combine several literals in a single pattern using ``|`` ("or"):: |
| 270 | |
| 271 | case 401 | 403 | 404: |
| 272 | return "Not allowed" |
| 273 | |
| 274 | Behavior without the wildcard |
| 275 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 276 | |
| 277 | If we modify the above example by removing the last case block, the example |
| 278 | becomes:: |
| 279 | |
| 280 | def http_error(status): |
| 281 | match status: |
| 282 | case 400: |
| 283 | return "Bad request" |
| 284 | case 404: |
| 285 | return "Not found" |
| 286 | case 418: |
| 287 | return "I'm a teapot" |
| 288 | |
| 289 | Without the use of ``_`` in a case statement, a match may not exist. If no |
| 290 | match exists, the behavior is a no-op. For example, if ``status`` of 500 is |
| 291 | passed, a no-op occurs. |
| 292 | |
Julien Palard | b04f1cb | 2021-03-03 11:32:12 +0100 | [diff] [blame] | 293 | Patterns with a literal and variable |
| 294 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
Carol Willing | 41934b3 | 2021-02-28 15:43:17 -0800 | [diff] [blame] | 295 | |
| 296 | Patterns can look like unpacking assignments, and a pattern may be used to bind |
| 297 | variables. In this example, a data point can be unpacked to its x-coordinate |
| 298 | and y-coordinate:: |
| 299 | |
| 300 | # point is an (x, y) tuple |
| 301 | match point: |
| 302 | case (0, 0): |
| 303 | print("Origin") |
| 304 | case (0, y): |
| 305 | print(f"Y={y}") |
| 306 | case (x, 0): |
| 307 | print(f"X={x}") |
| 308 | case (x, y): |
| 309 | print(f"X={x}, Y={y}") |
| 310 | case _: |
| 311 | raise ValueError("Not a point") |
| 312 | |
| 313 | The first pattern has two literals, ``(0, 0)``, and may be thought of as an |
| 314 | extension of the literal pattern shown above. The next two patterns combine a |
| 315 | literal and a variable, and the variable *binds* a value from the subject |
| 316 | (``point``). The fourth pattern captures two values, which makes it |
| 317 | conceptually similar to the unpacking assignment ``(x, y) = point``. |
| 318 | |
| 319 | Patterns and classes |
| 320 | ~~~~~~~~~~~~~~~~~~~~ |
| 321 | |
| 322 | If you are using classes to structure your data, you can use as a pattern |
| 323 | the class name followed by an argument list resembling a constructor. This |
| 324 | pattern has the ability to capture class attributes into variables:: |
| 325 | |
| 326 | class Point: |
| 327 | x: int |
| 328 | y: int |
| 329 | |
| 330 | def location(point): |
| 331 | match point: |
| 332 | case Point(x=0, y=0): |
| 333 | print("Origin is the point's location.") |
| 334 | case Point(x=0, y=y): |
| 335 | print(f"Y={y} and the point is on the y-axis.") |
| 336 | case Point(x=x, y=0): |
| 337 | print(f"X={x} and the point is on the x-axis.") |
| 338 | case Point(): |
| 339 | print("The point is located somewhere else on the plane.") |
| 340 | case _: |
| 341 | print("Not a point") |
| 342 | |
| 343 | Patterns with positional parameters |
| 344 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 345 | |
| 346 | You can use positional parameters with some builtin classes that provide an |
| 347 | ordering for their attributes (e.g. dataclasses). You can also define a specific |
| 348 | position for attributes in patterns by setting the ``__match_args__`` special |
| 349 | attribute in your classes. If it's set to ("x", "y"), the following patterns |
| 350 | are all equivalent (and all bind the ``y`` attribute to the ``var`` variable):: |
| 351 | |
| 352 | Point(1, var) |
| 353 | Point(1, y=var) |
| 354 | Point(x=1, y=var) |
| 355 | Point(y=var, x=1) |
| 356 | |
| 357 | Nested patterns |
| 358 | ~~~~~~~~~~~~~~~ |
| 359 | |
| 360 | Patterns can be arbitrarily nested. For example, if our data is a short |
| 361 | list of points, it could be matched like this:: |
| 362 | |
| 363 | match points: |
| 364 | case []: |
| 365 | print("No points in the list.") |
| 366 | case [Point(0, 0)]: |
| 367 | print("The origin is the only point in the list.") |
| 368 | case [Point(x, y)]: |
| 369 | print(f"A single point {x}, {y} is in the list.") |
| 370 | case [Point(0, y1), Point(0, y2)]: |
| 371 | print(f"Two points on the Y axis at {y1}, {y2} are in the list.") |
| 372 | case _: |
| 373 | print("Something else is found in the list.") |
| 374 | |
| 375 | Complex patterns and the wildcard |
| 376 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 377 | |
| 378 | To this point, the examples have used ``_`` alone in the last case statement. |
| 379 | A wildcard can be used in more complex patterns, such as ``('error', code, _)``. |
| 380 | For example:: |
| 381 | |
| 382 | match test_variable: |
| 383 | case ('warning', code, 40): |
| 384 | print("A warning has been received.") |
| 385 | case ('error', code, _): |
| 386 | print(f"An error {code} occured.") |
| 387 | |
| 388 | In the above case, ``test_variable`` will match for ('error', code, 100) and |
| 389 | ('error', code, 800). |
| 390 | |
| 391 | Guard |
| 392 | ~~~~~ |
| 393 | |
| 394 | We can add an ``if`` clause to a pattern, known as a "guard". If the |
| 395 | guard is false, ``match`` goes on to try the next case block. Note |
| 396 | that value capture happens before the guard is evaluated:: |
| 397 | |
| 398 | match point: |
| 399 | case Point(x, y) if x == y: |
| 400 | print(f"The point is located on the diagonal Y=X at {x}.") |
| 401 | case Point(x, y): |
| 402 | print(f"Point is not on the diagonal.") |
| 403 | |
| 404 | Other Key Features |
| 405 | ~~~~~~~~~~~~~~~~~~ |
| 406 | |
| 407 | Several other key features: |
| 408 | |
| 409 | - Like unpacking assignments, tuple and list patterns have exactly the |
| 410 | same meaning and actually match arbitrary sequences. Technically, |
| 411 | the subject must be an instance of ``collections.abc.Sequence``. |
| 412 | Therefore, an important exception is that patterns don't match iterators. |
| 413 | Also, to prevent a common mistake, sequence patterns don't match strings. |
| 414 | |
| 415 | - Sequence patterns support wildcards: ``[x, y, *rest]`` and ``(x, y, |
| 416 | *rest)`` work similar to wildcards in unpacking assignments. The |
| 417 | name after ``*`` may also be ``_``, so ``(x, y, *_)`` matches a sequence |
| 418 | of at least two items without binding the remaining items. |
| 419 | |
| 420 | - Mapping patterns: ``{"bandwidth": b, "latency": l}`` captures the |
| 421 | ``"bandwidth"`` and ``"latency"`` values from a dict. Unlike sequence |
| 422 | patterns, extra keys are ignored. A wildcard ``**rest`` is also |
| 423 | supported. (But ``**_`` would be redundant, so it not allowed.) |
| 424 | |
| 425 | - Subpatterns may be captured using the ``as`` keyword:: |
| 426 | |
| 427 | case (Point(x1, y1), Point(x2, y2) as p2): ... |
| 428 | |
| 429 | This binds x1, y1, x2, y2 like you would expect without the ``as`` clause, |
| 430 | and p2 to the entire second item of the subject. |
| 431 | |
| 432 | - Most literals are compared by equality. However, the singletons ``True``, |
| 433 | ``False`` and ``None`` are compared by identity. |
| 434 | |
| 435 | - Named constants may be used in patterns. These named constants must be |
| 436 | dotted names to prevent the constant from being interpreted as a capture |
| 437 | variable:: |
| 438 | |
| 439 | from enum import Enum |
| 440 | class Color(Enum): |
| 441 | RED = 0 |
| 442 | GREEN = 1 |
| 443 | BLUE = 2 |
| 444 | |
| 445 | match color: |
| 446 | case Color.RED: |
| 447 | print("I see red!") |
| 448 | case Color.GREEN: |
| 449 | print("Grass is green") |
| 450 | case Color.BLUE: |
| 451 | print("I'm feeling the blues :(") |
| 452 | |
| 453 | For the full specification see :pep:`634`. Motivation and rationale |
| 454 | are in :pep:`635`, and a longer tutorial is in :pep:`636`. |
| 455 | |
Pablo Galindo | 805ede8 | 2021-01-21 17:36:35 +0000 | [diff] [blame] | 456 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 457 | New Features Related to Type Annotations |
| 458 | ======================================== |
Pablo Galindo | 805ede8 | 2021-01-21 17:36:35 +0000 | [diff] [blame] | 459 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 460 | This section covers major changes affecting :pep:`484` type annotations and |
| 461 | the :mod:`typing` module. |
Pablo Galindo | 805ede8 | 2021-01-21 17:36:35 +0000 | [diff] [blame] | 462 | |
| 463 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 464 | PEP 563: Postponed Evaluation of Annotations Becomes Default |
| 465 | ------------------------------------------------------------ |
Pablo Galindo | 805ede8 | 2021-01-21 17:36:35 +0000 | [diff] [blame] | 466 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 467 | In Python 3.7, postponed evaluation of annotations was added, |
| 468 | to be enabled with a ``from __future__ import annotations`` |
| 469 | directive. In 3.10 this became the default behavior, even |
| 470 | without that future directive. With this being default, all |
| 471 | annotations stored in :attr:`__annotations__` will be strings. |
| 472 | If needed, annotations can be resolved at runtime using |
| 473 | :func:`typing.get_type_hints`. See :pep:`563` for a full |
| 474 | description. Also, the :func:`inspect.signature` will try to |
| 475 | resolve types from now on, and when it fails it will fall back to |
| 476 | showing the string annotations. (Contributed by Batuhan Taskaya |
| 477 | in :issue:`38605`.) |
Pablo Galindo | 805ede8 | 2021-01-21 17:36:35 +0000 | [diff] [blame] | 478 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 479 | |
| 480 | PEP 604: New Type Union Operator |
| 481 | -------------------------------- |
| 482 | |
| 483 | A new type union operator was introduced which enables the syntax ``X | Y``. |
| 484 | This provides a cleaner way of expressing 'either type X or type Y' instead of |
| 485 | using :data:`typing.Union`, especially in type hints (annotations). |
| 486 | |
| 487 | In previous versions of Python, to apply a type hint for functions accepting |
| 488 | arguments of multiple types, :data:`typing.Union` was used:: |
| 489 | |
| 490 | def square(number: Union[int, float]) -> Union[int, float]: |
| 491 | return number ** 2 |
| 492 | |
| 493 | |
| 494 | Type hints can now be written in a more succinct manner:: |
| 495 | |
| 496 | def square(number: int | float) -> int | float: |
| 497 | return number ** 2 |
| 498 | |
| 499 | |
| 500 | This new syntax is also accepted as the second argument to :func:`isinstance` |
| 501 | and :func:`issubclass`:: |
| 502 | |
| 503 | >>> isinstance(1, int | str) |
| 504 | True |
| 505 | |
| 506 | See :ref:`types-union` and :pep:`604` for more details. |
| 507 | |
| 508 | (Contributed by Maggie Moss and Philippe Prados in :issue:`41428`.) |
| 509 | |
| 510 | |
| 511 | PEP 612: Parameter Specification Variables |
| 512 | ------------------------------------------ |
| 513 | |
| 514 | Two new options to improve the information provided to static type checkers for |
| 515 | :pep:`484`\ 's ``Callable`` have been added to the :mod:`typing` module. |
| 516 | |
| 517 | The first is the parameter specification variable. They are used to forward the |
| 518 | parameter types of one callable to another callable -- a pattern commonly |
| 519 | found in higher order functions and decorators. Examples of usage can be found |
| 520 | in :class:`typing.ParamSpec`. Previously, there was no easy way to type annotate |
| 521 | dependency of parameter types in such a precise manner. |
| 522 | |
| 523 | The second option is the new ``Concatenate`` operator. It's used in conjunction |
| 524 | with parameter specification variables to type annotate a higher order callable |
| 525 | which adds or removes parameters of another callable. Examples of usage can |
| 526 | be found in :class:`typing.Concatenate`. |
| 527 | |
| 528 | See :class:`typing.Callable`, :class:`typing.ParamSpec`, |
| 529 | :class:`typing.Concatenate` and :pep:`612` for more details. |
| 530 | |
| 531 | (Contributed by Ken Jin in :issue:`41559`.) |
| 532 | |
| 533 | |
| 534 | PEP 613: TypeAlias Annotation |
| 535 | ----------------------------- |
| 536 | |
| 537 | :pep:`484` introduced the concept of type aliases, only requiring them to be |
| 538 | top-level unannotated assignments. This simplicity sometimes made it difficult |
| 539 | for type checkers to distinguish between type aliases and ordinary assignments, |
| 540 | especially when forward references or invalid types were involved. Compare:: |
| 541 | |
| 542 | StrCache = 'Cache[str]' # a type alias |
| 543 | LOG_PREFIX = 'LOG[DEBUG]' # a module constant |
| 544 | |
| 545 | Now the :mod:`typing` module has a special annotation :data:`TypeAlias` to |
| 546 | declare type aliases more explicitly:: |
| 547 | |
| 548 | StrCache: TypeAlias = 'Cache[str]' # a type alias |
| 549 | LOG_PREFIX = 'LOG[DEBUG]' # a module constant |
| 550 | |
| 551 | See :pep:`613` for more details. |
| 552 | |
| 553 | (Contributed by Mikhail Golubev in :issue:`41923`.) |
| 554 | |
Pablo Galindo | 805ede8 | 2021-01-21 17:36:35 +0000 | [diff] [blame] | 555 | |
Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 556 | Other Language Changes |
| 557 | ====================== |
| 558 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 559 | * The :class:`int` type has a new method :meth:`int.bit_count`, returning the |
| 560 | number of ones in the binary expansion of a given integer, also known |
| 561 | as the population count. (Contributed by Niklas Fiekas in :issue:`29882`.) |
| 562 | |
| 563 | * The views returned by :meth:`dict.keys`, :meth:`dict.values` and |
| 564 | :meth:`dict.items` now all have a ``mapping`` attribute that gives a |
| 565 | :class:`types.MappingProxyType` object wrapping the original |
| 566 | dictionary. (Contributed by Dennis Sweeney in :issue:`40890`.) |
| 567 | |
| 568 | * :pep:`618`: The :func:`zip` function now has an optional ``strict`` flag, used |
| 569 | to require that all the iterables have an equal length. |
| 570 | |
Serhiy Storchaka | 578c395 | 2020-05-26 18:43:38 +0300 | [diff] [blame] | 571 | * Builtin and extension functions that take integer arguments no longer accept |
| 572 | :class:`~decimal.Decimal`\ s, :class:`~fractions.Fraction`\ s and other |
| 573 | objects that can be converted to integers only with a loss (e.g. that have |
| 574 | the :meth:`~object.__int__` method but do not have the |
| 575 | :meth:`~object.__index__` method). |
| 576 | (Contributed by Serhiy Storchaka in :issue:`37999`.) |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 577 | |
Alex | cc02b4f | 2021-02-26 21:58:39 +0200 | [diff] [blame] | 578 | * If :func:`object.__ipow__` returns :const:`NotImplemented`, the operator will |
| 579 | correctly fall back to :func:`object.__pow__` and :func:`object.__rpow__` as expected. |
| 580 | (Contributed by Alex Shkop in :issue:`38302`.) |
Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 581 | |
Lysandros Nikolaou | a85fefe | 2020-11-19 01:49:28 +0200 | [diff] [blame] | 582 | * Assignment expressions can now be used unparenthesized within set literals |
| 583 | and set comprehensions, as well as in sequence indexes (but not slices). |
| 584 | |
Victor Stinner | a3c3ffa | 2021-02-18 12:35:37 +0100 | [diff] [blame] | 585 | * Functions have a new ``__builtins__`` attribute which is used to look for |
| 586 | builtin symbols when a function is executed, instead of looking into |
Victor Stinner | 46496f9 | 2021-02-20 15:17:18 +0100 | [diff] [blame] | 587 | ``__globals__['__builtins__']``. The attribute is initialized from |
| 588 | ``__globals__["__builtins__"]`` if it exists, else from the current builtins. |
Victor Stinner | a3c3ffa | 2021-02-18 12:35:37 +0100 | [diff] [blame] | 589 | (Contributed by Mark Shannon in :issue:`42990`.) |
| 590 | |
Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 591 | |
| 592 | New Modules |
| 593 | =========== |
| 594 | |
| 595 | * None yet. |
| 596 | |
| 597 | |
| 598 | Improved Modules |
| 599 | ================ |
| 600 | |
Tomáš Hrnčiar | fb35fa4 | 2021-01-12 01:41:35 +0100 | [diff] [blame] | 601 | argparse |
| 602 | -------- |
| 603 | |
| 604 | Misleading phrase "optional arguments" was replaced with "options" in argparse help. Some tests might require adaptation if they rely on exact output match. |
| 605 | (Contributed by Raymond Hettinger in :issue:`9694`.) |
| 606 | |
Filipe Laíns | 4ce6faa | 2020-08-10 15:48:20 +0100 | [diff] [blame] | 607 | base64 |
| 608 | ------ |
| 609 | |
| 610 | Add :func:`base64.b32hexencode` and :func:`base64.b32hexdecode` to support the |
| 611 | Base32 Encoding with Extended Hex Alphabet. |
| 612 | |
Hai Shi | d332e7b | 2020-09-29 05:41:11 +0800 | [diff] [blame] | 613 | codecs |
| 614 | ------ |
| 615 | |
| 616 | Add a :func:`codecs.unregister` function to unregister a codec search function. |
| 617 | (Contributed by Hai Shi in :issue:`41842`.) |
| 618 | |
kj | d75f6f7 | 2020-12-19 01:39:26 +0800 | [diff] [blame] | 619 | collections.abc |
| 620 | --------------- |
| 621 | |
| 622 | The ``__args__`` of the :ref:`parameterized generic <types-genericalias>` for |
| 623 | :class:`collections.abc.Callable` are now consistent with :data:`typing.Callable`. |
| 624 | :class:`collections.abc.Callable` generic now flattens type parameters, similar |
| 625 | to what :data:`typing.Callable` currently does. This means that |
| 626 | ``collections.abc.Callable[[int, str], str]`` will have ``__args__`` of |
| 627 | ``(int, str, str)``; previously this was ``([int, str], str)``. To allow this |
| 628 | change, :class:`types.GenericAlias` can now be subclassed, and a subclass will |
| 629 | be returned when subscripting the :class:`collections.abc.Callable` type. Note |
| 630 | that a :exc:`TypeError` may be raised for invalid forms of parameterizing |
| 631 | :class:`collections.abc.Callable` which may have passed silently in Python 3.9. |
| 632 | (Contributed by Ken Jin in :issue:`42195`.) |
| 633 | |
Joongi Kim | 3eb2846 | 2020-11-11 00:19:11 +0900 | [diff] [blame] | 634 | contextlib |
| 635 | ---------- |
| 636 | |
| 637 | Add a :func:`contextlib.aclosing` context manager to safely close async generators |
| 638 | and objects representing asynchronously released resources. |
| 639 | (Contributed by Joongi Kim and John Belmonte in :issue:`41229`.) |
| 640 | |
Tom Gringauz | 9c98e8c | 2020-11-18 00:58:35 +0200 | [diff] [blame] | 641 | Add asynchronous context manager support to :func:`contextlib.nullcontext`. |
| 642 | (Contributed by Tom Gringauz in :issue:`41543`.) |
| 643 | |
Hans Petter Jansson | da4e09f | 2020-08-03 22:51:33 -0500 | [diff] [blame] | 644 | curses |
| 645 | ------ |
| 646 | |
| 647 | The extended color functions added in ncurses 6.1 will be used transparently |
| 648 | by :func:`curses.color_content`, :func:`curses.init_color`, |
| 649 | :func:`curses.init_pair`, and :func:`curses.pair_content`. A new function, |
| 650 | :func:`curses.has_extended_color_support`, indicates whether extended color |
| 651 | support is provided by the underlying ncurses library. |
| 652 | (Contributed by Jeffrey Kintscher and Hans Petter Jansson in :issue:`36982`.) |
| 653 | |
Zackery Spytz | 14cfa32 | 2021-01-14 02:40:09 -0700 | [diff] [blame] | 654 | The ``BUTTON5_*`` constants are now exposed in the :mod:`curses` module if |
| 655 | they are provided by the underlying curses library. |
| 656 | (Contributed by Zackery Spytz in :issue:`39273`.) |
| 657 | |
Steve Dower | 62949f6 | 2021-01-29 21:48:55 +0000 | [diff] [blame] | 658 | .. _distutils-deprecated: |
| 659 | |
Victor Stinner | 0e2a0f7 | 2021-01-09 00:35:01 +0100 | [diff] [blame] | 660 | distutils |
| 661 | --------- |
| 662 | |
Steve Dower | 62949f6 | 2021-01-29 21:48:55 +0000 | [diff] [blame] | 663 | The entire ``distutils`` package is deprecated, to be removed in Python |
| 664 | 3.12. Its functionality for specifying package builds has already been |
| 665 | completely replaced by third-party packages ``setuptools`` and |
| 666 | ``packaging``, and most other commonly used APIs are available elsewhere |
| 667 | in the standard library (such as :mod:`platform`, :mod:`shutil`, |
| 668 | :mod:`subprocess` or :mod:`sysconfig`). There are no plans to migrate |
| 669 | any other functionality from ``distutils``, and applications that are |
| 670 | using other functions should plan to make private copies of the code. |
| 671 | Refer to :pep:`632` for discussion. |
| 672 | |
Victor Stinner | 0e2a0f7 | 2021-01-09 00:35:01 +0100 | [diff] [blame] | 673 | The ``bdist_wininst`` command deprecated in Python 3.8 has been removed. |
ravcio | 6cd5b01 | 2021-01-21 11:23:46 +0100 | [diff] [blame] | 674 | The ``bdist_wheel`` command is now recommended to distribute binary packages |
Victor Stinner | 0e2a0f7 | 2021-01-09 00:35:01 +0100 | [diff] [blame] | 675 | on Windows. |
| 676 | (Contributed by Victor Stinner in :issue:`42802`.) |
| 677 | |
Brett Cannon | 825ac38 | 2020-11-06 18:45:56 -0800 | [diff] [blame] | 678 | doctest |
| 679 | ------- |
| 680 | |
| 681 | When a module does not define ``__loader__``, fall back to ``__spec__.loader``. |
| 682 | (Contributed by Brett Cannon in :issue:`42133`.) |
| 683 | |
Hai Shi | c5b049b | 2020-10-14 23:43:31 +0800 | [diff] [blame] | 684 | encodings |
| 685 | --------- |
Pablo Galindo | b4f9089 | 2021-03-10 00:53:57 +0000 | [diff] [blame] | 686 | |
Hai Shi | c5b049b | 2020-10-14 23:43:31 +0800 | [diff] [blame] | 687 | :func:`encodings.normalize_encoding` now ignores non-ASCII characters. |
| 688 | (Contributed by Hai Shi in :issue:`39337`.) |
| 689 | |
Pablo Galindo | b4f9089 | 2021-03-10 00:53:57 +0000 | [diff] [blame] | 690 | gc |
| 691 | -- |
| 692 | |
| 693 | Added audit hooks for :func:`gc.get_objects`, :func:`gc.get_referrers` and |
| 694 | :func:`gc.get_referents`. (Contributed by Pablo Galindo in :issue:`43439`.) |
| 695 | |
Serhiy Storchaka | 8a64cea | 2020-06-18 22:08:27 +0300 | [diff] [blame] | 696 | glob |
| 697 | ---- |
| 698 | |
| 699 | Added the *root_dir* and *dir_fd* parameters in :func:`~glob.glob` and |
| 700 | :func:`~glob.iglob` which allow to specify the root directory for searching. |
| 701 | (Contributed by Serhiy Storchaka in :issue:`38144`.) |
| 702 | |
Jason R. Coombs | 35d5068 | 2021-03-14 22:20:49 -0400 | [diff] [blame] | 703 | importlib.metadata |
| 704 | ------------------ |
| 705 | |
| 706 | Feature parity with ``importlib_metadata`` 3.7. |
| 707 | |
| 708 | :func:`importlib.metadata.entry_points` now provides a nicer experience |
| 709 | for selecting entry points by group and name through a new |
| 710 | :class:`importlib.metadata.EntryPoints` class. |
| 711 | |
| 712 | Added :func:`importlib.metadata.packages_distributions` for resolving |
| 713 | top-level Python modules and packages to their |
| 714 | :class:`importlib.metadata.Distribution`. |
| 715 | |
Brett Cannon | 825ac38 | 2020-11-06 18:45:56 -0800 | [diff] [blame] | 716 | inspect |
| 717 | ------- |
| 718 | |
| 719 | When a module does not define ``__loader__``, fall back to ``__spec__.loader``. |
| 720 | (Contributed by Brett Cannon in :issue:`42133`.) |
| 721 | |
Batuhan Taskaya | eee1c77 | 2020-12-24 01:45:13 +0300 | [diff] [blame] | 722 | Added *globalns* and *localns* parameters in :func:`~inspect.signature` and |
| 723 | :meth:`inspect.Signature.from_callable` to retrieve the annotations in given |
| 724 | local and global namespaces. |
| 725 | (Contributed by Batuhan Taskaya in :issue:`41960`.) |
| 726 | |
Brett Cannon | 825ac38 | 2020-11-06 18:45:56 -0800 | [diff] [blame] | 727 | linecache |
| 728 | --------- |
| 729 | |
| 730 | When a module does not define ``__loader__``, fall back to ``__spec__.loader``. |
| 731 | (Contributed by Brett Cannon in :issue:`42133`.) |
| 732 | |
pxinwr | 3405e05 | 2020-08-07 13:21:52 +0800 | [diff] [blame] | 733 | os |
| 734 | -- |
| 735 | |
| 736 | Added :func:`os.cpu_count()` support for VxWorks RTOS. |
| 737 | (Contributed by Peixing Xin in :issue:`41440`.) |
| 738 | |
Christian Heimes | cd9fed6 | 2020-11-13 19:48:52 +0100 | [diff] [blame] | 739 | Added a new function :func:`os.eventfd` and related helpers to wrap the |
| 740 | ``eventfd2`` syscall on Linux. |
| 741 | (Contributed by Christian Heimes in :issue:`41001`.) |
| 742 | |
Pablo Galindo | a57b3d3 | 2020-11-17 00:00:38 +0000 | [diff] [blame] | 743 | Added :func:`os.splice()` that allows to move data between two file |
| 744 | descriptors without copying between kernel address space and user |
| 745 | address space, where one of the file descriptors must refer to a |
| 746 | pipe. (Contributed by Pablo Galindo in :issue:`41625`.) |
| 747 | |
Dong-hee Na | f917c24 | 2021-02-04 08:32:55 +0900 | [diff] [blame] | 748 | Added :data:`~os.O_EVTONLY`, :data:`~os.O_FSYNC`, :data:`~os.O_SYMLINK` |
| 749 | and :data:`~os.O_NOFOLLOW_ANY` for macOS. |
| 750 | (Contributed by Dong-hee Na in :issue:`43106`.) |
| 751 | |
Joshua Cannon | 4520584 | 2020-11-20 09:40:39 -0600 | [diff] [blame] | 752 | pathlib |
| 753 | ------- |
| 754 | |
Yaroslav Pankovych | 79d2e62 | 2020-11-23 22:06:22 +0200 | [diff] [blame] | 755 | Added slice support to :attr:`PurePath.parents <pathlib.PurePath.parents>`. |
Joshua Cannon | 4520584 | 2020-11-20 09:40:39 -0600 | [diff] [blame] | 756 | (Contributed by Joshua Cannon in :issue:`35498`) |
| 757 | |
Yaroslav Pankovych | 79d2e62 | 2020-11-23 22:06:22 +0200 | [diff] [blame] | 758 | Added negative indexing support to :attr:`PurePath.parents |
| 759 | <pathlib.PurePath.parents>`. |
| 760 | (Contributed by Yaroslav Pankovych in :issue:`21041`) |
| 761 | |
Christian Heimes | 5c73afc | 2020-11-30 22:34:45 +0100 | [diff] [blame] | 762 | platform |
| 763 | -------- |
| 764 | |
| 765 | Added :func:`platform.freedesktop_os_release()` to retrieve operation system |
| 766 | identification from `freedesktop.org os-release |
| 767 | <https://www.freedesktop.org/software/systemd/man/os-release.html>`_ standard file. |
| 768 | (Contributed by Christian Heimes in :issue:`28468`) |
| 769 | |
Gregory Schevchenko | daff390 | 2020-07-25 22:58:45 +0300 | [diff] [blame] | 770 | py_compile |
| 771 | ---------- |
| 772 | |
| 773 | Added ``--quiet`` option to command-line interface of :mod:`py_compile`. |
| 774 | (Contributed by Gregory Schevchenko in :issue:`38731`.) |
| 775 | |
Aviral Srivastava | 000cde5 | 2021-02-01 09:38:44 -0800 | [diff] [blame] | 776 | pyclbr |
| 777 | ------ |
| 778 | |
| 779 | Added an ``end_lineno`` attribute to the ``Function`` and ``Class`` |
| 780 | objects in the tree returned by :func:`pyclbr.readline` and |
| 781 | :func:`pyclbr.readline_ex`. It matches the existing (start) ``lineno``. |
| 782 | (Contributed by Aviral Srivastava in :issue:`38307`.) |
| 783 | |
Zackery Spytz | df59273 | 2020-10-29 03:44:35 -0600 | [diff] [blame] | 784 | shelve |
| 785 | ------ |
| 786 | |
| 787 | The :mod:`shelve` module now uses :data:`pickle.DEFAULT_PROTOCOL` by default |
| 788 | instead of :mod:`pickle` protocol ``3`` when creating shelves. |
| 789 | (Contributed by Zackery Spytz in :issue:`34204`.) |
| 790 | |
Brett Cannon | 825ac38 | 2020-11-06 18:45:56 -0800 | [diff] [blame] | 791 | site |
| 792 | ---- |
| 793 | |
| 794 | When a module does not define ``__loader__``, fall back to ``__spec__.loader``. |
| 795 | (Contributed by Brett Cannon in :issue:`42133`.) |
| 796 | |
Christian Heimes | 03c8ddd | 2020-11-20 09:26:07 +0100 | [diff] [blame] | 797 | socket |
| 798 | ------ |
| 799 | |
| 800 | The exception :exc:`socket.timeout` is now an alias of :exc:`TimeoutError`. |
| 801 | (Contributed by Christian Heimes in :issue:`42413`.) |
| 802 | |
Rui Cunha | b05b48d | 2021-03-20 22:04:56 +0000 | [diff] [blame] | 803 | Added option to create MPTCP sockets with ``IPPROTO_MPTCP`` |
| 804 | (Contributed by Rui Cunha in :issue:`43571`.) |
| 805 | |
Victor Stinner | dd8a93e | 2020-06-30 00:49:03 +0200 | [diff] [blame] | 806 | sys |
| 807 | --- |
| 808 | |
| 809 | Add :data:`sys.orig_argv` attribute: the list of the original command line |
| 810 | arguments passed to the Python executable. |
| 811 | (Contributed by Victor Stinner in :issue:`23427`.) |
| 812 | |
Victor Stinner | 9852cb3 | 2021-01-25 23:12:50 +0100 | [diff] [blame] | 813 | Add :data:`sys.stdlib_module_names`, containing the list of the standard library |
Victor Stinner | db584bd | 2021-01-25 13:24:42 +0100 | [diff] [blame] | 814 | module names. |
| 815 | (Contributed by Victor Stinner in :issue:`42955`.) |
| 816 | |
Antoine Pitrou | ba251c2 | 2021-03-11 23:35:45 +0100 | [diff] [blame] | 817 | _thread |
| 818 | ------- |
| 819 | |
| 820 | :func:`_thread.interrupt_main` now takes an optional signal number to |
| 821 | simulate (the default is still :data:`signal.SIGINT`). |
| 822 | (Contributed by Antoine Pitrou in :issue:`43356`.) |
| 823 | |
Mario Corchero | 0001a1b | 2020-11-04 10:27:43 +0100 | [diff] [blame] | 824 | threading |
| 825 | --------- |
| 826 | |
| 827 | Added :func:`threading.gettrace` and :func:`threading.getprofile` to |
| 828 | retrieve the functions set by :func:`threading.settrace` and |
| 829 | :func:`threading.setprofile` respectively. |
| 830 | (Contributed by Mario Corchero in :issue:`42251`.) |
| 831 | |
Mario Corchero | 750c5ab | 2020-11-12 18:27:44 +0100 | [diff] [blame] | 832 | Add :data:`threading.__excepthook__` to allow retrieving the original value |
| 833 | of :func:`threading.excepthook` in case it is set to a broken or a different |
| 834 | value. |
| 835 | (Contributed by Mario Corchero in :issue:`42308`.) |
| 836 | |
Zackery Spytz | 91e9379 | 2020-11-05 15:18:44 -0700 | [diff] [blame] | 837 | traceback |
| 838 | --------- |
| 839 | |
| 840 | The :func:`~traceback.format_exception`, |
| 841 | :func:`~traceback.format_exception_only`, and |
| 842 | :func:`~traceback.print_exception` functions can now take an exception object |
| 843 | as a positional-only argument. |
| 844 | (Contributed by Zackery Spytz and Matthias Bussonnier in :issue:`26389`.) |
| 845 | |
Bas van Beek | 0d0e9fe | 2020-09-22 17:55:34 +0200 | [diff] [blame] | 846 | types |
| 847 | ----- |
| 848 | |
| 849 | Reintroduced the :data:`types.EllipsisType`, :data:`types.NoneType` |
| 850 | and :data:`types.NotImplementedType` classes, providing a new set |
| 851 | of types readily interpretable by type checkers. |
| 852 | (Contributed by Bas van Beek in :issue:`41810`.) |
| 853 | |
kj | 4687338 | 2020-11-19 11:44:24 +0700 | [diff] [blame] | 854 | typing |
| 855 | ------ |
| 856 | |
Ken Jin | 727a68b | 2021-03-03 08:52:03 +0800 | [diff] [blame] | 857 | For major changes, see `New Features Related to Type Annotations`_. |
| 858 | |
kj | 4687338 | 2020-11-19 11:44:24 +0700 | [diff] [blame] | 859 | The behavior of :class:`typing.Literal` was changed to conform with :pep:`586` |
| 860 | and to match the behavior of static type checkers specified in the PEP. |
| 861 | |
| 862 | 1. ``Literal`` now de-duplicates parameters. |
| 863 | 2. Equality comparisons between ``Literal`` objects are now order independent. |
| 864 | 3. ``Literal`` comparisons now respects types. For example, |
| 865 | ``Literal[0] == Literal[False]`` previously evaluated to ``True``. It is |
| 866 | now ``False``. To support this change, the internally used type cache now |
| 867 | supports differentiating types. |
| 868 | 4. ``Literal`` objects will now raise a :exc:`TypeError` exception during |
| 869 | equality comparisons if one of their parameters are not :term:`immutable`. |
| 870 | Note that declaring ``Literal`` with mutable parameters will not throw |
| 871 | an error:: |
| 872 | |
| 873 | >>> from typing import Literal |
| 874 | >>> Literal[{0}] |
| 875 | >>> Literal[{0}] == Literal[{False}] |
| 876 | Traceback (most recent call last): |
| 877 | File "<stdin>", line 1, in <module> |
| 878 | TypeError: unhashable type: 'set' |
| 879 | |
| 880 | (Contributed by Yurii Karabas in :issue:`42345`.) |
| 881 | |
Mark Dickinson | c8c70e7 | 2020-09-19 21:38:11 +0100 | [diff] [blame] | 882 | unittest |
| 883 | -------- |
| 884 | |
| 885 | Add new method :meth:`~unittest.TestCase.assertNoLogs` to complement the |
| 886 | existing :meth:`~unittest.TestCase.assertLogs`. (Contributed by Kit Yan Choi |
| 887 | in :issue:`39385`.) |
| 888 | |
Adam Goldschmidt | fcbe0cb | 2021-02-15 00:41:57 +0200 | [diff] [blame] | 889 | urllib.parse |
| 890 | ------------ |
| 891 | |
| 892 | Python versions earlier than Python 3.10 allowed using both ``;`` and ``&`` as |
| 893 | query parameter separators in :func:`urllib.parse.parse_qs` and |
| 894 | :func:`urllib.parse.parse_qsl`. Due to security concerns, and to conform with |
| 895 | newer W3C recommendations, this has been changed to allow only a single |
| 896 | separator key, with ``&`` as the default. This change also affects |
| 897 | :func:`cgi.parse` and :func:`cgi.parse_multipart` as they use the affected |
| 898 | functions internally. For more details, please see their respective |
| 899 | documentation. |
| 900 | (Contributed by Adam Goldschmidt, Senthil Kumaran and Ken Jin in :issue:`42967`.) |
| 901 | |
Zackery Spytz | e28b8c9 | 2020-08-09 04:50:53 -0600 | [diff] [blame] | 902 | xml |
| 903 | --- |
| 904 | |
| 905 | Add a :class:`~xml.sax.handler.LexicalHandler` class to the |
| 906 | :mod:`xml.sax.handler` module. |
| 907 | (Contributed by Jonathan Gossage and Zackery Spytz in :issue:`35018`.) |
| 908 | |
Brett Cannon | d2e94bb | 2020-11-13 15:14:58 -0800 | [diff] [blame] | 909 | zipimport |
| 910 | --------- |
| 911 | Add methods related to :pep:`451`: :meth:`~zipimport.zipimporter.find_spec`, |
| 912 | :meth:`zipimport.zipimporter.create_module`, and |
| 913 | :meth:`zipimport.zipimporter.exec_module`. |
| 914 | (Contributed by Brett Cannon in :issue:`42131`. |
| 915 | |
Serhiy Storchaka | 8a64cea | 2020-06-18 22:08:27 +0300 | [diff] [blame] | 916 | |
Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 917 | Optimizations |
| 918 | ============= |
| 919 | |
Serhiy Storchaka | 12f4334 | 2020-07-20 15:53:55 +0300 | [diff] [blame] | 920 | * Constructors :func:`str`, :func:`bytes` and :func:`bytearray` are now faster |
| 921 | (around 30--40% for small objects). |
| 922 | (Contributed by Serhiy Storchaka in :issue:`41334`.) |
| 923 | |
Victor Stinner | 2c2a4f3 | 2020-06-18 01:20:51 +0200 | [diff] [blame] | 924 | * The :mod:`runpy` module now imports fewer modules. |
Victor Stinner | cd27af7 | 2021-03-23 20:22:40 +0100 | [diff] [blame^] | 925 | The ``python3 -m module-name`` command startup time is 1.4x faster in |
| 926 | average. On Linux, ``python3 -I -m module-name`` imports 69 modules on Python |
| 927 | 3.9, whereas it only imports 51 modules (-18) on Python 3.10. |
| 928 | (Contributed by Victor Stinner in :issue:`41006` and :issue:`41718`.) |
Victor Stinner | 4c18fc8 | 2020-06-17 23:58:58 +0200 | [diff] [blame] | 929 | |
Pablo Galindo | 9e8fe19 | 2021-01-03 04:37:46 +0000 | [diff] [blame] | 930 | * The ``LOAD_ATTR`` instruction now uses new "per opcode cache" mechanism. It |
Pablo Galindo | a776da9 | 2021-01-31 22:55:48 +0000 | [diff] [blame] | 931 | is about 36% faster now for regular attributes and 44% faster for slots. |
| 932 | (Contributed by Pablo Galindo and Yury Selivanov in :issue:`42093` and Guido |
| 933 | van Rossum in :issue:`42927`, based on ideas implemented originally in PyPy |
| 934 | and MicroPython.) |
Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 935 | |
Pablo Galindo | b451b0e | 2020-10-21 22:46:52 +0100 | [diff] [blame] | 936 | * When building Python with ``--enable-optimizations`` now |
| 937 | ``-fno-semantic-interposition`` is added to both the compile and link line. |
| 938 | This speeds builds of the Python interpreter created with ``--enable-shared`` |
| 939 | with ``gcc`` by up to 30%. See `this article |
| 940 | <https://developers.redhat.com/blog/2020/06/25/red-hat-enterprise-linux-8-2-brings-faster-python-3-8-run-speeds/>`_ |
| 941 | for more details. (Contributed by Victor Stinner and Pablo Galindo in |
Brett Cannon | 2de5097 | 2020-12-04 15:39:21 -0800 | [diff] [blame] | 942 | :issue:`38980`.) |
| 943 | |
Pablo Galindo | b451b0e | 2020-10-21 22:46:52 +0100 | [diff] [blame] | 944 | |
Yurii Karabas | 7301979 | 2020-11-25 12:43:18 +0200 | [diff] [blame] | 945 | * Function parameters and their annotations are no longer computed at runtime, |
| 946 | but rather at compilation time. They are stored as a tuple of strings at the |
Pablo Galindo | 8747c1f | 2021-03-04 01:29:29 +0000 | [diff] [blame] | 947 | bytecode level. It is now around 2 times faster to create a function with |
| 948 | parameter annotations. (Contributed by Yurii Karabas and Inada Naoki |
| 949 | in :issue:`42202`) |
Yurii Karabas | 7301979 | 2020-11-25 12:43:18 +0200 | [diff] [blame] | 950 | |
Dennis Sweeney | e8f5ddd | 2021-02-28 16:32:04 -0500 | [diff] [blame] | 951 | * Substring search functions such as ``str1 in str2`` and ``str2.find(str1)`` |
| 952 | now sometimes use Crochemore & Perrin's "Two-Way" string searching |
| 953 | algorithm to avoid quadratic behavior on long strings. (Contributed |
| 954 | by Dennis Sweeney in :issue:`41972`) |
| 955 | |
Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 956 | Deprecated |
| 957 | ========== |
| 958 | |
Brett Cannon | 04523c5 | 2020-10-23 18:10:54 -0700 | [diff] [blame] | 959 | * Starting in this release, there will be a concerted effort to begin |
| 960 | cleaning up old import semantics that were kept for Python 2.7 |
| 961 | compatibility. Specifically, |
| 962 | :meth:`~importlib.abc.PathEntryFinder.find_loader`/:meth:`~importlib.abc.Finder.find_module` |
| 963 | (superseded by :meth:`~importlib.abc.Finder.find_spec`), |
| 964 | :meth:`~importlib.abc.Loader.load_module` |
| 965 | (superseded by :meth:`~importlib.abc.Loader.exec_module`), |
| 966 | :meth:`~importlib.abc.Loader.module_repr` (which the import system |
| 967 | takes care of for you), the ``__package__`` attribute |
| 968 | (superseded by ``__spec__.parent``), the ``__loader__`` attribute |
| 969 | (superseded by ``__spec__.loader``), and the ``__cached__`` attribute |
| 970 | (superseded by ``__spec__.cached``) will slowly be removed (as well |
| 971 | as other classes and methods in :mod:`importlib`). |
| 972 | :exc:`ImportWarning` and/or :exc:`DeprecationWarning` will be raised |
| 973 | as appropriate to help identify code which needs updating during |
| 974 | this transition. |
| 975 | |
Steve Dower | 62949f6 | 2021-01-29 21:48:55 +0000 | [diff] [blame] | 976 | * The entire ``distutils`` namespace is deprecated, to be removed in |
| 977 | Python 3.12. Refer to the :ref:`module changes <distutils-deprecated>` |
| 978 | section for more information. |
| 979 | |
Serhiy Storchaka | f066bd9 | 2021-01-25 23:02:04 +0200 | [diff] [blame] | 980 | * Non-integer arguments to :func:`random.randrange` are deprecated. |
| 981 | The :exc:`ValueError` is deprecated in favor of a :exc:`TypeError`. |
| 982 | (Contributed by Serhiy Storchaka and Raymond Hettinger in :issue:`37319`.) |
| 983 | |
Brett Cannon | 2de5097 | 2020-12-04 15:39:21 -0800 | [diff] [blame] | 984 | * The various ``load_module()`` methods of :mod:`importlib` have been |
| 985 | documented as deprecated since Python 3.6, but will now also trigger |
| 986 | a :exc:`DeprecationWarning`. Use |
| 987 | :meth:`~importlib.abc.Loader.exec_module` instead. |
| 988 | (Contributed by Brett Cannon in :issue:`26131`.) |
| 989 | |
| 990 | * :meth:`zimport.zipimporter.load_module` has been deprecated in |
| 991 | preference for :meth:`~zipimport.zipimporter.exec_module`. |
| 992 | (Contributed by Brett Cannon in :issue:`26131`.) |
| 993 | |
| 994 | * The use of :meth:`~importlib.abc.Loader.load_module` by the import |
| 995 | system now triggers an :exc:`ImportWarning` as |
| 996 | :meth:`~importlib.abc.Loader.exec_module` is preferred. |
| 997 | (Contributed by Brett Cannon in :issue:`26131`.) |
| 998 | |
Erlend Egeberg Aasland | a1f401a | 2020-11-17 16:55:12 +0100 | [diff] [blame] | 999 | * ``sqlite3.OptimizedUnicode`` has been undocumented and obsolete since Python |
| 1000 | 3.3, when it was made an alias to :class:`str`. It is now deprecated, |
| 1001 | scheduled for removal in Python 3.12. |
| 1002 | (Contributed by Erlend E. Aasland in :issue:`42264`.) |
| 1003 | |
Erlend Egeberg Aasland | ddb5e11 | 2021-01-06 01:36:04 +0100 | [diff] [blame] | 1004 | * The undocumented built-in function ``sqlite3.enable_shared_cache`` is now |
| 1005 | deprecated, scheduled for removal in Python 3.12. Its use is strongly |
| 1006 | discouraged by the SQLite3 documentation. See `the SQLite3 docs |
Tom Forbes | 749d40a | 2021-02-10 17:56:16 +0000 | [diff] [blame] | 1007 | <https://sqlite.org/c3ref/enable_shared_cache.html>`_ for more details. |
Erlend Egeberg Aasland | ddb5e11 | 2021-01-06 01:36:04 +0100 | [diff] [blame] | 1008 | If shared cache must be used, open the database in URI mode using the |
| 1009 | ``cache=shared`` query parameter. |
| 1010 | (Contributed by Erlend E. Aasland in :issue:`24464`.) |
| 1011 | |
Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 1012 | |
Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 1013 | Removed |
| 1014 | ======= |
| 1015 | |
Serhiy Storchaka | e2ec0b2 | 2020-10-09 14:14:37 +0300 | [diff] [blame] | 1016 | * Removed special methods ``__int__``, ``__float__``, ``__floordiv__``, |
| 1017 | ``__mod__``, ``__divmod__``, ``__rfloordiv__``, ``__rmod__`` and |
| 1018 | ``__rdivmod__`` of the :class:`complex` class. They always raised |
| 1019 | a :exc:`TypeError`. |
| 1020 | (Contributed by Serhiy Storchaka in :issue:`41974`.) |
| 1021 | |
Berker Peksag | d4d127f | 2020-07-16 09:38:58 +0300 | [diff] [blame] | 1022 | * The ``ParserBase.error()`` method from the private and undocumented ``_markupbase`` |
| 1023 | module has been removed. :class:`html.parser.HTMLParser` is the only subclass of |
| 1024 | ``ParserBase`` and its ``error()`` implementation has already been removed in |
| 1025 | Python 3.5. |
| 1026 | (Contributed by Berker Peksag in :issue:`31844`.) |
| 1027 | |
Victor Stinner | 84f7382 | 2020-10-27 04:36:22 +0100 | [diff] [blame] | 1028 | * Removed the ``unicodedata.ucnhash_CAPI`` attribute which was an internal |
| 1029 | PyCapsule object. The related private ``_PyUnicode_Name_CAPI`` structure was |
| 1030 | moved to the internal C API. |
| 1031 | (Contributed by Victor Stinner in :issue:`42157`.) |
| 1032 | |
Lysandros Nikolaou | c26d591 | 2020-11-16 20:46:37 +0200 | [diff] [blame] | 1033 | * Removed the ``parser`` module, which was deprecated in 3.9 due to the |
| 1034 | switch to the new PEG parser, as well as all the C source and header files |
| 1035 | that were only being used by the old parser, including ``node.h``, ``parser.h``, |
| 1036 | ``graminit.h`` and ``grammar.h``. |
| 1037 | |
| 1038 | * Removed the Public C API functions :c:func:`PyParser_SimpleParseStringFlags`, |
| 1039 | :c:func:`PyParser_SimpleParseStringFlagsFilename`, |
| 1040 | :c:func:`PyParser_SimpleParseFileFlags` and :c:func:`PyNode_Compile` |
| 1041 | that were deprecated in 3.9 due to the switch to the new PEG parser. |
| 1042 | |
Dong-hee Na | be319c0 | 2020-11-25 22:17:30 +0900 | [diff] [blame] | 1043 | * Removed the ``formatter`` module, which was deprecated in Python 3.4. |
| 1044 | It is somewhat obsolete, little used, and not tested. It was originally |
| 1045 | scheduled to be removed in Python 3.6, but such removals were delayed until |
| 1046 | after Python 2.7 EOL. Existing users should copy whatever classes they use |
| 1047 | into their code. |
| 1048 | (Contributed by Dong-hee Na and Terry J. Reedy in :issue:`42299`.) |
Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 1049 | |
Hai Shi | 0f91f58 | 2020-12-08 22:42:42 +0800 | [diff] [blame] | 1050 | * Removed the :c:func:`PyModule_GetWarningsModule` function that was useless |
| 1051 | now due to the _warnings module was converted to a builtin module in 2.6. |
| 1052 | (Contributed by Hai Shi in :issue:`42599`.) |
| 1053 | |
Hugo van Kemenade | c47c78b | 2021-01-13 01:16:37 +0200 | [diff] [blame] | 1054 | * Remove deprecated aliases to :ref:`collections-abstract-base-classes` from |
| 1055 | the :mod:`collections` module. |
| 1056 | (Contributed by Victor Stinner in :issue:`37324`.) |
| 1057 | |
Ken Jin | dcea78f | 2021-01-20 16:16:12 -0800 | [diff] [blame] | 1058 | * The ``loop`` parameter has been removed from most of :mod:`asyncio`\ 's |
| 1059 | :doc:`high-level API <../library/asyncio-api-index>` following deprecation |
| 1060 | in Python 3.8. The motivation behind this change is multifold: |
| 1061 | |
| 1062 | 1. This simplifies the high-level API. |
| 1063 | 2. The functions in the high-level API have been implicitly getting the |
| 1064 | current thread's running event loop since Python 3.7. There isn't a need to |
| 1065 | pass the event loop to the API in most normal use cases. |
| 1066 | 3. Event loop passing is error-prone especially when dealing with loops |
| 1067 | running in different threads. |
| 1068 | |
| 1069 | Note that the low-level API will still accept ``loop``. |
| 1070 | See `Changes in the Python API`_ for examples of how to replace existing code. |
| 1071 | |
| 1072 | (Contributed by Yurii Karabas, Andrew Svetlov, Yury Selivanov and Kyle Stanley |
| 1073 | in :issue:`42392`.) |
| 1074 | |
Hai Shi | 0f91f58 | 2020-12-08 22:42:42 +0800 | [diff] [blame] | 1075 | |
Pablo Galindo | d4fe098 | 2020-05-19 03:33:01 +0100 | [diff] [blame] | 1076 | Porting to Python 3.10 |
| 1077 | ====================== |
| 1078 | |
| 1079 | This section lists previously described changes and other bugfixes |
| 1080 | that may require changes to your code. |
| 1081 | |
| 1082 | |
Zackery Spytz | 91e9379 | 2020-11-05 15:18:44 -0700 | [diff] [blame] | 1083 | Changes in the Python API |
| 1084 | ------------------------- |
| 1085 | |
| 1086 | * The *etype* parameters of the :func:`~traceback.format_exception`, |
| 1087 | :func:`~traceback.format_exception_only`, and |
| 1088 | :func:`~traceback.print_exception` functions in the :mod:`traceback` module |
| 1089 | have been renamed to *exc*. |
| 1090 | (Contributed by Zackery Spytz and Matthias Bussonnier in :issue:`26389`.) |
| 1091 | |
Victor Stinner | 357704c | 2020-12-14 23:07:54 +0100 | [diff] [blame] | 1092 | * :mod:`atexit`: At Python exit, if a callback registered with |
| 1093 | :func:`atexit.register` fails, its exception is now logged. Previously, only |
| 1094 | some exceptions were logged, and the last exception was always silently |
| 1095 | ignored. |
| 1096 | (Contributed by Victor Stinner in :issue:`42639`.) |
| 1097 | |
kj | d75f6f7 | 2020-12-19 01:39:26 +0800 | [diff] [blame] | 1098 | * :class:`collections.abc.Callable` generic now flattens type parameters, similar |
| 1099 | to what :data:`typing.Callable` currently does. This means that |
| 1100 | ``collections.abc.Callable[[int, str], str]`` will have ``__args__`` of |
| 1101 | ``(int, str, str)``; previously this was ``([int, str], str)``. Code which |
| 1102 | accesses the arguments via :func:`typing.get_args` or ``__args__`` need to account |
| 1103 | for this change. Furthermore, :exc:`TypeError` may be raised for invalid forms |
| 1104 | of parameterizing :class:`collections.abc.Callable` which may have passed |
| 1105 | silently in Python 3.9. |
| 1106 | (Contributed by Ken Jin in :issue:`42195`.) |
Victor Stinner | 357704c | 2020-12-14 23:07:54 +0100 | [diff] [blame] | 1107 | |
Erlend Egeberg Aasland | f4936ad | 2020-12-31 14:16:50 +0100 | [diff] [blame] | 1108 | * :meth:`socket.htons` and :meth:`socket.ntohs` now raise :exc:`OverflowError` |
| 1109 | instead of :exc:`DeprecationWarning` if the given parameter will not fit in |
| 1110 | a 16-bit unsigned integer. |
| 1111 | (Contributed by Erlend E. Aasland in :issue:`42393`.) |
| 1112 | |
Ken Jin | dcea78f | 2021-01-20 16:16:12 -0800 | [diff] [blame] | 1113 | * The ``loop`` parameter has been removed from most of :mod:`asyncio`\ 's |
| 1114 | :doc:`high-level API <../library/asyncio-api-index>` following deprecation |
| 1115 | in Python 3.8. |
| 1116 | |
| 1117 | A coroutine that currently look like this:: |
| 1118 | |
| 1119 | async def foo(loop): |
| 1120 | await asyncio.sleep(1, loop=loop) |
| 1121 | |
| 1122 | Should be replaced with this:: |
| 1123 | |
| 1124 | async def foo(): |
| 1125 | await asyncio.sleep(1) |
| 1126 | |
| 1127 | If ``foo()`` was specifically designed *not* to run in the current thread's |
| 1128 | running event loop (e.g. running in another thread's event loop), consider |
| 1129 | using :func:`asyncio.run_coroutine_threadsafe` instead. |
| 1130 | |
| 1131 | (Contributed by Yurii Karabas, Andrew Svetlov, Yury Selivanov and Kyle Stanley |
| 1132 | in :issue:`42392`.) |
Erlend Egeberg Aasland | f4936ad | 2020-12-31 14:16:50 +0100 | [diff] [blame] | 1133 | |
Victor Stinner | 46496f9 | 2021-02-20 15:17:18 +0100 | [diff] [blame] | 1134 | * The :data:`types.FunctionType` constructor now inherits the current builtins |
| 1135 | if the *globals* dictionary has no ``"__builtins__"`` key, rather than using |
| 1136 | ``{"None": None}`` as builtins: same behavior as :func:`eval` and |
| 1137 | :func:`exec` functions. Defining a function with ``def function(...): ...`` |
| 1138 | in Python is not affected, globals cannot be overriden with this syntax: it |
| 1139 | also inherits the current builtins. |
| 1140 | (Contributed by Victor Stinner in :issue:`42990`.) |
| 1141 | |
Yurii Karabas | 7301979 | 2020-11-25 12:43:18 +0200 | [diff] [blame] | 1142 | CPython bytecode changes |
| 1143 | ======================== |
| 1144 | |
| 1145 | * The ``MAKE_FUNCTION`` instruction accepts tuple of strings as annotations |
| 1146 | instead of dictionary. |
| 1147 | (Contributed by Yurii Karabas and Inada Naoki in :issue:`42202`) |
Dong-hee Na | ad3252b | 2020-05-26 01:52:54 +0900 | [diff] [blame] | 1148 | |
| 1149 | Build Changes |
| 1150 | ============= |
| 1151 | |
Victor Stinner | 7ab92d5 | 2020-06-16 00:54:44 +0200 | [diff] [blame] | 1152 | * The C99 functions :c:func:`snprintf` and :c:func:`vsnprintf` are now required |
| 1153 | to build Python. |
| 1154 | (Contributed by Victor Stinner in :issue:`36020`.) |
| 1155 | |
Erlend Egeberg Aasland | cf0b239 | 2021-01-06 01:02:43 +0100 | [diff] [blame] | 1156 | * :mod:`sqlite3` requires SQLite 3.7.15 or higher. (Contributed by Sergey Fedoseev |
| 1157 | and Erlend E. Aasland :issue:`40744` and :issue:`40810`.) |
Erlend Egeberg Aasland | 207c321 | 2020-09-07 23:26:54 +0200 | [diff] [blame] | 1158 | |
Victor Stinner | 357704c | 2020-12-14 23:07:54 +0100 | [diff] [blame] | 1159 | * The :mod:`atexit` module must now always be built as a built-in module. |
| 1160 | (Contributed by Victor Stinner in :issue:`42639`.) |
Erlend Egeberg Aasland | 207c321 | 2020-09-07 23:26:54 +0200 | [diff] [blame] | 1161 | |
pxinwr | 277ce30 | 2020-12-30 20:50:39 +0800 | [diff] [blame] | 1162 | * Added ``--disable-test-modules`` option to the ``configure`` script: |
| 1163 | don't build nor install test modules. |
| 1164 | (Contributed by Xavier de Gaye, Thomas Petazzoni and Peixing Xin in :issue:`27640`.) |
| 1165 | |
Victor Stinner | 75e59a9 | 2021-01-20 17:07:21 +0100 | [diff] [blame] | 1166 | * Add ``--with-wheel-pkg-dir=PATH`` option to the ``./configure`` script. If |
| 1167 | specified, the :mod:`ensurepip` module looks for ``setuptools`` and ``pip`` |
| 1168 | wheel packages in this directory: if both are present, these wheel packages |
| 1169 | are used instead of ensurepip bundled wheel packages. |
| 1170 | |
| 1171 | Some Linux distribution packaging policies recommend against bundling |
| 1172 | dependencies. For example, Fedora installs wheel packages in the |
| 1173 | ``/usr/share/python-wheels/`` directory and don't install the |
| 1174 | ``ensurepip._bundled`` package. |
| 1175 | |
| 1176 | (Contributed by Victor Stinner in :issue:`42856`.) |
| 1177 | |
Victor Stinner | 801bb0b | 2021-02-17 11:14:42 +0100 | [diff] [blame] | 1178 | * Add a new configure ``--without-static-libpython`` option to not build the |
| 1179 | ``libpythonMAJOR.MINOR.a`` static library and not install the ``python.o`` |
| 1180 | object file. |
| 1181 | |
| 1182 | (Contributed by Victor Stinner in :issue:`43103`.) |
| 1183 | |
Ned Deily | a65b050 | 2021-03-01 00:27:20 -0500 | [diff] [blame] | 1184 | * The ``configure`` script now uses the ``pkg-config`` utility, if available, |
| 1185 | to detect the location of Tcl/Tk headers and libraries. As before, those |
| 1186 | locations can be explicitly specified with the ``--with-tcltk-includes`` |
| 1187 | and ``--with-tcltk-libs`` configuration options. |
| 1188 | (Contributed by Manolis Stamatogiannakis in :issue:`42603`.) |
| 1189 | |
Christian Heimes | 32eba61 | 2021-03-19 10:29:25 +0100 | [diff] [blame] | 1190 | * Add ``--with-openssl-rpath`` option to ``configure`` script. The option |
| 1191 | simplifies building Python with a custom OpenSSL installation, e.g. |
| 1192 | ``./configure --with-openssl=/path/to/openssl --with-openssl-rpath=auto``. |
| 1193 | (Contributed by Christian Heimes in :issue:`43466`.) |
| 1194 | |
| 1195 | |
Dong-hee Na | ad3252b | 2020-05-26 01:52:54 +0900 | [diff] [blame] | 1196 | |
| 1197 | C API Changes |
| 1198 | ============= |
| 1199 | |
| 1200 | New Features |
| 1201 | ------------ |
| 1202 | |
Victor Stinner | dd8a93e | 2020-06-30 00:49:03 +0200 | [diff] [blame] | 1203 | * The result of :c:func:`PyNumber_Index` now always has exact type :class:`int`. |
Serhiy Storchaka | 5f4b229d | 2020-05-28 10:33:45 +0300 | [diff] [blame] | 1204 | Previously, the result could have been an instance of a subclass of ``int``. |
| 1205 | (Contributed by Serhiy Storchaka in :issue:`40792`.) |
| 1206 | |
Victor Stinner | dd8a93e | 2020-06-30 00:49:03 +0200 | [diff] [blame] | 1207 | * Add a new :c:member:`~PyConfig.orig_argv` member to the :c:type:`PyConfig` |
| 1208 | structure: the list of the original command line arguments passed to the |
| 1209 | Python executable. |
| 1210 | (Contributed by Victor Stinner in :issue:`23427`.) |
Dong-hee Na | ad3252b | 2020-05-26 01:52:54 +0900 | [diff] [blame] | 1211 | |
Zackery Spytz | 2e4dd33 | 2020-09-23 12:43:45 -0600 | [diff] [blame] | 1212 | * The :c:func:`PyDateTime_DATE_GET_TZINFO` and |
| 1213 | :c:func:`PyDateTime_TIME_GET_TZINFO` macros have been added for accessing |
| 1214 | the ``tzinfo`` attributes of :class:`datetime.datetime` and |
| 1215 | :class:`datetime.time` objects. |
| 1216 | (Contributed by Zackery Spytz in :issue:`30155`.) |
| 1217 | |
Hai Shi | d332e7b | 2020-09-29 05:41:11 +0800 | [diff] [blame] | 1218 | * Add a :c:func:`PyCodec_Unregister` function to unregister a codec |
| 1219 | search function. |
| 1220 | (Contributed by Hai Shi in :issue:`41842`.) |
| 1221 | |
Vladimir Matveev | 24a54c0 | 2020-10-12 12:10:42 -0700 | [diff] [blame] | 1222 | * The :c:func:`PyIter_Send` function was added to allow |
Vladimir Matveev | 037245c | 2020-10-09 17:15:15 -0700 | [diff] [blame] | 1223 | sending value into iterator without raising ``StopIteration`` exception. |
| 1224 | (Contributed by Vladimir Matveev in :issue:`41756`.) |
| 1225 | |
Alex Gaynor | 3a8fdb2 | 2020-10-19 18:17:50 -0400 | [diff] [blame] | 1226 | * Added :c:func:`PyUnicode_AsUTF8AndSize` to the limited C API. |
| 1227 | (Contributed by Alex Gaynor in :issue:`41784`.) |
| 1228 | |
Victor Stinner | 8021875 | 2020-11-04 13:59:15 +0100 | [diff] [blame] | 1229 | * Added :c:func:`PyModule_AddObjectRef` function: similar to |
Victor Stinner | 95ce7cd | 2020-11-11 01:52:26 +0100 | [diff] [blame] | 1230 | :c:func:`PyModule_AddObject` but don't steal a reference to the value on |
Victor Stinner | 8021875 | 2020-11-04 13:59:15 +0100 | [diff] [blame] | 1231 | success. |
| 1232 | (Contributed by Victor Stinner in :issue:`1635741`.) |
| 1233 | |
Victor Stinner | 53a03aa | 2020-11-05 15:02:12 +0100 | [diff] [blame] | 1234 | * Added :c:func:`Py_NewRef` and :c:func:`Py_XNewRef` functions to increment the |
| 1235 | reference count of an object and return the object. |
| 1236 | (Contributed by Victor Stinner in :issue:`42262`.) |
| 1237 | |
Serhiy Storchaka | 686c203 | 2020-11-22 13:25:02 +0200 | [diff] [blame] | 1238 | * The :c:func:`PyType_FromSpecWithBases` and :c:func:`PyType_FromModuleAndSpec` |
| 1239 | functions now accept a single class as the *bases* argument. |
| 1240 | (Contributed by Serhiy Storchaka in :issue:`42423`.) |
| 1241 | |
Hai Shi | 88c2cfd | 2020-11-07 00:04:47 +0800 | [diff] [blame] | 1242 | * The :c:func:`PyType_FromModuleAndSpec` function now accepts NULL ``tp_doc`` |
| 1243 | slot. |
| 1244 | (Contributed by Hai Shi in :issue:`41832`.) |
| 1245 | |
Hai Shi | a13b26c | 2020-11-11 04:53:46 +0800 | [diff] [blame] | 1246 | * The :c:func:`PyType_GetSlot` function can accept static types. |
| 1247 | (Contributed by Hai Shi and Petr Viktorin in :issue:`41073`.) |
| 1248 | |
Pablo Galindo | d439fb3 | 2021-02-20 18:03:08 +0000 | [diff] [blame] | 1249 | * Add a new :c:func:`PySet_CheckExact` function to the C-API to check if an |
| 1250 | object is an instance of :class:`set` but not an instance of a subtype. |
| 1251 | (Contributed by Pablo Galindo in :issue:`43277`.) |
Alex Gaynor | 3a8fdb2 | 2020-10-19 18:17:50 -0400 | [diff] [blame] | 1252 | |
Antoine Pitrou | ba251c2 | 2021-03-11 23:35:45 +0100 | [diff] [blame] | 1253 | * Added :c:func:`PyErr_SetInterruptEx` which allows passing a signal number |
| 1254 | to simulate. |
| 1255 | (Contributed by Antoine Pitrou in :issue:`43356`.) |
| 1256 | |
| 1257 | |
Dong-hee Na | ad3252b | 2020-05-26 01:52:54 +0900 | [diff] [blame] | 1258 | Porting to Python 3.10 |
| 1259 | ---------------------- |
| 1260 | |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 1261 | * The ``PY_SSIZE_T_CLEAN`` macro must now be defined to use |
| 1262 | :c:func:`PyArg_ParseTuple` and :c:func:`Py_BuildValue` formats which use |
| 1263 | ``#``: ``es#``, ``et#``, ``s#``, ``u#``, ``y#``, ``z#``, ``U#`` and ``Z#``. |
| 1264 | See :ref:`Parsing arguments and building values |
| 1265 | <arg-parsing>` and the :pep:`353`. |
| 1266 | (Contributed by Victor Stinner in :issue:`40943`.) |
| 1267 | |
Victor Stinner | fe2978b | 2020-05-27 14:55:10 +0200 | [diff] [blame] | 1268 | * Since :c:func:`Py_REFCNT()` is changed to the inline static function, |
| 1269 | ``Py_REFCNT(obj) = new_refcnt`` must be replaced with ``Py_SET_REFCNT(obj, new_refcnt)``: |
Victor Stinner | dc24b8a | 2020-06-04 22:10:43 +0200 | [diff] [blame] | 1270 | see :c:func:`Py_SET_REFCNT()` (available since Python 3.9). For backward |
| 1271 | compatibility, this macro can be used:: |
| 1272 | |
| 1273 | #if PY_VERSION_HEX < 0x030900A4 |
| 1274 | # define Py_SET_REFCNT(obj, refcnt) ((Py_REFCNT(obj) = (refcnt)), (void)0) |
| 1275 | #endif |
| 1276 | |
Victor Stinner | fe2978b | 2020-05-27 14:55:10 +0200 | [diff] [blame] | 1277 | (Contributed by Victor Stinner in :issue:`39573`.) |
| 1278 | |
Victor Stinner | 59d3dce | 2020-06-02 14:03:25 +0200 | [diff] [blame] | 1279 | * Calling :c:func:`PyDict_GetItem` without :term:`GIL` held had been allowed |
| 1280 | for historical reason. It is no longer allowed. |
| 1281 | (Contributed by Victor Stinner in :issue:`40839`.) |
| 1282 | |
Inada Naoki | 038dd0f | 2020-06-30 15:26:56 +0900 | [diff] [blame] | 1283 | * ``PyUnicode_FromUnicode(NULL, size)`` and ``PyUnicode_FromStringAndSize(NULL, size)`` |
| 1284 | raise ``DeprecationWarning`` now. Use :c:func:`PyUnicode_New` to allocate |
| 1285 | Unicode object without initial data. |
| 1286 | (Contributed by Inada Naoki in :issue:`36346`.) |
| 1287 | |
Victor Stinner | 47e1afd | 2020-10-26 16:43:47 +0100 | [diff] [blame] | 1288 | * The private ``_PyUnicode_Name_CAPI`` structure of the PyCapsule API |
Victor Stinner | 84f7382 | 2020-10-27 04:36:22 +0100 | [diff] [blame] | 1289 | ``unicodedata.ucnhash_CAPI`` has been moved to the internal C API. |
Victor Stinner | 920cb64 | 2020-10-26 19:19:36 +0100 | [diff] [blame] | 1290 | (Contributed by Victor Stinner in :issue:`42157`.) |
Victor Stinner | 47e1afd | 2020-10-26 16:43:47 +0100 | [diff] [blame] | 1291 | |
Victor Stinner | ace3f9a | 2020-11-10 21:10:22 +0100 | [diff] [blame] | 1292 | * :c:func:`Py_GetPath`, :c:func:`Py_GetPrefix`, :c:func:`Py_GetExecPrefix`, |
| 1293 | :c:func:`Py_GetProgramFullPath`, :c:func:`Py_GetPythonHome` and |
| 1294 | :c:func:`Py_GetProgramName` functions now return ``NULL`` if called before |
| 1295 | :c:func:`Py_Initialize` (before Python is initialized). Use the new |
| 1296 | :ref:`Python Initialization Configuration API <init-config>` to get the |
| 1297 | :ref:`Python Path Configuration. <init-path-config>`. |
| 1298 | (Contributed by Victor Stinner in :issue:`42260`.) |
| 1299 | |
Victor Stinner | 0ef96c2 | 2020-12-07 11:56:20 +0100 | [diff] [blame] | 1300 | * :c:func:`PyList_SET_ITEM`, :c:func:`PyTuple_SET_ITEM` and |
| 1301 | :c:func:`PyCell_SET` macros can no longer be used as l-value or r-value. |
| 1302 | For example, ``x = PyList_SET_ITEM(a, b, c)`` and |
| 1303 | ``PyList_SET_ITEM(a, b, c) = x`` now fail with a compiler error. It prevents |
| 1304 | bugs like ``if (PyList_SET_ITEM (a, b, c) < 0) ...`` test. |
| 1305 | (Contributed by Zackery Spytz and Victor Stinner in :issue:`30459`.) |
| 1306 | |
Nicholas Sim | 4a6bf27 | 2021-02-19 22:55:46 +0800 | [diff] [blame] | 1307 | * The non-limited API files ``odictobject.h``, ``parser_interface.h``, |
| 1308 | ``picklebufobject.h``, ``pyarena.h``, ``pyctype.h``, ``pydebug.h``, |
| 1309 | ``pyfpe.h``, and ``pytime.h`` have been moved to the ``Include/cpython`` |
| 1310 | directory. These files must not be included directly, as they are already |
| 1311 | included in ``Python.h``: :ref:`Include Files <api-includes>`. If they have |
| 1312 | been included directly, consider including ``Python.h`` instead. |
| 1313 | (Contributed by Nicholas Sim in :issue:`35134`) |
| 1314 | |
Victor Stinner | 583ee5a | 2020-10-02 14:49:00 +0200 | [diff] [blame] | 1315 | Deprecated |
| 1316 | ---------- |
| 1317 | |
| 1318 | * The ``PyUnicode_InternImmortal()`` function is now deprecated |
| 1319 | and will be removed in Python 3.12: use :c:func:`PyUnicode_InternInPlace` |
| 1320 | instead. |
| 1321 | (Contributed by Victor Stinner in :issue:`41692`.) |
| 1322 | |
Dong-hee Na | ad3252b | 2020-05-26 01:52:54 +0900 | [diff] [blame] | 1323 | Removed |
| 1324 | ------- |
Inada Naoki | 6f8a6ee | 2020-06-26 08:07:22 +0900 | [diff] [blame] | 1325 | |
| 1326 | * ``PyObject_AsCharBuffer()``, ``PyObject_AsReadBuffer()``, ``PyObject_CheckReadBuffer()``, |
| 1327 | and ``PyObject_AsWriteBuffer()`` are removed. Please migrate to new buffer protocol; |
| 1328 | :c:func:`PyObject_GetBuffer` and :c:func:`PyBuffer_Release`. |
Inada Naoki | 20a7902 | 2020-06-27 18:22:09 +0900 | [diff] [blame] | 1329 | (Contributed by Inada Naoki in :issue:`41103`.) |
| 1330 | |
| 1331 | * Removed ``Py_UNICODE_str*`` functions manipulating ``Py_UNICODE*`` strings. |
| 1332 | (Contributed by Inada Naoki in :issue:`41123`.) |
| 1333 | |
| 1334 | * ``Py_UNICODE_strlen``: use :c:func:`PyUnicode_GetLength` or |
| 1335 | :c:macro:`PyUnicode_GET_LENGTH` |
| 1336 | * ``Py_UNICODE_strcat``: use :c:func:`PyUnicode_CopyCharacters` or |
| 1337 | :c:func:`PyUnicode_FromFormat` |
| 1338 | * ``Py_UNICODE_strcpy``, ``Py_UNICODE_strncpy``: use |
| 1339 | :c:func:`PyUnicode_CopyCharacters` or :c:func:`PyUnicode_Substring` |
| 1340 | * ``Py_UNICODE_strcmp``: use :c:func:`PyUnicode_Compare` |
| 1341 | * ``Py_UNICODE_strncmp``: use :c:func:`PyUnicode_Tailmatch` |
| 1342 | * ``Py_UNICODE_strchr``, ``Py_UNICODE_strrchr``: use |
| 1343 | :c:func:`PyUnicode_FindChar` |
Inada Naoki | d9f2a13 | 2020-06-29 10:46:51 +0900 | [diff] [blame] | 1344 | |
| 1345 | * Removed ``PyUnicode_GetMax()``. Please migrate to new (:pep:`393`) APIs. |
| 1346 | (Contributed by Inada Naoki in :issue:`41103`.) |
Inada Naoki | e4f1fe6 | 2020-06-29 13:00:43 +0900 | [diff] [blame] | 1347 | |
| 1348 | * Removed ``PyLong_FromUnicode()``. Please migrate to :c:func:`PyLong_FromUnicodeObject`. |
| 1349 | (Contributed by Inada Naoki in :issue:`41103`.) |
Inada Naoki | b333266 | 2020-06-30 12:23:07 +0900 | [diff] [blame] | 1350 | |
| 1351 | * Removed ``PyUnicode_AsUnicodeCopy()``. Please use :c:func:`PyUnicode_AsUCS4Copy` or |
| 1352 | :c:func:`PyUnicode_AsWideCharString` |
| 1353 | (Contributed by Inada Naoki in :issue:`41103`.) |
Victor Stinner | 19c3ac9 | 2020-09-23 14:04:57 +0200 | [diff] [blame] | 1354 | |
| 1355 | * Removed ``_Py_CheckRecursionLimit`` variable: it has been replaced by |
| 1356 | ``ceval.recursion_limit`` of the :c:type:`PyInterpreterState` structure. |
| 1357 | (Contributed by Victor Stinner in :issue:`41834`.) |
Serhiy Storchaka | dcc5421 | 2020-10-05 12:32:00 +0300 | [diff] [blame] | 1358 | |
| 1359 | * Removed undocumented macros ``Py_ALLOW_RECURSION`` and |
| 1360 | ``Py_END_ALLOW_RECURSION`` and the ``recursion_critical`` field of the |
| 1361 | :c:type:`PyInterpreterState` structure. |
| 1362 | (Contributed by Serhiy Storchaka in :issue:`41936`.) |
Victor Stinner | 296a796 | 2020-11-17 16:22:23 +0100 | [diff] [blame] | 1363 | |
| 1364 | * Removed the undocumented ``PyOS_InitInterrupts()`` function. Initializing |
| 1365 | Python already implicitly installs signal handlers: see |
| 1366 | :c:member:`PyConfig.install_signal_handlers`. |
| 1367 | (Contributed by Victor Stinner in :issue:`41713`.) |
Victor Stinner | eec8e61 | 2021-03-18 14:57:49 +0100 | [diff] [blame] | 1368 | |
| 1369 | * Remove the ``PyAST_Validate()`` function. It is no longer possible to build a |
| 1370 | AST object (``mod_ty`` type) with the public C API. The function was already |
| 1371 | excluded from the limited C API (:pep:`384`). |
| 1372 | (Contributed by Victor Stinner in :issue:`43244`.) |
Victor Stinner | 28ad12f | 2021-03-19 12:41:49 +0100 | [diff] [blame] | 1373 | |
| 1374 | * Remove the ``symtable.h`` header file and the undocumented functions: |
| 1375 | |
| 1376 | * ``PyST_GetScope()`` |
| 1377 | * ``PySymtable_Build()`` |
| 1378 | * ``PySymtable_BuildObject()`` |
| 1379 | * ``PySymtable_Free()`` |
| 1380 | * ``Py_SymtableString()`` |
| 1381 | * ``Py_SymtableStringObject()`` |
| 1382 | |
| 1383 | The ``Py_SymtableString()`` function was part the stable ABI by mistake but |
| 1384 | it could not be used, because the ``symtable.h`` header file was excluded |
| 1385 | from the limited C API. |
| 1386 | |
| 1387 | The Python :mod:`symtable` module remains available and is unchanged. |
| 1388 | (Contributed by Victor Stinner in :issue:`43244`.) |