Mailman 3 November 2022 - docs

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

22 May '24

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

Raw String Bug?
by garfield＠garfieldhudson.com 07 Mar '23

07 Mar '23

Hi guys, Is this a bug with raw strings? If the last character of the string is a backslash, I get an unterminated string error. If I add another character, the error goes away. I thought that the r prefix rendered everything within the quotes as literals. Thanks, Garfield.

2 4

bug in 6.3. The dir() Function
by Бородатый 03 Dec '22

03 Dec '22

1 1

tutorial download links broken
by gianni 28 Nov '22

28 Nov '22

Hello, kindly fix the download links 🙂 thanks https://docs.python.org/release/3.11.0/download.html https://docs.python.org/release/3.10.0/download.htm

2 1

Can't download documentation for Python 3.10.1
by Susanne Pedersen 14 Nov '22

14 Nov '22

Hello, I’ve been trying to download the documentation for Python 3.10.1 several times. However, none of the downloads are available, no matter what format or package type, I select. Every attempt results in a 404 error. I was particularly interested in the plain text version of the documents. Is there any way, I can get it? Best regards, Susanne Pedersen

2 1

doc for sched even sceduler
by Goldman, Jay - 0551 - MITLL 10 Nov '22

10 Nov '22

The example in the documentation is a little misleading as it tries to show 2 different aspects of the scheduler (priority vs positional/kwargs) with the same code lines: It has the following: s.enter(5, 2, print_time, argument=(‘positional’,)) s.enter(5, 1, print_time, kwargs={‘a’: ‘keyword’}) but in fact, the line with priority 2 will actually run before the line with priorty 1 as the actual time to run for each of them is different. I think the following (code inside print_some_times method) would be better: … tt = time.time() print(tt) s.enter(10, 1, print_time) s.enterabs((tt+5), 2, print_time, argument=(‘positional’,)) s.enterabs((tt+5), 1, print_time, kwargs={‘a’: ‘keyword’}) … ____________________________ Jay Goldman Subcontractor MIT Lincoln Laboratory Cyber-Physical Systems 244 Wood Street Lexington, MA 02420 Phone (Office): 781-981-0649 Email: jay.goldman(a)ll.mit.edu<mailto:jay.goldman@ll.mit.edu>

1 0

A documentation suggestion
by Peter Aronoff 08 Nov '22

08 Nov '22

Hi, First of all, thank you! Python has remarkable documentation, and I appreciate all the work that people have put into it over the years. Here’s my suggestion: I think it would be great if you released a tutorial-only version of the EPUB. The current EPUB contains 66 pages of changes to Python (going all the way back to Python 3.5) before the tutorial, and I bet that many people would love an EPUB that contained only the tutorial. As a second reason, the current EPUB is so large that searching within it is difficult. Best, Peter

1 0

UUID module documentation inconsistent
by Charles Lehman 01 Nov '22

01 Nov '22

The uuid module includes a namespace identifier for NAMESPACE_X500 which states that the name may be in DER format (a binary format), but the documentation for uuid.uuid3 and uuid.uuid5 both state that a name must be a string. Issue gh-94684 has a commit that fixes uuid3 and uuid5 to be compliant with RFC 4122 (i.e., to accept a bytes object), but it doesn't appear to have made it into the recent 3.11 release. Regardless, the documentation for NAMESPACE_X500, though apparently copied from the RFC, does not describe the current implementation.

1 0