timeout sentinel in ftplib and poplib documentation

[orsenthil]

BPO	12706
Nosy	@orsenthil, @berkerpeksag, @mwidjaja
PRs	python/cpython#5309
Files	patch.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: ```python assignee = None closed_at = None created_at = labels = ['easy', 'type-bug', '3.9', '3.10', '3.11', 'docs'] title = 'timeout sentinel in ftplib and poplib documentation' updated_at = user = 'https://github.com/orsenthil' ``` bugs.python.org fields: ```python activity = actor = 'iritkatriel' assignee = 'docs@python' closed = False closed_date = None closer = None components = ['Documentation'] creation = creator = 'orsenthil' dependencies = [] files = ['35524'] hgrepos = [] issue_num = 12706 keywords = ['patch', 'easy'] message_count = 5.0 messages = ['141740', '219975', '278116', '309186', '309482'] nosy_count = 5.0 nosy_names = ['orsenthil', 'docs@python', 'berker.peksag', '\xce\xb5\xcf\x83\xcf\x87\xce\xb1\xcf\x84\xce\xbf\xce\xba\xcf\x85\xcf\x81\xce\xb9\xce\xbf\xcf\x82', 'mawidjaj'] pr_nums = ['5309'] priority = 'normal' resolution = None stage = 'patch review' status = 'open' superseder = None type = 'behavior' url = 'https://bugs.python.org/issue12706' versions = ['Python 3.9', 'Python 3.10', 'Python 3.11'] ```

[orsenthil]

• ftplib and poplib, has them as timeout=None, while they default
  to socket._GLOBAL_DEFAULT_TIMEOUT object.

This is wrong; someone may pass None thinking it will trigger the
default behaviour, and have nasty surprises.

[ghost]

In the definition of FTP.connect(), I've changed the code to actually use None as a lack-of-explicit-timeout sentinel instead of -999. For FTP and FTP_TLS, I've changed the documentation to reflect what the code is doing.

[berkerpeksag]

Documentation changes look good to me. However, I'd prefer using socket._GLOBAL_DEFAULT_TIMEOUT in the timeout parameter of FTP.connect().

[01b59998-d5e4-4468-854c-89f56688811a]

Greg, I wonder if you are planning to submit a PR for your patch? If not, I'm plan to take your patch, make some minor adjustment and submit a PR.

[ghost]

Completely forgot about this, please take my patch and submit a pr

On Fri, Dec 29, 2017 at 10:55 AM, Marcel Widjaja \report@bugs.python.org\ wrote:

Marcel Widjaja \mwidj@yahoo.com\ added the comment:

Greg, I wonder if you are planning to submit a PR for your patch? If not, I'm plan to take your patch, make some minor adjustment and submit a PR.

---------- nosy: +mawidjaj

---

Python tracker \report@bugs.python.org\ \https://bugs.python.org/issue12706\

---