Document that IOBase.__del__ calls self.close

[nikratio]

BPO	21764
Nosy	@birkenfeld, @pitrou, @benjaminp, @ezio-melotti, @merwok, @hynek
Files	iobase2.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2014-06-15.01:52:21.256>
created_at = <Date 2014-06-14.22:47:56.171>
labels = ['type-feature', 'docs']
title = 'Document that IOBase.__del__ calls self.close'
updated_at = <Date 2014-06-15.01:52:21.254>
user = 'https://bugs.python.org/nikratio'

bugs.python.org fields:

activity = <Date 2014-06-15.01:52:21.254>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2014-06-15.01:52:21.256>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2014-06-14.22:47:56.171>
creator = 'nikratio'
dependencies = []
files = ['35638']
hgrepos = []
issue_num = 21764
keywords = ['patch']
message_count = 2.0
messages = ['220591', '220605']
nosy_count = 10.0
nosy_names = ['georg.brandl', 'pitrou', 'benjamin.peterson', 'stutzbach', 'ezio.melotti', 'eric.araujo', 'nikratio', 'docs@python', 'python-dev', 'hynek']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue21764'
versions = ['Python 3.4', 'Python 3.5']

[nikratio]

CPython's io.IOBase.__del__ calls self.close(), but this isn't documented anywhere (and may be surprised for derived classes).

The attached patch extends the documentation.

[python-dev]

New changeset 601a08fcb507 by Benjamin Peterson in branch '3.4':
document IOBase.__del__'s behavior (closes bpo-21764)
http://hg.python.org/cpython/rev/601a08fcb507

New changeset 4dca82f8d91d by Benjamin Peterson in branch '2.7':
document IOBase.__del__'s behavior (closes bpo-21764)
http://hg.python.org/cpython/rev/4dca82f8d91d

New changeset 787cd41d0404 by Benjamin Peterson in branch 'default':
merge 3.4 (bpo-21764)
http://hg.python.org/cpython/rev/787cd41d0404