Mailman 3 May 2016 - docs

[issue27074] Confusing text about __all__ in __init__.py in tutorial
by Antti Haapala May 21, 2016

May 21, 2016

New submission from Antti Haapala: https://docs.python.org/3/tutorial/modules.html#importing-from-a-package says that "The import statement uses the following convention: if a package’s __init__.py code defines a list named __all__, it is taken to be the list of module names that should be imported when from package import * is encountered." However, of course this is not true. The behaviour is that `__all__` lists the names that are to be imported from the package with from package import *; only only those names that raise AttributeError at the time of import would be attempted to be imported as submodules. ---------- assignee: docs@python components: Documentation messages: 265990 nosy: docs@python, ztane priority: normal severity: normal status: open title: Confusing text about __all__ in __init__.py in tutorial type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27074> _______________________________________

1 0

[issue27060] Documentation of assertItemsEqual in unittest is VERY misleading in 2.7
by Vitaly May 21, 2016

May 21, 2016

Vitaly added the comment: ... and an unnecessary incompatibility between 2.7 and 3.x ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27060> _______________________________________

1 0

[issue27060] Documentation of assertItemsEqual in unittest is VERY misleading in 2.7
by Vitaly May 21, 2016

May 21, 2016

Vitaly added the comment: Yes, this caused me to examine Counter, which I had not used before, and now I understand it, too. However, the new name by itself does not sufficiently reflect the subtlety of element-by-element counts, which does a disservice to the readability of test code. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27060> _______________________________________

1 0

[issue27060] Documentation of assertItemsEqual in unittest is VERY misleading in 2.7
by Terry J. Reedy May 20, 2016

May 20, 2016

Terry J. Reedy added the comment: It compares element by element counts, as indicated by "Equivalent to: assertEqual(Counter(list(first)), Counter(list(second))) ..." and the failure messages. Since I understand Counter equality, I ignore the rest. ---------- resolution: -> not a bug stage: test needed -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27060> _______________________________________

1 0

[issue17866] TestCase.assertItemsEqual exists in 2.7, not in 3.3
by Vitaly May 20, 2016

May 20, 2016

Vitaly added the comment: Folks, assertCountEqual sounds like a really bad name. It misleads users into thinking that it only compares the number of elements in each sequence, whereas it actually asserts that equivalent items are present in both sequences, regardless of order. The original name from 2.7 assertItemsEqual was so much better and more meaningful. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17866> _______________________________________

1 0

[issue27060] Documentation of assertItemsEqual in unittest is VERY misleading in 2.7
by Vitaly May 20, 2016

May 20, 2016

Vitaly added the comment: I think that we can close this as not a bug, as concerning 2.7. However, I think that 3.x made the wrong decision when it renamed assertItemsEqual with assertCountEqual, which now misleads users into thinking that it compares counts. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27060> _______________________________________

1 0

[issue27060] Documentation of assertItemsEqual in unittest is VERY misleading in 2.7
by Vitaly May 20, 2016

May 20, 2016

Vitaly added the comment: Thanks Terry, your assessment is correct. The maintainers appear to have drawn the wrong conclusion in #17866, which mislead me about the existing assertItemsEqual in 2.7, which appears to work correctly after all! import unittest as u class Test(u.TestCase): def test_equal_count_of_same_elements(self): self.assertItemsEqual([1,2,3], [1,2,3]) def test_equal_count_of_different_elements(self): self.assertItemsEqual([1,2,3], [1,2,4]) def test_different_count(self): self.assertItemsEqual([1,2,3], [1,2,3,4]) u.main() $ python assert_items_equal_test.py --verbose test_different_count (__main__.Test) ... FAIL test_equal_count_of_different_elements (__main__.Test) ... FAIL test_equal_count_of_same_elements (__main__.Test) ... ok ====================================================================== FAIL: test_different_count (__main__.Test) ---------------------------------------------------------------------- Traceback (most recent call last): File "assert_items_equal_test.py", line 12, in test_different_count self.assertItemsEqual([1,2,3], [1,2,3,4]) AssertionError: Element counts were not equal: First has 0, Second has 1: 4 ====================================================================== FAIL: test_equal_count_of_different_elements (__main__.Test) ---------------------------------------------------------------------- Traceback (most recent call last): File "assert_items_equal_test.py", line 8, in test_equal_count_of_different_elements self.assertItemsEqual([1,2,3], [1,2,4]) AssertionError: Element counts were not equal: First has 1, Second has 0: 3 First has 0, Second has 1: 4 ---------------------------------------------------------------------- Ran 3 tests in 0.001s FAILED (failures=2) ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27060> _______________________________________

1 0

[issue27060] Documentation of assertItemsEqual in unittest is VERY misleading in 2.7
by Vitaly May 20, 2016

May 20, 2016

Vitaly added the comment: According to comment http://bugs.python.org/issue17866#msg188052 in #17866, the maintainers renamed `assertItemsEqual` to `assertCountEqual` somewhere in the 3.x development timeframe. They apparently latched on to the implementation of `assertItemsEqual` in 2.7.x, which compares counts only, rather than its documentation. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27060> _______________________________________

1 0

[issue27060] Documentation of assertItemsEqual in unittest is VERY misleading in 2.7
by Terry J. Reedy May 20, 2016

May 20, 2016

Terry J. Reedy added the comment: Here is the specific test code so you can replace my lists with examples that you think malfunction. import unittest as u class Test(u.TestCase): def test_Count(self): self.assertItemsEqual([1,2,3], [1,2,4]) u.main() ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27060> _______________________________________

1 0

[issue27060] Documentation of assertItemsEqual in unittest is VERY misleading in 2.7
by Terry J. Reedy May 20, 2016

May 20, 2016

Terry J. Reedy added the comment: Note: 2.7 doc says that this is renamed assertCountEqual in 3.x. It was added in 2.7 and 3.2. The 3.x doc is essentially the same, but with this instead: "Equivalent to: assertEqual(Counter(list(first)), Counter(list(second))) ...". If the method misfunctions, then it should be fixed, not have the bug documented. But you need to provide specific evidence and example. The unittest in 3.x has this test with same number, different elements. self.assertRaises(self.failureException, self.assertCountEqual, [1, 2] + [3] * 100, [1] * 100 + [2, 3]) I ran following test with same number, different items. FAIL: test_Count (__main__.Test) ---------------------------------------------------------------------- Traceback (most recent call last): File "F:\Python\mypy\tem.py", line 4, in test_Count self.assertItemsEqual([1,2,3], [1,2,4]) AssertionError: Element counts were not equal: First has 1, Second has 0: 3 First has 0, Second has 1: 4 This also fails in 3.5 with name change. ---------- components: +Library (Lib) -Documentation nosy: +terry.reedy stage: -> test needed type: -> behavior _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27060> _______________________________________

1 0