Mathieu Dupuy
c49016e67c
fix comma location in various places (GH-19233)
2020-03-30 14:28:25 -07:00
Lahfa Samy
59c644eaa7
bpo-39879: Update datamodel docs to include dict ordering (GH-19006)
...
Co-authored-by: furkanonder <furkantahaonder@gmail.com>
2020-03-26 09:54:04 -05:00
Caleb Donovick
e59334ebc9
bpo-17422: slightly more precise language (GH-18682)
2020-03-06 10:20:48 -08:00
MojoVampire
469325c30e
bpo-35712: Make using NotImplemented in a boolean context issue a deprecation warning (GH-13195)
2020-03-03 20:50:17 +02:00
ananthan-123
fbe2e0bb8a
bpo-17422: Language reference should specify restrictions on class namespace ( #18559 )
...
The language reference now specifies restrictions on class namespaces. Adapted from a patch by Ethan Furman.
2020-02-22 09:56:01 -08:00
alclarks
7de617455e
bpo-15243: Document __prepare__ as classmethod (GH-17124)
2020-01-25 21:49:58 +03:00
HongWeipeng
abc0c4fa99
Fix the parameter list of object. _rpow_ (#GH-16477)
2020-01-05 17:20:29 -05:00
Batuhan Taşkaya
d587272fe3
bpo-38316: Fix co_stacksize documentation (GH-16983)
2019-12-15 23:02:47 +01:00
Tal Einat
02519f75d1
bpo-38524: clarify example a bit and improve formatting (GH-17406)
2019-11-28 07:22:09 +02:00
Florian Dahlitz
1bddf890e5
bpo-38524: document implicit and explicit calling of descriptors' __set_name__ (GH-17364)
2019-11-27 10:46:40 +02:00
alclarks
4544e78ec4
bpo-25866: Minor cleanups to "sequence" in docs (GH-17177)
2019-11-17 14:00:43 -08:00
Géry Ogam
4c155f738d
bpo-38336: Remove the __set__ method restriction on data descriptors for attribute lookup precedence (GH-16520)
2019-10-29 00:04:01 -07:00
Steve Dower
a39a4c7439
bpo-37913: Link to NotImplemented from new docs (GH-15860)
2019-09-10 15:25:12 +01:00
Jeroen Demeyer
009ef2955d
bpo-37913: document that __length_hint__ can return NotImplemented (GH-15383)
2019-09-10 15:01:13 +01:00
Raymond Hettinger
0dac68f1e5
bpo-36743: __get__ is sometimes called without the owner argument ( #12992 )
2019-08-29 01:27:42 -07:00
Joannah Nanjekye
6b16d938d6
bpo-15542: Documentation incorrectly suggests __init__ called after direct __new__ call (GH-15478)
2019-08-25 23:53:11 -07:00
Serhiy Storchaka
e9c90aa431
bpo-29535: Remove promize about hash randomization of datetime objects. (GH-15269)
2019-08-24 12:49:27 +03:00
Serhiy Storchaka
bdbad71b9d
bpo-20092. Use __index__ in constructors of int, float and complex. (GH-13108)
2019-06-02 00:05:48 +03:00
Pablo Galindo
cd74e66a8c
bpo-37122: Make co->co_argcount represent the total number of positonal arguments in the code object (GH-13726)
2019-06-01 18:08:04 +01:00
Serhiy Storchaka
70c5f2ae6e
Use more PEP 570 syntax in the documentation. (GH-13720)
2019-06-01 11:38:24 +03:00
Pablo Galindo
ed222a74a0
Update data model docs to include missing attributes for code objects (GH-13696)
...
Include and document co_posonlyargcount and co_kwonlyargcount
2019-05-31 12:13:04 +01:00
Catherine Alvarado
5e98f05e55
bpo-36166: Change to rst datamodel file. (GH-13089)
2019-05-04 17:54:35 -04:00
Andre Delfino
a8a79cacca
Improve grammar on async context managers and shorten text (GH-12379)
2019-05-03 08:08:10 -07:00
Jules Lasne (jlasne)
1fc5bf2ff2
Doc: Fixed missing punctuation in datamodel.rst (GH-12581)
2019-03-27 11:10:33 +01:00
Martijn Pieters
b727239575
closes bpo-36188: Clean up 'unbound' method left-overs. (GH-12169)
...
Methods are always bound, and `__self__` can no longer be `NULL`
(`method_new()` and `PyMethod_New()` both explicitly check for this).
Moreover, once a bound method is bound, it *stays* bound and won't be re-bound
to something else, so the section in the datamodel that talks about accessing
an methods in a different descriptor-binding context doesn't apply any more in
Python 3.
2019-03-04 21:19:34 -08:00
Raymond Hettinger
7463884f69
Document other performance implication for __slots__ (GH-11974)
2019-02-21 03:34:04 -08:00
Pierre Glaser
df8d2cde63
bpo-35911: add cell constructor (GH-11771)
...
Add a cell constructor, expose the cell type in the types module.
2019-02-07 19:36:48 +00:00
Serhiy Storchaka
2b57c43f21
bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)
2018-12-19 08:09:46 +02:00
Andre Delfino
1ce853f377
Move __missing__ after __delitem__ in Data model. (GH-10923)
2018-12-05 21:42:44 +02:00
wim glenn
a48e0eb967
Fix outdated info in datamodel about dicts (GH-9807)
2018-11-16 20:58:19 +09:00
Andrés Delfino
c2ccac7b9f
bpo-33816: Remove outdated metaclass example (GH-7566)
2018-11-16 20:41:55 +09:00
Denis Osipov
0bee3c36d4
bpo-35119: Fix RecursionError in example of customizing module attribute access. (GH-10323)
...
https://bugs.python.org/issue35119
2018-11-06 01:53:21 +00:00
Serhiy Storchaka
913876d824
bpo-35054: Add yet more index entries for symbols. (GH-10121)
2018-10-28 13:41:26 +02:00
Serhiy Storchaka
ddb961d2ab
bpo-35054: Add more index entries for symbols. (GH-10064)
2018-10-26 09:00:49 +03:00
Berker Peksag
3c1b590472
Fix HTML formatting in datamodel.rst (GH-8693)
2018-08-06 23:52:49 +03:00
Zach Mitchell
00818c8ffd
Fix typo in datamodel.rst (GH-6964)
...
This is a simple grammatical fix correcting "...object whose `__self__` attributes is ..." to "...object whose `__self__` attribute is ...".
2018-06-02 07:29:47 -07:00
Serhiy Storchaka
f5e7b1999f
bpo-23722: Raise a RuntimeError for absent __classcell__. (GH-6931)
...
A DeprecationWarning was emitted in Python 3.6-3.7.
2018-05-20 08:48:12 +03:00
Serhiy Storchaka
8ae8e6af37
bpo-23722: Fix docs for future __classcell__ changes. (GH-6999)
2018-05-20 08:13:52 +03:00
Ivan Levkivskyi
bd5f96581b
bpo-32717: Document PEP 560 (GH-6726)
2018-05-08 19:38:41 +01:00
Serhiy Storchaka
496431ffb6
bpo-26701: Improve documentation for the rounding special methods. ( #6054 )
2018-03-10 17:18:32 +02:00
Eric Appelt
308eab979d
bpo-26701: Add documentation for __trunc__ (GH-6022)
...
`int` fails back to `__trunc__` is `__int__` isn't defined, so cover
that in the docs.
2018-03-10 18:44:12 +10:00
Nick Coghlan
aec7532ed3
bpo-30579: Docs for dynamic traceback creation (GH-5653)
2018-02-13 18:10:58 +10:00
Cheryl Sabella
d1f318105b
bpo-8722: Document __getattr__ behavior with AttributeError in property (GH-4754)
...
When `__getattr__` is implemented, attribute lookup will always fall back to that,
even if the initial failure comes from `__getattribute__` or a descriptor's `__get__`
method (including property methods).
2018-02-05 12:03:22 +10:00
Cheryl Sabella
85527cf50a
bpo-27505: Add change notes in module attribute docs (GH-5320)
...
Make it clear that setting __class__ on a module has worked since 3.5,
but support for __getattr__ and __dir__ on module instances requires 3.7+
Patch by Cheryl Sabella.
2018-01-27 12:40:52 +10:00
Antoine Pitrou
4b965930e8
bpo-32377: improve __del__ docs and fix mention about resurrection ( #4927 )
...
* Fix #32377 : improve __del__ docs and fix mention about resurrection
* Mention that CPython only calls __del__ once.
2017-12-19 19:48:45 +01:00
Ivan Levkivskyi
5364b5cd75
bpo-32225: Implementation of PEP 562 ( #4731 )
...
Implement PEP 562: module __getattr__ and __dir__.
The implementation simply updates module_getattro and
module_dir.
2017-12-14 11:59:44 +01:00
Yury Selivanov
faa135acbf
bpo-31709: Drop support for asynchronous __aiter__. ( #3903 )
2017-10-06 02:08:57 -04:00
Louie Lu
b8d1b9d7c6
Mention enum as an ex ( #2982 )
2017-09-12 21:44:14 -07:00
Nick Coghlan
5a8516701f
bpo-31344: Per-frame control of trace events (GH-3417)
...
f_trace_lines: enable/disable line trace events
f_trace_opcodes: enable/disable opcode trace events
These are intended primarily for testing of the interpreter
itself, as they make it much easier to emulate signals
arriving at unfortunate times.
2017-09-08 10:14:16 +10:00
Lisa Roach
64505a1f6c
bpo-30486: Allow setting cell value ( #1840 )
...
The cell_contents attribute of the cell object is now writable.
2017-06-08 14:43:26 +03:00
Aaron Hall, MBA
2b44e302ec
bpo-30449 Terse slots ( #1819 )
...
* correct __slots__ documentation with minimal changes
* add multiple inheritance info
* remove mapping from description
2017-05-25 22:33:26 -07:00
csabella
12b1c18098
bpo-30354: Update data model documentation for super() (GH-1561)
...
The data model section of the language reference was written well
before the zero-argument form of super() was added.
To avoid giving the impression that they're doing something
unusual, this updates the description of `__new__` and `__init__`
to use the zero-argument form.
Patch by Cheryl Sabella.
2017-05-15 13:42:00 +10:00
Serhiy Storchaka
7e19dbc92e
bpo-28974: `object.__format__(x, '')` is now equivalent to `str(x)` ( #506 )
...
rather than `format(str(self), '')`.
2017-05-13 12:40:52 +03:00
Jelle Zijlstra
2e624690bd
bpo-29679: Implement @contextlib.asynccontextmanager ( #360 )
2017-04-30 18:25:58 -07:00
csabella
c6db4811f9
bpo-30052: Link `bytes` & `bytearray` to stdtypes not functions (GH-1271)
...
Builtin container types have two potential link targets in the docs:
- their entry in the list of builtin callables
- their type documentation
This change brings `bytes` and `bytearray` into line with other
container types by having cross-references default to linking to
their type documentation, rather than their builtin callable entry.
2017-04-26 15:47:01 +10:00
Serhiy Storchaka
2e576f5aec
bpo-30144: Import collections ABC from collections.abc rather than collections. ( #1263 )
2017-04-24 09:05:00 +03:00
Serhiy Storchaka
85157cd89a
bpo-15718: Document the upper bound constrain on the __len__ return value. ( #1256 )
2017-04-23 08:37:58 +03:00
Berker Peksag
406c252970
Issue #29012 : Merge from 3.5
2017-01-03 03:35:49 +03:00
Berker Peksag
7b4e551091
Issue #29012 : Remove another outdated information
...
Patch by Jim Fasarakis-Hilliard.
2017-01-03 03:34:15 +03:00
Berker Peksag
a22457ecaf
Issue #29012 : Merge from 3.5
2017-01-02 06:01:07 +03:00
Berker Peksag
14adafd6ee
Issue #29012 : Remove outdated information about __bases__
...
Patch by Jim Fasarakis-Hilliard.
2017-01-02 06:00:35 +03:00
Victor Stinner
01e4c1175f
Merge 3.5
2016-12-19 13:09:55 +01:00
Victor Stinner
509476b370
doc: Suggest to hash(tuple of attr) rather than XOR
...
Issue #28383 : __hash__ documentation recommends naive XOR to combine but this
is suboptimal. Update the doc to suggest to reuse the hash() method using a
tuple, with an example.
2016-12-19 13:09:28 +01:00
Yury Selivanov
03660041d2
Issue #28091 : Document PEP 525 & PEP 530.
...
Patch by Eric Appelt.
2016-12-15 17:36:05 -05:00
Nick Coghlan
19d246745d
Issue #23722 : improve __classcell__ compatibility
...
Handling zero-argument super() in __init_subclass__ and
__set_name__ involved moving __class__ initialisation to
type.__new__. This requires cooperation from custom
metaclasses to ensure that the new __classcell__ entry
is passed along appropriately.
The initial implementation of that change resulted in abruptly
broken zero-argument super() support in metaclasses that didn't
adhere to the new requirements (such as Django's metaclass for
Model definitions).
The updated approach adopted here instead emits a deprecation
warning for those cases, and makes them work the same way they
did in Python 3.5.
This patch also improves the related class machinery documentation
to cover these details and to include more reader-friendly
cross-references and index entries.
2016-12-05 16:47:55 +10:00
Martin Panter
28540183c9
Another en → em dash fix for 3.6
2016-11-21 04:10:45 +00:00
Serhiy Storchaka
989db5c880
Issue #19795 : Mark up None as literal text.
2016-10-19 16:37:13 +03:00
Serhiy Storchaka
ecf41da83e
Issue #19795 : Mark up None as literal text.
2016-10-19 16:29:26 +03:00
Eric Snow
68f4dd8b01
Doc updates for PEPs 520 and 468.
2016-09-09 11:22:14 -07:00
Yury Selivanov
f8cb8a16a3
Issue #27985 : Implement PEP 526 -- Syntax for Variable Annotations.
...
Patch by Ivan Levkivskyi.
2016-09-08 20:50:03 -07:00
Eric Snow
4f29e75289
Issue #24254 : Drop cls.__definition_order__.
2016-09-08 15:11:11 -07:00
Eric Snow
92a6c170e6
Issue #24254 : Preserve class attribute definition order.
2016-09-05 14:50:11 -07:00
Raymond Hettinger
f74c33ad5c
Merge
2016-08-25 21:12:16 -07:00
Raymond Hettinger
7ea386e56e
Issue 19504: Change "customise" to "customize" American spelling.
2016-08-25 21:11:50 -07:00
Guido van Rossum
97c1adf393
Anti-registration of various ABC methods.
...
- Issue #25958 : Support "anti-registration" of special methods from
various ABCs, like __hash__, __iter__ or __len__. All these (and
several more) can be set to None in an implementation class and the
behavior will be as if the method is not defined at all.
(Previously, this mechanism existed only for __hash__, to make
mutable classes unhashable.) Code contributed by Andrew Barnert and
Ivan Levkivskyi.
2016-08-18 09:22:23 -07:00
Nick Coghlan
607e1c4c44
Issue 27366: PEP 487 docs updates
...
- Porting note for type keyword arg handling
- __init_subclass__ note regarding metaclass hint
2016-07-31 12:42:49 +10:00
Berker Peksag
01d1719062
Issue #27366 : Tweak PEP 487 documentation
...
* Added versionadded directives
* Deleted duplicate sentence from __init_subclass__ docstring
* Modernized tests
2016-07-30 14:06:15 +03:00
Nick Coghlan
d78448e912
Issue #27366 : Implement PEP 487
...
- __init_subclass__ called when new subclasses defined
- __set_name__ called when descriptors are part of a
class definition
2016-07-30 16:26:03 +10:00
Martin Panter
2fec611a70
Issue #24314 : Merge doc links from 3.5
2016-06-18 08:20:22 +00:00
Martin Panter
bae5d81f5d
Issue #24314 : Fix doc links for general attributes like __name__, __dict__
2016-06-18 03:57:31 +00:00
Martin Panter
5848ac2df0
Issue #15476 : Merge index entries from 3.5
2016-06-09 23:36:40 +00:00
Yury Selivanov
711d25db48
Merge 3.5 (issue #27243 )
2016-06-09 15:13:16 -04:00
Yury Selivanov
a6f6edbda8
Issue #27243 : Fix __aiter__ protocol
2016-06-09 15:08:31 -04:00
R David Murray
3bad04ca62
Merge: #26829 : Clarify that namespace is copied to a new __dict__ in instance creation.
2016-06-02 20:06:13 -04:00
R David Murray
dd4fcf52f4
#26829 : Clarify that namespace is copied to a new __dict__ in instance creation.
...
Patch by Emily Morehouse.
2016-06-02 20:05:43 -04:00
Tommy Beadle
e9b8403a1f
[Issue 15476] Make "code object" its own entry in the index
2016-06-02 19:26:51 -04:00
Serhiy Storchaka
c499f30286
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 12:01:56 +03:00
Serhiy Storchaka
dba903993a
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
Serhiy Storchaka
7b1e5a7722
Remove redundant leading zeroes in PEP references.
2016-03-31 15:31:20 +03:00
Serhiy Storchaka
e4ba872543
Remove redundant leading zeroes in PEP references.
2016-03-31 15:30:54 +03:00
Yury Selivanov
3e48b38dff
Merge 3.5 (issue #25887 )
2016-02-13 18:00:31 -05:00
Yury Selivanov
77c96813ab
Issue #25887 : Raise a RuntimeError when a coroutine is awaited more than once.
2016-02-13 17:59:05 -05:00
Martin Panter
bc1ee460dc
Issue #25179 : Documentation for formatted string literals aka f-strings
...
Some of the inspiration and wording is taken from the text of PEP 498 by Eric
V. Smith, and the existing str.format() documentation.
2016-02-13 00:41:37 +00:00
Martin Panter
d2ad5718ad
Issue #25523 : Further a-to-an corrections new in 3.5
2015-11-02 04:20:33 +00:00
Berker Peksag
85d5d902ce
Issue #25418 : Fix markup in object.__hash__ documentation
...
Patch by TAKASE Arihiro.
2015-10-16 11:23:11 +03:00
Berker Peksag
edb9111d41
Issue #25418 : Fix markup in object.__hash__ documentation
...
Patch by TAKASE Arihiro.
2015-10-16 11:22:50 +03: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
Robert Collins
d84b29f805
Issue #4395 : Better testing and documentation of binary operators.
...
Patch by Martin Panter.
2015-08-07 10:22:54 +12:00
Robert Collins
00cf3c394a
Issue #4395 : Better testing and documentation of binary operators.
...
Patch by Martin Panter.
2015-08-07 10:32:15 +12:00