Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 1 | **************************** |
| 2 | What's New In Python 3.4 |
| 3 | **************************** |
| 4 | |
| 5 | :Release: |release| |
| 6 | :Date: |today| |
| 7 | |
| 8 | .. Rules for maintenance: |
| 9 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 10 | * Anyone can add text to this document, but the maintainer reserves the |
| 11 | right to rewrite any additions. In particular, for obscure or esoteric |
| 12 | features, the maintainer may reduce any addition to a simple reference to |
| 13 | the new documentation rather than explaining the feature inline. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 14 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 15 | * While the maintainer will periodically go through Misc/NEWS |
| 16 | and add changes, it's best not to rely on this. We know from experience |
| 17 | that any changes that aren't in the What's New documentation around the |
| 18 | time of the original release will remain largely unknown to the community |
| 19 | for years, even if they're added later. We also know from experience that |
| 20 | other priorities can arise, and the maintainer will run out of time to do |
| 21 | updates - in such cases, end users will be much better served by partial |
| 22 | notifications that at least give a hint about new features to |
| 23 | investigate. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 24 | |
| 25 | * This is not a complete list of every single change; completeness |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 26 | is the purpose of Misc/NEWS. The What's New should focus on changes that |
| 27 | are visible to Python *users* and that *require* a feature release (i.e. |
| 28 | most bug fixes should only be recorded in Misc/NEWS) |
| 29 | |
| 30 | * PEPs should not be marked Final until they have an entry in What's New. |
| 31 | A placeholder entry that is just a section header and a link to the PEP |
| 32 | (e.g ":pep:`397` has been implemented") is acceptable. If a PEP has been |
| 33 | implemented and noted in What's New, don't forget to mark it as Final! |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 34 | |
| 35 | * If you want to draw your new text to the attention of the |
| 36 | maintainer, add 'XXX' to the beginning of the paragraph or |
| 37 | section. |
| 38 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 39 | * It's OK to add just a very brief note about a change. For |
| 40 | example: "The :ref:`~socket.transmogrify()` function was added to the |
| 41 | :mod:`socket` module." The maintainer will research the change and |
| 42 | write the necessary text (if appropriate). The advantage of doing this |
| 43 | is that even if no more descriptive text is ever added, readers will at |
| 44 | least have a notification that the new feature exists and a link to the |
| 45 | relevant documentation. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 46 | |
| 47 | * You can comment out your additions if you like, but it's not |
| 48 | necessary (especially when a final release is some months away). |
| 49 | |
| 50 | * Credit the author of a patch or bugfix. Just the name is |
| 51 | sufficient; the e-mail address isn't necessary. |
| 52 | |
| 53 | * It's helpful to add the bug/patch number as a comment: |
| 54 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 55 | The :ref:`~socket.transmogrify()` function was added to the |
| 56 | :mod:`socket` module. (Contributed by P.Y. Developer in :issue:`12345`.) |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 57 | |
| 58 | This saves the maintainer the effort of going through the Mercurial log |
| 59 | when researching a change. |
| 60 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 61 | * Cross referencing tip: :ref:`mod.attr` will display as ``mod.attr``, |
| 62 | while :ref:`~mod.attr` will display as ``attr``. |
| 63 | |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 64 | This article explains the new features in Python 3.4, compared to 3.3. |
| 65 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 66 | .. Python 3.4 was released on TBD. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 67 | |
| 68 | For full details, see the :source:`Misc/NEWS` file. |
| 69 | |
| 70 | .. note:: Prerelease users should be aware that this document is currently in |
| 71 | draft form. It will be updated substantially as Python 3.4 moves towards |
| 72 | release, so it's worth checking back even after reading earlier versions. |
| 73 | |
| 74 | |
| 75 | .. seealso:: |
| 76 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 77 | .. :pep:`4XX` - Python 3.4 Release Schedule |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 78 | |
| 79 | |
| 80 | Summary -- Release highlights |
| 81 | ============================= |
| 82 | |
| 83 | .. This section singles out the most important changes in Python 3.3. |
| 84 | Brevity is key. |
| 85 | |
| 86 | New syntax features: |
| 87 | |
| 88 | * None yet. |
| 89 | |
| 90 | New library modules: |
| 91 | |
| 92 | * None yet. |
| 93 | |
| 94 | New built-in features: |
| 95 | |
| 96 | * None yet. |
| 97 | |
| 98 | Implementation improvements: |
| 99 | |
| 100 | * None yet. |
| 101 | |
| 102 | Significantly Improved Library Modules: |
| 103 | |
Christian Heimes | 4a0270d | 2012-10-06 02:23:36 +0200 | [diff] [blame] | 104 | * SHA-3 (Keccak) support for :mod:`hashlib`. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 105 | |
| 106 | Security improvements: |
| 107 | |
| 108 | * None yet. |
| 109 | |
| 110 | Please read on for a comprehensive list of user-facing changes. |
| 111 | |
| 112 | |
| 113 | .. PEP-sized items next. |
| 114 | |
| 115 | .. _pep-4XX: |
| 116 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 117 | .. PEP 4XX: Example PEP |
| 118 | .. ==================== |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 119 | |
| 120 | |
| 121 | .. (Implemented by Foo Bar.) |
| 122 | |
| 123 | .. .. seealso:: |
| 124 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 125 | :pep:`4XX` - Example PEP |
| 126 | PEP written by Example Author |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 127 | |
| 128 | |
| 129 | |
| 130 | |
| 131 | Other Language Changes |
| 132 | ====================== |
| 133 | |
| 134 | Some smaller changes made to the core Python language are: |
| 135 | |
Georg Brandl | 50de850 | 2012-09-30 14:39:18 +0200 | [diff] [blame] | 136 | * Unicode database updated to UCD version 6.2. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 137 | |
| 138 | |
| 139 | |
| 140 | New Modules |
| 141 | =========== |
| 142 | |
| 143 | .. module name |
| 144 | .. ----------- |
| 145 | |
| 146 | * None yet. |
| 147 | |
| 148 | |
| 149 | Improved Modules |
| 150 | ================ |
| 151 | |
| 152 | * None yet. |
| 153 | |
| 154 | |
| 155 | Optimizations |
| 156 | ============= |
| 157 | |
| 158 | Major performance enhancements have been added: |
| 159 | |
| 160 | * None yet. |
| 161 | |
| 162 | |
| 163 | Build and C API Changes |
| 164 | ======================= |
| 165 | |
| 166 | Changes to Python's build process and to the C API include: |
| 167 | |
| 168 | * None yet. |
| 169 | |
| 170 | |
| 171 | Deprecated |
| 172 | ========== |
| 173 | |
| 174 | Unsupported Operating Systems |
| 175 | ----------------------------- |
| 176 | |
| 177 | * None yet. |
| 178 | |
| 179 | |
| 180 | Deprecated Python modules, functions and methods |
| 181 | ------------------------------------------------ |
| 182 | |
| 183 | * None yet. |
| 184 | |
| 185 | |
| 186 | Deprecated functions and types of the C API |
| 187 | ------------------------------------------- |
| 188 | |
| 189 | * None yet. |
| 190 | |
| 191 | |
| 192 | Deprecated features |
| 193 | ------------------- |
| 194 | |
| 195 | * None yet. |
| 196 | |
| 197 | |
Benjamin Peterson | 88f3b23 | 2012-10-04 12:45:10 -0400 | [diff] [blame] | 198 | Porting to Python 3.4 |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 199 | ===================== |
| 200 | |
| 201 | This section lists previously described changes and other bugfixes |
| 202 | that may require changes to your code. |
| 203 | |
| 204 | * Nothing yet. |