Mailman 3 April 2022 - docs

A suggestion for improving the documentation of chapter 10.9. Data Compression
by Guy Goldner May 22, 2024

May 22, 2024

Hello dear Python gods :) I'm new at Python and was going over the documentation . This useful paragraph : https://docs.python.org/3.7/tutorial/stdlib.html#data-compression provides info for compressing text but IMHO some important additional info is needed, without which I expect nearly all users would get stuck just as I have. Moreover, while looking for a solution I noticed a lot of articles with outdated examples which no longer work - this confused me even more to the point I started suspecting something was amiss on my end... Anyhow, adding this info would do the trick : zlib works only with bytes and in Python 3.x strings are no longer bytes. Example : *>>> zlib.compress('this is a sample string which does not work in zlib because it requires bytes and not unicode')Traceback (most recent call last): File "<stdin>", line 1, in <module>TypeError: a bytes-like object is required, not 'str'>>>* Luckily Python has a very simple solution for this : encode to utf-8, compress, decode back to unicode like so : *>>> text = 'this is a sample string which does not work in zlib because it requires bytes and not unicode with chars like this »שלום '>>> encoded = text.encode()>>> text = 'this is a sample with unicode chars »שלום '>>> encoded = text.encode()>>> compressed = zlib.compress(encoded)>>> decompressed = zlib.decompress(compressed)>>> decoded = decompressed.decode()>>> len(text),len(encoded),len(compressed) #notice that compression of short strings can be larger than the original(42, 47, 54)>>> print(text,'\n',encoded,'\n',compressed)this is a sample with unicode chars »שלום b'this is a sample with unicode chars \xc2\xbb\xd7\xa9\xd7\x9c\xd7\x95\xd7\x9d ' b'x\x9c+\xc9\xc8,V\x00\xa2D\x85\xe2\xc4\xdc\x82\x9cT\x85\xf2\xcc\x92\x0c\x85\xd2\xbc\xcc\xe4\xfc\x94T\x85\xe4\x8c\xc4\xa2b\x85C\xbb\xaf\xaf\xbc>\xe7\xfa\xd4\xebs\x15\x00\xb2K\x14|'>>> text == decodedTrue* Thank you ! You are doing a great thing ! B.R., Guy Goldner

2 2

SMTPHandler secure argument without credentials
by William Edwards Sept. 15, 2022

Sept. 15, 2022

logging.handlers.SMTPHandler only uses the 'secure' argument when credentials are specified. https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SM… says: "To specify the use of a secure protocol (TLS), pass in a tuple to the secure argument. This will only be used when authentication credentials are supplied." The docstring confirms this, but I can't find an explanation of the intent behind this behaviour. Perhaps it would be a good idea to describe this as well.

1 1

Documentation bug
by Rami Mahskouk April 26, 2022

April 26, 2022

The bug is in this row: https://docs.python.org/3/library/json.html#:~:text=0%7D%2C%20sort_keys%3DT… The result should be with quote marks: '{"a": 0, "b": 0, "c": 0}'

2 1

opening python.org/doc site is quite slow
by shane.xb.qian April 26, 2022

April 26, 2022

looks it spent quite time to download static resource // pls check detail in attachment. -- shane.xb.qian

2 1

Broken link py2app
by Dennis April 15, 2022

April 15, 2022

Dear Sir/Madam, The link to "http://undefined.org/python/#py2app" appears broken (or at least not secure), on the following page: https://docs.python.org/3/using/mac.html#distributing-python-applications-o… . Perhaps one of these would be a good alternative? https://pypi.org/project/py2app/ https://py2app.readthedocs.io/en/latest/ Best regards, Dennis

3 3

Can't download Japanese archive documents.
by bilderうん April 15, 2022

April 15, 2022

Dear developer, python documents developers, I am trying to download the Japanese version of the archive document on this website: https://docs.python.org/ja/3.10/download.html . But after clicking the download link on the page, I got the 404 page ( https://docs.python.org/ja/3.10/archives/python-3.10.4-docs.epub) like below: [image: image.png] Is there anything I can do to download this document? Best regards

2 1

traceback module's page enchancement
by Муслинов Роман Георгиевич April 14, 2022

April 14, 2022

Hi! Reading the traceback doc page at https://docs.python.org/3.9/library/traceback.html?highlight=traceback#modu… I found no direct mentions of __traceback__ attribute, which is, afaik, a preferred way of getting exception's traceback info since Python 3.0. Being a newcomer in the subject, it took me some time to find out that using __traceback__ is preferred to sys.exc_info(), which is mentioned right in the beginning of the page. That wouldn't have been necessary, had the proper info been posted on the page. So, I propose to modify at least this intro sentence: "The module uses traceback objects - this is the object type that is stored in the sys.last_traceback<https://docs.python.org/3.9/library/sys.html#sys.last_traceback> variable and returned as the third item from sys.exc_info()<https://docs.python.org/3.9/library/sys.html#sys.exc_info>." And, to make things more clear, make it sound like "The module uses traceback objects - this is the object type that is held in the __traceback__[link: https://docs.python.org/3.9/reference/simple_stmts.html?highlight=__traceba…] attribute of the exception object (Note: since Python 3.0), stored in the sys.last_traceback<https://docs.python.org/3.9/library/sys.html#sys.last_traceback> variable and returned as the third item from sys.exc_info()<https://docs.python.org/3.9/library/sys.html#sys.exc_info>." -- Regards, Roman Muslinov

1 0

Error at https://docs.python.org/3/search.html?q=f+string&check_keywords=yes&area=default
by Kevin M. Wilson April 14, 2022

April 14, 2022

MS Edge settings are displayed in the first picture, the error I encountered is the second picture...not sure how I get around this!I reloaded the browser after checking the settings for JavaScript...confused. Kevin Good sense makes one slow to anger, and it is his glory tooverlook an offense. Proverbs 19:11

1 0

Typo in docs.
by Ramiro B. da Luz April 5, 2022

April 5, 2022

https://docs.python.org/3/library/unittest.mock.html assret_called_once_with -- -- -- Ramiro Batista da Luz -- +55 (41) 99173-2231

2 2