Issue 4744: asynchat documentation needs to be more precise (original) (raw)

Created on 2008-12-25 01:22 by beazley, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue4744_2.patch nitika,2014-03-16 16:57
issue4744_3.patch nitika,2014-03-19 18:58
Messages (21)
msg78277 - (view) Author: David M. Beazley (beazley) Date: 2008-12-25 01:22
The documentation for asynchat needs to be more precise in its use of strings vs. bytes. Unless the undocumented use_encoding attribute is set, it seems that all data should be bytes throughout (e.g., the terminator, inputs to push methods, etc.). I have no idea if the use_encoding attribute is officially blessed or not. However, to avoid "magic behavior", I'm guessing that it would be better practice to be explicit in one's use of bytes vs. text rather than having take place in the internals of asynchat. Advice welcome.
msg112137 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2010-07-31 11:35
Is there anyone with knowledge of asynchat who could provide a patch for this?
msg213709 - (view) Author: Nitika Agarwal (nitika) * Date: 2014-03-16 04:41
Hi, I would like to propose a patch for this issue.
msg213738 - (view) Author: Nitika Agarwal (nitika) * Date: 2014-03-16 16:57
Hi, Please review my patch attached.Any comments and feedback are welcome.
msg214125 - (view) Author: Nitika Agarwal (nitika) * Date: 2014-03-19 18:58
Attached patch with some corrections
msg215609 - (view) Author: Nitika Agarwal (nitika) * Date: 2014-04-05 13:51
Hi, I hvae attached the patch for review.I am waiting for reviewal.Please review the attached patch as soon as possible.
msg216157 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2014-04-14 18:29
Could you review your patch, there is a mistake in the name of the project, it's asynchat and not asychat. The content seems to be right, not the reference and the title. Thank you so much for your help.
msg216566 - (view) Author: Nitika Agarwal (nitika) * Date: 2014-04-16 19:47
@Stéphane Wirtel (matrixise) I am really sorry but i just couldn't find where have i done a typo and have written 'asychat' insstead of asynchat.Will you please help me out in pointing out my error.
msg216586 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2014-04-16 20:48
In your issue4744_2.patch, the anchor contains 'asychat' and not 'asynchat'.
msg216667 - (view) Author: Nitika Agarwal (nitika) * Date: 2014-04-17 07:13
But then I have submitted another patch issue4744_3 with the corrections.Please review my patch issue4744_3.patch
msg216881 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2014-04-19 21:26
The change covered by the patch (which patch rejected as garbage, by the way, I have no idea why) has already been applied by Serhiy Storchaka, apparently as a blanket change of 'empty string' to 'empty bytes object'. There are several other places in the asynchat doc page that mention string. I suspect that none of them is correct, but I haven't read through the page to be sure.
msg255091 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2015-11-22 10:33
Ping, what's the status of this issue ? maybe we can close it and open an new one with a new description.
msg255112 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2015-11-22 21:53
I think it would be okay to keep this issue open to address the other mentions of “strings”. Nitika’s patch is missing the special --- and @@ indicator lines at the top, which is probably why it was rejected. Usually you make a patch by using a “diff” command (standalone, with Mercurial, etc).
msg255161 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2015-11-23 14:07
Hi Martin, About the patch of Nikita, I am going to rewrite it asap. Will you have time to check it ? Thanks -- Stéphane Wirtel - http://wirtel.be - @matrixise
msg255180 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2015-11-23 15:51
Does it make sense to spend time updating the asychat docs when https://docs.python.org/3/library/asynchat.html states "Note. This module exists for backwards compatibility only. For new code we recommend using asyncio."?
msg255187 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2015-11-23 16:34
Yes. The docs should be accurate, even if the module is deprecated.
msg255188 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2015-11-23 16:38
Ok, in this case, I will provide the patch On 11/23, R. David Murray wrote: > > R. David Murray added the comment: > > Yes. The docs should be accurate, even if the module is deprecated. > > ---------- > > _______________________________________ > Python tracker <report@bugs.python.org> > <http://bugs.python.org/issue4744> > _______________________________________ > _______________________________________________ > Python-bugs-list mailing list > Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/stephane%40wirtel.be >
msg255191 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2015-11-23 16:52
Martin, About the patch of Nikita, this one has already been applied. I have checked the source. David, maybe we should close this issue. And open a new one if we find an other issue in the documentation. What do you suggest? Should I continue on this issue?
msg255199 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2015-11-23 17:18
If you've read through the asynchat docs and don't think any of the other mentions of string are incorrect or ambiguous, then we should close it.
msg255204 - (view) Author: Stéphane Wirtel (matrixise) * (Python committer) Date: 2015-11-23 17:45
For my part, you can close this issue. I have read the asynchat.rst and asynchat.py files and think the rest of the documentation is clear.
msg255221 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2015-11-23 20:38
OK, let's close it then. If someone finds something wrong they can open a new issue.
History
Date User Action Args
2022-04-11 14:56:43 admin set github: 48994
2015-11-23 20:38:37 r.david.murray set status: open -> closedresolution: fixedmessages: + stage: needs patch -> resolved
2015-11-23 17:45:06 matrixise set messages: +
2015-11-23 17🔞25 r.david.murray set messages: +
2015-11-23 16:52:01 matrixise set messages: +
2015-11-23 16:38:16 matrixise set messages: +
2015-11-23 16:34:56 r.david.murray set messages: +
2015-11-23 15:51:42 BreamoreBoy set nosy: + BreamoreBoymessages: +
2015-11-23 14:07:19 matrixise set messages: +
2015-11-22 21:53:22 martin.panter set nosy: + martin.pantermessages: +
2015-11-22 10:33:17 matrixise set messages: +
2014-04-19 21:26:49 r.david.murray set messages: -
2014-04-19 21:26:39 r.david.murray set messages: +
2014-04-19 21:25:35 r.david.murray set nosy: + r.david.murraymessages: +
2014-04-17 07:13:34 nitika set messages: +
2014-04-16 20:48:41 matrixise set messages: +
2014-04-16 19:47:16 nitika set messages: +
2014-04-14 18:29:01 matrixise set nosy: + matrixisemessages: + versions: + Python 3.5, - Python 2.7, Python 3.3, Python 3.4
2014-04-05 13:51:22 nitika set messages: +
2014-03-19 18:58:53 nitika set files: + issue4744_3.patchmessages: +
2014-03-16 16:57:21 nitika set files: + issue4744_2.patchkeywords: + patchmessages: +
2014-03-16 04:41:28 nitika set nosy: + nitikamessages: +
2014-03-12 20:04:36 eric.araujo set versions: + Python 3.3, Python 3.4, - Python 3.1, Python 3.2
2014-02-03 19:52:14 BreamoreBoy set nosy: - BreamoreBoy
2010-07-31 11:35:49 BreamoreBoy set versions: + Python 3.1, Python 2.7, Python 3.2, - Python 3.0nosy: + BreamoreBoy, docs@pythonmessages: + assignee: georg.brandl -> docs@pythonstage: needs patch
2008-12-27 02:41:46 giampaolo.rodola set nosy: + giampaolo.rodola, josiah.carlson
2008-12-25 01:22:50 beazley create