Commit graph

162 commits

Author SHA1 Message Date
Senthil Kumaran
3858a1c18c Issue23675 - A tiny clarification in the MRO glossary term. 2016-01-09 22:33:54 -08:00
Brett Cannon
ccddbb186b Issue #23936: Clarify what finders are.
Thanks to Raúl Cumplido for the bug report and Thomas Kluyver for the
patch.
2015-12-04 15:46:21 -08:00
Martin Panter
84835ab1cb Issue #25161: Merge full stops from 3.4 into 3.5 2015-10-10 10:44:25 +00:00
Martin Panter
d21e0b52f1 Issue #25161: Add full stops in documentation; patch by Takase Arihiro 2015-10-10 10:36:22 +00:00
Martin Panter
446977c080 Issue #25286: Merge dictionary view glossary from 3.4 into 3.5 2015-10-07 10:01:04 +00:00
Martin Panter
85b8f45515 Issue #25286: Dictionary views are not sequences
Also change glossary heading from view
2015-10-07 09:56:46 +00:00
Stefan Krah
70e543b266 Issue #23756: Clarify the terms "contiguous" and "bytes-like object".
Patch by Martin Panter.
2015-08-08 14:33:28 +02:00
Yury Selivanov
66f8828bfc Issue #24439: Improve PEP 492 related docs.
Patch by Martin Panter.
2015-06-24 11:04:15 -04:00
Yury Selivanov
5376ba9630 Issue #24400: Introduce a distinct type for 'async def' coroutines.
Summary of changes:

1. Coroutines now have a distinct, separate from generators
   type at the C level: PyGen_Type, and a new typedef PyCoroObject.
   PyCoroObject shares the initial segment of struct layout with
   PyGenObject, making it possible to reuse existing generators
   machinery.  The new type is exposed as 'types.CoroutineType'.

   As a consequence of having a new type, CO_GENERATOR flag is
   no longer applied to coroutines.

2. Having a separate type for coroutines made it possible to add
   an __await__ method to the type.  Although it is not used by the
   interpreter (see details on that below), it makes coroutines
   naturally (without using __instancecheck__) conform to
   collections.abc.Coroutine and collections.abc.Awaitable ABCs.

   [The __instancecheck__ is still used for generator-based
   coroutines, as we don't want to add __await__ for generators.]

3. Add new opcode: GET_YIELD_FROM_ITER.  The opcode is needed to
   allow passing native coroutines to the YIELD_FROM opcode.

   Before this change, 'yield from o' expression was compiled to:

      (o)
      GET_ITER
      LOAD_CONST
      YIELD_FROM

   Now, we use GET_YIELD_FROM_ITER instead of GET_ITER.

   The reason for adding a new opcode is that GET_ITER is used
   in some contexts (such as 'for .. in' loops) where passing
   a coroutine object is invalid.

4. Add two new introspection functions to the inspec module:
   getcoroutinestate(c) and getcoroutinelocals(c).

5. inspect.iscoroutine(o) is updated to test if 'o' is a native
   coroutine object.  Before this commit it used abc.Coroutine,
   and it was requested to update inspect.isgenerator(o) to use
   abc.Generator; it was decided, however, that inspect functions
   should really be tailored for checking for native types.

6. sys.set_coroutine_wrapper(w) API is updated to work with only
   native coroutines.  Since types.coroutine decorator supports
   any type of callables now, it would be confusing that it does
   not work for all types of coroutines.

7. Exceptions logic in generators C implementation was updated
   to raise clearer messages for coroutines:

   Before: TypeError("generator raised StopIteration")
   After: TypeError("coroutine raised StopIteration")
2015-06-22 12:19:30 -04:00
Yury Selivanov
a18cad543f Issue 24180: Fixes by Berker Peksag. 2015-05-21 17:02:31 -04:00
Yury Selivanov
f3e40fac10 Issue 24180: Documentation for PEP 492 changes. 2015-05-21 11:50:30 -04:00
Larry Hastings
ab792ac704 Doc clarification / edification on the semantics of the 'w*' format unit. 2015-04-13 11:30:56 -04:00
Georg Brandl
0443c92ee1 merge with 3.4 2015-01-15 08:16:25 +01:00
Georg Brandl
caa12dab69 Closes #23244: fix typo. Thanks Mayank Tripathi for the patch. 2015-01-15 08:16:01 +01:00
Nick Coghlan
582acb75e9 Merge issue 19548 changes from 3.4 2015-01-07 00:37:01 +10:00
Nick Coghlan
b9fdb7a452 Issue 19548: update codecs module documentation
- clarified the distinction between text encodings and other codecs
- clarified relationship with builtin open and the io module
- consolidated documentation of error handlers into one section
- clarified type constraints of some behaviours
- added tests for some of the new statements in the docs
2015-01-07 00:22:00 +10:00
Antoine Pitrou
5db1bb81ff Issue #22696: Add function :func:sys.is_finalizing to know about interpreter shutdown. 2014-12-07 01:28:27 +01:00
Georg Brandl
cadc3fdcb5 Merge with 3.4 2014-10-29 08:37:29 +01:00
Georg Brandl
e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Georg Brandl
033ec051f8 merge with 3.4 2014-10-06 16:48:38 +02:00
Georg Brandl
4dd27a3edb Closes #21782: the default hash(x) is not exactly id(x) but derived from it. 2014-10-06 16:45:23 +02:00
Nick Coghlan
4a4b679515 Merge issue #22295 fix from 3.4 2014-09-06 20:40:00 +10:00
Nick Coghlan
1d52096d14 Issue #22295: Adopt 'python -m pip' as the preferred invocation 2014-09-06 20:38:23 +10:00
Terry Jan Reedy
8d2d8894da Merge with 3.4 2014-08-23 18:29:02 -04:00
Terry Jan Reedy
004e87048a Issue #22232 (partial fix): update Universal newlines Glossary entry. 2014-08-23 18:28:44 -04:00
Raymond Hettinger
35db43955c Issue #13742: Add key and reverse parameters to heapq.merge() 2014-05-30 02:28:36 -07:00
Larry Hastings
3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Andrew Kuchling
a3d0ffe2c6 Merge from 3.3 2014-02-15 17:22:41 -05:00
Andrew Kuchling
cb3ff4468a #16728: Mention collections.abc.Sequence in 'sequence' glossary entry 2014-02-15 17:05:26 -05:00
Eric Snow
ca2d854df8 Issue #19713: Update importlib docs for module spec changes, including deprecations. 2013-12-16 23:06:52 -07:00
Antoine Pitrou
710280b6d6 Issue #18840: Introduce the json module in the tutorial, and deemphasize the pickle module. 2013-12-05 23:48:10 +01:00
Antoine Pitrou
dd799d2e32 Issue #18840: Introduce the json module in the tutorial, and deemphasize the pickle module. 2013-12-05 23:46:32 +01:00
Zachary Ware
e19e3f0b91 Issue #18326: merge with 3.3 2013-11-22 14:03:10 -06:00
Zachary Ware
e1391a0d68 Issue #18326: Clarify that list.sort's arguments are keyword-only.
Also, attempt to reduce confusion in the glossary by not saying there are
different "types" of arguments and parameters.
2013-11-22 13:58:34 -06:00
Nick Coghlan
4dae27a08d Tweak 'provisional' in glossary 2013-10-20 13:22:04 +10:00
Serhiy Storchaka
0d85b5c68d Issue #19190: Improve cross-references in builtin types and functions documentation. 2013-10-09 14:03:24 +03:00
Serhiy Storchaka
0d196edc37 Issue #19190: Improve cross-references in builtin types and functions documentation. 2013-10-09 14:02:31 +03:00
Georg Brandl
245c765d0a merge with 3.3 2013-10-08 08:06:27 +02:00
Georg Brandl
bcce1256e3 Closes #19178: some more cross-references about packages in glossary. Patch by Berker Peksag. 2013-10-08 08:06:18 +02:00
Georg Brandl
7e41547c47 merge with 3.3 2013-10-06 11:57:23 +02:00
Georg Brandl
60e602dcc6 Fix small grammar mistake. 2013-10-06 11:57:13 +02:00
Łukasz Langa
fdcf2b7d4e moved the single-dispatch generic function definitions to the glossary 2013-06-07 22:54:03 +02:00
R David Murray
25cd09115d #14187: Add glossary entry for 'function annotations'.
Patch by Chris Rebert.
2013-05-06 12:58:16 -04:00
Antoine Pitrou
5de183a07c Elaborate on bytes-like objects. 2013-05-04 20:18:34 +02:00
Ezio Melotti
aa54e2ff5e #16518: add "bytes-like object" to the glossary. 2013-04-30 23:33:31 +03:00
Ezio Melotti
84ad6aea73 #16128: merge with 3.2. 2013-02-01 05:20:06 +02:00
Ezio Melotti
188ad851fb #16128: clarify that instances of user-defined classes compare equal with themselves. 2013-02-01 05:18:44 +02:00
Ezio Melotti
407c2ac4f7 #16747: merge with 3.2. 2013-01-02 22:29:41 +02:00
Ezio Melotti
d581fff6f0 #16747: fix link to file objects in the glossary. 2013-01-02 22:29:09 +02:00
Chris Jerdonek
32bbc1c396 Merge from 3.2: add links and index entries for "argument" and "parameter."
This adds to the work done for issue #15990 (i.e. f44b8d69e5fc and the
commits referenced there).
2012-12-25 14:57:54 -08:00