Mailman 3 March 2022 - Docs-bugs

[issue28516] contextlib.ExitStack.__enter__ has trivial but undocumented behavior
by miss-islington March 28, 2022

March 28, 2022

Change by miss-islington <mariatta.wijaya+miss-islington(a)gmail.com>: ---------- nosy: +miss-islington nosy_count: 7.0 -> 8.0 pull_requests: +30224 pull_request: https://github.com/python/cpython/pull/32144 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue28516> _______________________________________

1 0

[issue47134] Document the meaning of the number in OverflowError
by Steven D'Aprano March 26, 2022

March 26, 2022

New submission from Steven D'Aprano <steve+python(a)pearwood.info>: OverflowError sometimes (but not always) includes some sort of numeric code: >>> 1e+300 ** 2 Traceback (most recent call last): File "<stdin>", line 1, in <module> OverflowError: (34, 'Numerical result out of range') but the meaning of the 34 is not documented: https://docs.python.org/3/library/exceptions.html#OverflowError help(OverflowError) is no more insightful, saying only: __init__(self, /, *args, **kwargs) Initialize self. See help(type(self)) for accurate signature. Other OverflowError exceptions do not include the numeric code: >>> math.exp(10000) Traceback (most recent call last): File "<stdin>", line 1, in <module> OverflowError: math range error Is it an error code from C? Something to do with the number of digits of precision? An easter-egg to do with The Count Of Monte Cristo? ---------- assignee: docs@python components: Documentation messages: 416093 nosy: docs@python, steven.daprano priority: normal severity: normal status: open title: Document the meaning of the number in OverflowError type: enhancement versions: Python 3.10, Python 3.11, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47134> _______________________________________

2 1

[issue26120] pydoc: move __future__ imports out of the DATA block
by Serhiy Storchaka March 26, 2022

March 26, 2022

Serhiy Storchaka <storchaka+cpython(a)gmail.com> added the comment: I am positive about this idea, but we must also think about the possible negative consequences. For example, the future annotations will be included in the star-import by default and can override some global names. The fact that some names not visible in the module help can override global names can be confusing. I think it should be discussed with a wider auditory. ---------- nosy: +serhiy.storchaka _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue26120> _______________________________________

1 0

[issue47121] math.isfinite() can raise exception when called on a number
by Serhiy Storchaka March 26, 2022

March 26, 2022

Serhiy Storchaka <storchaka+cpython(a)gmail.com> added the comment: Most (but not all) functions in the math module implicitly convert its arguments to float. Here we can get an OverflowError. Do we want to add a note to every function that does it? Or add a general note at the top of the file and add exclusion notes to functions which do not convert arguments to float? BTW, there is a general note: "Except when explicitly noted otherwise, all return values are floats." ---------- nosy: +serhiy.storchaka _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47121> _______________________________________

1 0

[issue47105] [Doc] grp cites pwd.h instead of grp.h
by Alex Hedges March 26, 2022

March 26, 2022

New submission from Alex Hedges <aphedges1(a)gmail.com>: The documentation page for the grp module says to "see <pwd.h>", even though the source code (https://github.com/python/cpython/blob/v3.11.0a6/Modules/grpmodule.c) uses grp.h. I plan to release a PR for this shortly. ---------- assignee: docs@python components: Documentation messages: 415924 nosy: aphedges, docs@python priority: normal severity: normal status: open title: [Doc] grp cites pwd.h instead of grp.h versions: Python 3.11 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47105> _______________________________________

3 7

[issue47121] math.isfinite() can raise exception when called on a number
by Thomas Fischbacher March 25, 2022

March 25, 2022

Thomas Fischbacher <tfish(a)google.com> added the comment: The problem with PEP-484 is that if one wants to use static type analysis, neither of these options are good: - Use static annotations on functions, and additionally spec out expectations in docstrings. Do note that the two types places where "float" is mentioned here refer to different concepts. This looks as if there were duplication, but there actually isn't, since the claims are different. This is confusing as hell. def foo(x: float) -> float: """Foos the barbaz Args: x: float, the foobar Returns: float, the foofoo""" The floats in the docstring give me a guarantee: "If I feed in a float, I am guaranteed to receive back a float". The floats in the static type annotation merely say "yeah, can be float or int, and I'd call it ok in these cases" - that's a very different statement. - Just go with static annotations, drop mention of types from docstrings, and accept that we lose the ability to stringently reason about the behavior of code. With respect to this latter option, I think we can wait for "losing the ability to stringently reason about the behavior of code" to cause major security headaches. That's basically opening up the door to many problems at the level of "I can crash the webserver by requesting the url http://lpt1". ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47121> _______________________________________

1 0

[issue47122] Fix the table of methods in the collections.abc documentation
by Géry March 25, 2022

March 25, 2022

New submission from Géry <gery.ogam(a)gmail.com>: This pull request makes the following changes to the table of methods in the [`collections.abc` documentation](https://docs.python.org/3/library/collections.abc.html): - `Reversible`: add `__iter__` abstract method; - `Generator`: replace `__iter__` with inherited mixin `Iterator` methods; - `MutableSequence`: add clear mixin method; - `Set`: remove `__ne__` mixin method (not defined here but in `object`), add `__rand__` mixin method, add `__ror__` mixin method, add `__rsub__` mixin method, add `__rxor__` mixin method; - `Mapping`: remove `__ne__` mixin method (not defined here but in `object`); - `ItemsView`: add inherited mixin `MappingView` method and inherited mixin `Set` methods; - `KeysView`: add inherited mixin `MappingView` method and inherited mixin `Set` methods; - `ValuesView`: add inherited mixin `MappingView` method; - `Coroutine`: add `__await__` abstract method; - `AsyncGenerator`: replace `__aiter__` with inherited mixin `AsyncIterator` methods; - footnotes: remove footnote 2 which is a duplicate of [the description of `collections.abc.Iterable`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable). ---------- assignee: docs@python components: Documentation messages: 416013 nosy: docs@python, maggyero priority: normal pull_requests: 30195 severity: normal status: open title: Fix the table of methods in the collections.abc documentation type: enhancement versions: Python 3.10, Python 3.11, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47122> _______________________________________

2 1

[issue47121] math.isfinite() can raise exception when called on a number
by Raymond Hettinger March 25, 2022

March 25, 2022

Raymond Hettinger <raymond.hettinger(a)gmail.com> added the comment: The math.isfinite() docs could be changed to something like, "coerces x to a float if possible and then returns True if x is neither an infinity nor a NaN, and False otherwise." Or there could be a general note about which functions (most of them) coerce to float (which can fail). With respect to typing and PEP-484, I don't see a bug or documentation issue. Types relationships are useful for verifying which methods are available, but they don't make promises about the range of valid values. For example math.sqrt(float) -> float promises which types are acceptable but doesn't promise that negative inputs won't raise an exception. Likewise, "n: int=10; len(range(n))" is type correct but will raise an OverflowError for "n = 10**100". ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python, rhettinger _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47121> _______________________________________

1 0

[issue47093] Documentation Fix: Remove .bat when activating venv on windows
by J Y March 25, 2022

March 25, 2022

New submission from J Y <jovinator77(a)gmail.com>: https://docs.python.org/3/tutorial/venv.html For windows, tutorial-env\Scripts\activate.bat doesn't appear to set up venv successfully. Instead, tutorial-env\Scripts\activate (without .bat) works. This may confuse new users if this is not rectified. ---------- assignee: docs@python components: Documentation messages: 415783 nosy: docs@python, jovinator priority: normal severity: normal status: open title: Documentation Fix: Remove .bat when activating venv on windows type: enhancement versions: Python 3.11 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47093> _______________________________________

2 2

[issue35905] macOS build docs need refresh (2019)
by Battant March 24, 2022

March 24, 2022

Battant <mparchet(a)sunrise.ch> added the comment: Hello, I tried to configure my installation according your instructions Her's step I follow export CPPFLAGS="-I$(brew --prefix sqlite3)/include -I$(brew --prefix zlib)/include"export LDFLAGS="-L$(brew --prefix sqlite3)/lib -L$(brew --prefix zlib)/lib" export PKG_CONFIG_PATH="/usr/local/opt/openssl/lib/pkgconfig" python3.10 pip-run -m jaraco.develop -- -m jaraco.develop.macos-build-python /opt/homebrew/Cellar/python(a)3.10/3.10.2/bin/python3.10: can't open file ' .../cpytonpip-run': [Errno 2] No such file or directory in the cpython directory : run commands export CPPFLAGS="-I$(brew --prefix sqlite3)/include -I$(brew --prefix zlib)/include" export LDFLAGS="-L$(brew --prefix sqlite3)/lib -L$(brew --prefix zlib)/lib export PKG_CONFIG_PATH="/usr/local/opt/openssl/lib/pkgconfig" ./configure -with-pydebug --with-tcltk-includes="-I/Library/Frameworks/Tcl.framework/Headers -I/Library/Frameworks/Tk.framework/Headers" --with-tcltk-libs="/Library/Frameworks/Tcl.framework/Tcl /Library/Frameworks/Tk.framework/Tk" --enable-optimizations make clean make -j8 gcc -L/opt/homebrew/opt/zlib/lib -L/opt/homebrew/opt/zlib/lib -fno-semantic-interposition -fprofile-instr-generate -Wl,-stack_size,1000000 -framework CoreFoundation -o python.exe Programs/python.o libpython3.10d.a -ldl -framework CoreFoundation gcc -L/opt/homebrew/opt/zlib/lib -L/opt/homebrew/opt/zlib/lib -fno-semantic-interposition -fprofile-instr-generate -Wl,-stack_size,1000000 -framework CoreFoundation -o Programs/_testembed Programs/_testembed.o libpython3.10d.a -ldl -framework CoreFoundation Undefined symbols for architecture arm64: "_libintl_bindtextdomain", referenced from: Undefined symbols for architecture arm64: "_libintl_bindtextdomain", referenced from: __locale_bindtextdomain_impl in libpython3.10d.a(_localemodule.o) __locale_bindtextdomain_impl in libpython3.10d.a(_localemodule.o) "_libintl_dcgettext", referenced from: "_libintl_dcgettext", referenced from: __locale_dcgettext_impl in libpython3.10d.a(_localemodule.o) __locale_dcgettext_impl in libpython3.10d.a(_localemodule.o) "_libintl_dgettext", referenced from: "_libintl_dgettext", referenced from: __locale_dgettext_impl in libpython3.10d.a(_localemodule.o) __locale_dgettext_impl in libpython3.10d.a(_localemodule.o) "_libintl_gettext", referenced from: "_libintl_gettext", referenced from: __locale_gettext_impl in libpython3.10d.a(_localemodule.o) __locale_gettext_impl in libpython3.10d.a(_localemodule.o) "_libintl_setlocale", referenced from: "_libintl_setlocale", referenced from: __locale_setlocale_impl in libpython3.10d.a(_localemodule.o) _locale_decode_monetary in libpython3.10d.a(_localemodule.o) __locale_setlocale_impl in libpython3.10d.a(_localemodule.o) _locale_decode_monetary in libpython3.10d.a(_localemodule.o) "_libintl_textdomain", referenced from: "_libintl_textdomain", referenced from: __locale_textdomain_impl in libpython3.10d.a(_localemodule.o) __locale_textdomain_impl in libpython3.10d.a(_localemodule.o) ld: symbol(s) not found for architecture arm64 ld: symbol(s) not found for architecture arm64 clang: error: linker command failed with exit code 1 (use -v to see invocation) clang: error: linker command failed with exit code 1 (use -v to see invocation) make[3]: *** [Programs/_testembed] Error 1 make[3]: *** Waiting for unfinished jobs.... make[3]: *** [python.exe] Error 1 make[2]: *** [build_all_generate_profile] Error 2 make[1]: *** [profile-gen-stamp] Error 2 make: *** [profile-run-stamp] Error 2 could you help me please to fixe this issus Best regards Battant ---------- nosy: +Battant _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35905> _______________________________________

1 0