Mailman 3 March 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

SMTPHandler secure argument without credentials
by William Edwards 15 Sep '22

15 Sep '22

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

epubs don't work on google play
by Trenton D. Adams 31 Mar '22

31 Mar '22

I don't know why, but your EPUB of python docs at https://docs.python.org/3.8/download.html or https://docs.python.org/3/download.html cannot be processed after uploading to google play books. This is very unfortunate. :( I really like using my android phone for reading stuff.

1 0

Docs for the multiline string with an initial escape is not correct in version 3.3+
by Martin Bendsöe 23 Mar '22

23 Mar '22

This is correct: https://docs.python.org/3.2/tutorial/introduction.html Or, strings can be surrounded in a pair of matching triple-quotes: """ or '''. End of lines do not need to be escaped when using triple-quotes, but they will be included in the string. So the following uses one escape to avoid an unwanted initial blank line. print("""\ Usage: thingy [OPTIONS] -h Display this usage message -H hostname Hostname to connect to """) This is NOT correct: https://docs.python.org/3.3/tutorial/introduction.html String literals can span multiple lines. One way is using triple-quotes: """...""" or '''...'''. End of lines are automatically included in the string, but it’s possible to prevent this by adding a \ at the end of the line. The following example: print("""\ Usage: thingy [OPTIONS] -h Display this usage message -H hostname Hostname to connect to """)

2 2

Possible typo in https://docs.python.org/3/tutorial/classes.html
by Lyle Ziegelmiller 22 Mar '22

22 Mar '22

Hi https://docs.python.org/3/tutorial/classes.html A sentence reads, "Clients should use data attributes with care - clients may mess up invariants maintained by the methods by stamping on their data attributes." I think it should be, "Clients should use data attributes with care - clients may mess up invariants maintained by the methods by stomping on their data attributes.". Regards, Lyle Ziegelmiller 1-650-288-7679 ________________________________ NOTICE: This e-mail message, together with any attachments, contains information of Clearwater Analytics and/or its affiliates that may be confidential, proprietary copyrighted and/or legally privileged, and is intended solely for the use of the individual or entity named on this message. If you are not the intended recipient, and have received this message in error, please immediately delete it. The information we provide is from sources Clearwater Analytics considers reliable, but Clearwater Analytics provides no warranties regarding the accuracy of the information. Further, nothing in the email should be construed as legal, financial, or tax advice, and any questions regarding the intended recipient's individual circumstances should be addressed to that recipient's lawyer and/or accountant. Clearwater Analytics, 777 W. Main St, Boise, ID 83702 If you prefer not to receive emails from Clearwater Analytics you may unsubscribe<https://clearwater-analytics.com/unsubscribe>.

2 1

Error Message(Invalid Syntax) Bug
by Irtiza 17 Mar '22

17 Mar '22

This will be a super small Bug Report So here it is. 123.123.123 It gives me 123.123.123 ^^^^^^^^^^^ SyntaxError: invalid syntax. Perhaps you forgot a comma? Shouldn't It be like: SyntaxError: invalid syntax. Number cannot contain 3 decimals?

2 2

I found an issue in this program
by Prakhar Varma 15 Mar '22

15 Mar '22

info = input("Enter your input:") if info == "hi" or "hello": print("hello") elif info == "namaste": print("namaste") else: print("Error") In this program I am trying get a input from user and seeing that if it is equal to h i, hello or namaste. But when I am executeing it , it is printing hello when I write namaste. I can’t find any thing wrong in this program neither pycharm is telling me that there is a bug or something. Can you please help me with this program. Looking foreword to your response, Prakhar Varma Sent from Mail<https://go.microsoft.com/fwlink/?LinkId=550986> for Windows

1 0

Typing information in collections.abc documentation
by Harry Lees 09 Mar '22

09 Mar '22

Hi, more recently when I've been using Python, I've been trying to annotate my code with type hints. Unfortunately, I'm not always 100% sure about how to properly annotate code using the typing module so I find myself frequently going back to look up the syntax. I'm aware that since PEP 585, many of the generic functions that used to reside in typing should now be replaced with the collections.abc alternatives. Unfortunately, most of the information that I find helpful about these type hints are still in the typing module, I often find myself looking up the annotation I want in collections.abc, realising its not there and then going back to the typing docs. I was wondering if it would be appropriate to have some of that information transferred across to the collections.abc module, or at least some reference to the typing documentation where applicable. For example collections.abc.Generator, if I wanted to add a type hint for this, the typing documentation gives a great overview: "A generator can be annotated by the generic type Generator[YieldType, SendType, ReturnType]". From what I can tell, this information is nowhere to be found in the collections.abc docs, there isn't even a mention that it could be annotated in that way apart from the "New in version 3.9" section near the top of the page. Thanks, Harry.

1 0

bug report
by JKing Wala gamer 08 Mar '22

08 Mar '22

dear python, I installed python 2.7 on my windows 7. the python 27 folder doesn't contain scripts folder so pip isn't working please help me thank you [image: python.PNG]

2 1

Improvements to the sys.path initialization documentation
by Russel Webber 07 Mar '22

07 Mar '22

Hi All, Steve Dower, Eryk Sun and I have been working on improving the documentation around how sys.path is initialised and therefore how Python modules are found. We're moving the details from https://docs.python.org/3.11/using/windows.html#finding-modules to a platform-agnostic new section in https://docs.python.org/3.11/using/cmdline.html We're aiming to have one place in the documentation where all the ways to customize sys.path (PYTHONPATH, ._pth, site, etc) are at least mentioned. We'd appreciate further community feedback on the changes before they are merged. https://bugs.python.org/issue31582 https://github.com/python/cpython/pull/31082 Thank you, Russel

4 6