SSLSocket.sendall() does not return None on success like socket.sendall()

[progval]

BPO	25951
Nosy	@pitrou, @giampaolo, @tiran, @alex, @vadmium, @dstufft, @palaviv
Files	25951.patch 25951-2.patch

^{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 2016-04-03.03:58:59.950>
created_at = <Date 2015-12-25.14:45:15.904>
labels = ['type-bug', 'library']
title = 'SSLSocket.sendall() does not return None on success like socket.sendall()'
updated_at = <Date 2016-04-03.03:58:59.949>
user = 'https://bugs.python.org/progval'

bugs.python.org fields:

activity = <Date 2016-04-03.03:58:59.949>
actor = 'martin.panter'
assignee = 'none'
closed = True
closed_date = <Date 2016-04-03.03:58:59.950>
closer = 'martin.panter'
components = ['Library (Lib)']
creation = <Date 2015-12-25.14:45:15.904>
creator = 'progval'
dependencies = []
files = ['42278', '42285']
hgrepos = []
issue_num = 25951
keywords = ['patch']
message_count = 7.0
messages = ['256992', '262370', '262388', '262409', '262479', '262810', '262812']
nosy_count = 10.0
nosy_names = ['janssen', 'pitrou', 'giampaolo.rodola', 'christian.heimes', 'alex', 'progval', 'python-dev', 'martin.panter', 'dstufft', 'palaviv']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue25951'
versions = ['Python 3.6']

[progval]

socket.sendall() returns None if it succeeded <https://docs.python.org/3/library/socket.html#socket.socket.sendall\>
SSLSocket.sendall() is said to have the same behavior as socket.sendall(), besides not allowing flags <https://docs.python.org/3/library/ssl.html#ssl.SSLSocket\>

However, SSLSocket.sendall() returns the amount of bytes written on success.

[palaviv]

Changed SSLSocket.sendall() to return None. Also added a check of the return value of the SSLSocket.send(), SSLSocket.sendall() in the tests.

[vadmium]

Agreed that the documentation and implementation should match. But this seems like a rather low-priority bug. What use case relies on the return value being None?

If there is no immediate need for this change, it might be safer to just make it in 3.6, to minimize compatibility problems. But if it is fixed in 3.5 it should also be fixed in 2.7.

I left some suggestions to simplify the code.

[palaviv]

Thanks for the review.
I don't have any use cases for this change. I just saw this issue while looking for something else and thought I will give it a try.

[vadmium]

Thanks for your work Aviv. This version looks good to me.

[python-dev]

New changeset 92947704321c by Martin Panter in branch 'default':
Issue bpo-25951: Fix SSLSocket.sendall() to return None, by Aviv Palivoda
https://hg.python.org/cpython/rev/92947704321c

[vadmium]

I made some simple tweaks to avoid long lines.