blob: 931a333ebf890de2763a71e76222d25bbe4153b0 [file] [log] [blame]
Georg Brandlb80f5112012-09-30 09:11:58 +02001****************************
2 What's New In Python 3.4
3****************************
4
5:Release: |release|
6:Date: |today|
7
8.. Rules for maintenance:
9
Nick Coghlan03074fd2012-09-30 18:51:53 +053010 * 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 Brandlb80f5112012-09-30 09:11:58 +020014
Nick Coghlan03074fd2012-09-30 18:51:53 +053015 * 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 Brandlb80f5112012-09-30 09:11:58 +020024
25 * This is not a complete list of every single change; completeness
Nick Coghlan03074fd2012-09-30 18:51:53 +053026 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 Brandlb80f5112012-09-30 09:11:58 +020034
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 Coghlan03074fd2012-09-30 18:51:53 +053039 * 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 Brandlb80f5112012-09-30 09:11:58 +020046
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 Coghlan03074fd2012-09-30 18:51:53 +053055 The :ref:`~socket.transmogrify()` function was added to the
56 :mod:`socket` module. (Contributed by P.Y. Developer in :issue:`12345`.)
Georg Brandlb80f5112012-09-30 09:11:58 +020057
58 This saves the maintainer the effort of going through the Mercurial log
59 when researching a change.
60
Nick Coghlan03074fd2012-09-30 18:51:53 +053061 * Cross referencing tip: :ref:`mod.attr` will display as ``mod.attr``,
62 while :ref:`~mod.attr` will display as ``attr``.
63
Georg Brandlb80f5112012-09-30 09:11:58 +020064This article explains the new features in Python 3.4, compared to 3.3.
65
Nick Coghlan03074fd2012-09-30 18:51:53 +053066.. Python 3.4 was released on TBD.
Georg Brandlb80f5112012-09-30 09:11:58 +020067
68For 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 Coghlan03074fd2012-09-30 18:51:53 +053077 .. :pep:`4XX` - Python 3.4 Release Schedule
Georg Brandlb80f5112012-09-30 09:11:58 +020078
79
80Summary -- Release highlights
81=============================
82
83.. This section singles out the most important changes in Python 3.3.
84 Brevity is key.
85
86New syntax features:
87
88* None yet.
89
90New library modules:
91
92* None yet.
93
94New built-in features:
95
96* None yet.
97
98Implementation improvements:
99
100* None yet.
101
102Significantly Improved Library Modules:
103
Christian Heimes4a0270d2012-10-06 02:23:36 +0200104* SHA-3 (Keccak) support for :mod:`hashlib`.
Georg Brandlb80f5112012-09-30 09:11:58 +0200105
106Security improvements:
107
108* None yet.
109
110Please read on for a comprehensive list of user-facing changes.
111
112
113.. PEP-sized items next.
114
115.. _pep-4XX:
116
Nick Coghlan03074fd2012-09-30 18:51:53 +0530117.. PEP 4XX: Example PEP
118.. ====================
Georg Brandlb80f5112012-09-30 09:11:58 +0200119
120
121.. (Implemented by Foo Bar.)
122
123.. .. seealso::
124
Nick Coghlan03074fd2012-09-30 18:51:53 +0530125 :pep:`4XX` - Example PEP
126 PEP written by Example Author
Georg Brandlb80f5112012-09-30 09:11:58 +0200127
128
129
130
131Other Language Changes
132======================
133
134Some smaller changes made to the core Python language are:
135
Georg Brandl50de8502012-09-30 14:39:18 +0200136* Unicode database updated to UCD version 6.2.
Georg Brandlb80f5112012-09-30 09:11:58 +0200137
138
139
140New Modules
141===========
142
143.. module name
144.. -----------
145
146* None yet.
147
148
149Improved Modules
150================
151
152* None yet.
153
154
155Optimizations
156=============
157
158Major performance enhancements have been added:
159
160* None yet.
161
162
163Build and C API Changes
164=======================
165
166Changes to Python's build process and to the C API include:
167
168* None yet.
169
170
171Deprecated
172==========
173
174Unsupported Operating Systems
175-----------------------------
176
177* None yet.
178
179
180Deprecated Python modules, functions and methods
181------------------------------------------------
182
183* None yet.
184
185
186Deprecated functions and types of the C API
187-------------------------------------------
188
189* None yet.
190
191
192Deprecated features
193-------------------
194
195* None yet.
196
197
Benjamin Peterson88f3b232012-10-04 12:45:10 -0400198Porting to Python 3.4
Georg Brandlb80f5112012-09-30 09:11:58 +0200199=====================
200
201This section lists previously described changes and other bugfixes
202that may require changes to your code.
203
204* Nothing yet.