Mailman 3 July 2016 - docs

[issue27528] Document that filterwarnings(message=...) matches the start of a message
by Martin Panter 19 Jul '16

19 Jul '16

New submission from Martin Panter: I assumed that the “message” parameter could be used to match any substring of a warning message, but it turns out it calls regex.match(), which is anchored at the beginning of the search string (but is not anchored at the end). I propose this patch to clarify the documentation, and add some tests. ---------- assignee: docs@python components: Documentation files: match-start.patch keywords: patch messages: 270546 nosy: docs@python, martin.panter priority: normal severity: normal stage: patch review status: open title: Document that filterwarnings(message=...) matches the start of a message versions: Python 2.7, Python 3.5, Python 3.6 Added file: http://bugs.python.org/file43744/match-start.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27528> _______________________________________

2 2

[issue27563] docs for `gc.get_referrers` should explain the result format (i.e. what keys in the dict mean)
by Ram Rachum 18 Jul '16

18 Jul '16

New submission from Ram Rachum: My mistake ---------- resolution: -> not a bug status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27563> _______________________________________

1 0

[issue27563] docs for `gc.get_referrers` should explain the result format (i.e. what keys in the dict mean)
by Ram Rachum 18 Jul '16

18 Jul '16

Changes by Ram Rachum <ram(a)rachum.com>: ---------- assignee: docs@python components: Documentation nosy: cool-RR, docs@python priority: normal severity: normal status: open title: docs for `gc.get_referrers` should explain the result format (i.e. what keys in the dict mean) versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27563> _______________________________________

1 0

Re: [docs] Document that filterwarnings(message=...) matches the start of a message (issue 27528)
by vadmium+py＠gmail.com 18 Jul '16

18 Jul '16

Reviewers: berkerpeksag, https://bugs.python.org/review/27528/diff/17886/Doc/library/warnings.rst File Doc/library/warnings.rst (right): https://bugs.python.org/review/27528/diff/17886/Doc/library/warnings.rst#ne… Doc/library/warnings.rst:145: the warning message must match. (The expression is compiled to always be On 2016/07/16 19:52:04, berkerpeksag wrote: > Can we drop parentheses? Sure, will do this in next patch version https://bugs.python.org/review/27528/diff/17886/Lib/test/test_warnings/__in… File Lib/test/test_warnings/__init__.py (right): https://bugs.python.org/review/27528/diff/17886/Lib/test/test_warnings/__in… Lib/test/test_warnings/__init__.py:274: self.assertListEqual(w, []) On 2016/07/16 19:52:04, berkerpeksag wrote: > assertEqual calls assertListEqual implicitly so I guess this can be replaced > with an assertEqual. Yeah plain assertEqual() should be fine Please review this at https://bugs.python.org/review/27528/ Affected files: Doc/library/warnings.rst Lib/test/test_warnings/__init__.py # HG changeset patch # Parent 0d8f139a6e19f72e3575ee37d410dfe12184be56 Document and test that the beginning of the warning message is matched diff -r 0d8f139a6e19 Doc/library/warnings.rst --- a/Doc/library/warnings.rst Sat Jul 16 07:17:46 2016 +0000 +++ b/Doc/library/warnings.rst Sat Jul 16 07:41:31 2016 +0000 @@ -141,14 +141,15 @@ | | warnings, regardless of location | +---------------+----------------------------------------------+ -* *message* is a string containing a regular expression that the warning message - must match (the match is compiled to always be case-insensitive). +* *message* is a string containing a regular expression that the start of + the warning message must match. (The expression is compiled to always be + case-insensitive.) * *category* is a class (a subclass of :exc:`Warning`) of which the warning category must be a subclass in order to match. * *module* is a string containing a regular expression that the module name must - match (the match is compiled to be case-sensitive). + match. (The expression is compiled to be case-sensitive.) * *lineno* is an integer that the line number where the warning occurred must match, or ``0`` to match all line numbers. diff -r 0d8f139a6e19 Lib/test/test_warnings/__init__.py --- a/Lib/test/test_warnings/__init__.py Sat Jul 16 07:17:46 2016 +0000 +++ b/Lib/test/test_warnings/__init__.py Sat Jul 16 07:41:31 2016 +0000 @@ -263,6 +263,18 @@ self.assertEqual(str(w[-1].message), text) self.assertTrue(w[-1].category is UserWarning) + def test_message_matching(self): + with original_warnings.catch_warnings(record=True, + module=self.module) as w: + self.module.simplefilter("ignore", UserWarning) + self.module.filterwarnings("error", "match", UserWarning) + self.assertRaises(UserWarning, self.module.warn, "match") + self.assertRaises(UserWarning, self.module.warn, "match prefix") + self.module.warn("suffix match") + self.assertListEqual(w, []) + self.module.warn("something completely different") + self.assertListEqual(w, []) + def test_mutate_filter_list(self): class X: def match(self, a):

1 0

[issue27531] Documentation for assert_not_called() has wrong signature
by Michael Killough 17 Jul '16

17 Jul '16

New submission from Michael Killough: The documentation for `Mock.assert_not_called` gives its signature as `assert_not_called(*args, **kwargs)`. Since 01ae1ac2daf4, its signature has just been `assert_not_called()`. I've attached a trivial patch that updates the documentation to match the new signature. ---------- assignee: docs@python components: Documentation files: docs-assert_not_called.patch keywords: patch messages: 270577 nosy: docs@python, mjkillough priority: normal severity: normal status: open title: Documentation for assert_not_called() has wrong signature versions: Python 3.5, Python 3.6 Added file: http://bugs.python.org/file43754/docs-assert_not_called.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27531> _______________________________________

3 2

Document that filterwarnings(message=...) matches the start of a message (issue 27528)
by berker.peksag＠gmail.com 17 Jul '16

17 Jul '16

http://bugs.python.org/review/27528/diff/17886/Doc/library/warnings.rst File Doc/library/warnings.rst (right): http://bugs.python.org/review/27528/diff/17886/Doc/library/warnings.rst#new… Doc/library/warnings.rst:145: the warning message must match. (The expression is compiled to always be Can we drop parentheses? http://bugs.python.org/review/27528/diff/17886/Lib/test/test_warnings/__ini… File Lib/test/test_warnings/__init__.py (right): http://bugs.python.org/review/27528/diff/17886/Lib/test/test_warnings/__ini… Lib/test/test_warnings/__init__.py:274: self.assertListEqual(w, []) assertEqual calls assertListEqual implicitly so I guess this can be replaced with an assertEqual. http://bugs.python.org/review/27528/

1 0

[issue27285] Deprecate pyvenv in favor of python3 -m venv
by Steve Piercy 16 Jul '16

16 Jul '16

New submission from Steve Piercy: Per https://bugs.python.org/issue25154 `pyvenv` is deprecated in favor of `python3 -m venv`. The docs for Python 3.5+ need to be updated accordingly. ---------- assignee: docs@python components: Documentation messages: 268104 nosy: docs@python, stevepiercy priority: normal severity: normal status: open title: Deprecate pyvenv in favor of python3 -m venv type: enhancement versions: Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27285> _______________________________________

7 23

[issue10225] Fix doctest runable examples in python manual
by Alexander Belopolsky 16 Jul '16

16 Jul '16

Changes by Alexander Belopolsky <alexander.belopolsky(a)gmail.com>: ---------- assignee: belopolsky -> _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10225> _______________________________________

1 0

[issue26696] Document collections.abc.ByteString
by Brett Cannon 16 Jul '16

16 Jul '16

Brett Cannon added the comment: Thanks for the patch, Xiang! ---------- resolution: -> fixed stage: needs patch -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26696> _______________________________________

1 0

[issue26696] Document collections.abc.ByteString
by Roundup Robot 16 Jul '16

16 Jul '16

Roundup Robot added the comment: New changeset 8be87fde577f by Brett Cannon in branch '3.5': Issue #26696: Document collections.abc.ByteString. https://hg.python.org/cpython/rev/8be87fde577f New changeset 6ba86ca875a8 by Brett Cannon in branch 'default': Merge for #26696 https://hg.python.org/cpython/rev/6ba86ca875a8 ---------- nosy: +python-dev _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26696> _______________________________________

1 0