2to3 -d adds extra whitespace #56980

Activity

1. VPeric commented on Aug 17, 2011

   

   VPericmannequin

   on Aug 17, 2011

   MannequinAuthor

   More actions

   When running 2to3 -d on this doctest (from this file[0] in SymPy):

           >>> class SzUpKet(Ket):
           ...     def _represent_SzOp(self, basis, **options):
           ...         return Matrix([1,0])
           ...

   2to3 adds an extra space in the last line. This then raises an error for our automated whitespace tests (and is generally annoying). I haven't seen this happen anywhere else (and SymPy is a big codebase).

   It's really a minor issue, though (I can't set the priority myself, though).

   [0] https://github.com/sympy/sympy/blob/master/sympy/physics/quantum/represent.py
2. VPeric

   added

   topic-2to3

   on Aug 17, 2011
3. ezio-melotti

   added

   type-bugAn unexpected behavior, bug, or errorAn unexpected behavior, bug, or error

   on Nov 29, 2011
4. BreamoreBoy commented on Jun 29, 2014

   

   BreamoreBoymannequin

   on Jun 29, 2014

   Mannequin

   More actions

   Can we have a response to this please.
5. tirkarthi commented on Mar 19, 2019

   

   tirkarthi

   on Mar 19, 2019

   Member

   More actions

   PS2 = "... " is defined with a trailing space which is not stripped for empty lines with only PS2 in the doctest. A patch would be to strip the trailing space in PS2 for empty lines and a unittest would be as below. There are no test cases for this scenario asserting against exact format and hence the patch doesn't break any tests. Currently I don't see any doctest in the codebase having this leading whitespace. I can try converting this patch as PR if Benjamin is okay with the change.

   diff --git a/Lib/lib2to3/refactor.py b/Lib/lib2to3/refactor.py
   index 7841b99a5c..135678b46e 100644
   --- a/Lib/lib2to3/refactor.py
   +++ b/Lib/lib2to3/refactor.py
   @@ -599,7 +599,11 @@ class RefactoringTool(object):
                    new[-1] += "\n"
                block = [indent + self.PS1 + new.pop(0)]
                if new:
   -                block += [indent + self.PS2 + line for line in new]
   +                for line in new:
   +                    if not line.strip():
   +                        block += [indent + self.PS2.strip() + line]
   +                    else:
   +                        block += [indent + self.PS2 + line]
            return block
    
        def summarize(self):
   diff --git a/Lib/lib2to3/tests/test_refactor.py b/Lib/lib2to3/tests/test_refactor.py
   index 9e3b8fbb90..f6a5e2d589 100644
   --- a/Lib/lib2to3/tests/test_refactor.py
   +++ b/Lib/lib2to3/tests/test_refactor.py
   @@ -331,3 +331,22 @@ from __future__ import print_function"""
                    break
            else:
                self.fail("explicit fixer not loaded")
   +
   +    def test_refactor_doctest(self):
   +        rt = self.rt()
   +
   +        expected = """
   +>>> class Foo():
   +...    def cheese(self):
   +...        pass
   +...
   +"""
   +
   +        doc = """
   +>>> class Foo():
   +...    def parrot(self):
   +...        pass
   +...
   +"""
   +        out = rt.refactor_docstring(doc, "<test>")
   +        self.assertEqual(out, expected)

   Without patch this fails as below :

   $ ./python.exe -m unittest -v lib2to3.tests.test_refactor.TestRefactoringTool.test_refactor_doctest
   test_refactor_doctest (lib2to3.tests.test_refactor.TestRefactoringTool) ... FAIL

   ======================================================================
   FAIL: test_refactor_doctest (lib2to3.tests.test_refactor.TestRefactoringTool)
   ----------------------------------------------------------------------

   Traceback (most recent call last):
     File "/Users/karthikeyansingaravelan/stuff/python/cpython/Lib/lib2to3/tests/test_refactor.py", line 352, in test_refactor_doctest
       self.assertEqual(out, expected)
   AssertionError: '\n>>> class Foo():\n...    def cheese(self):\n...        pass\n... \n' != '\n>>> class Foo():\n...    def cheese(self):\n...        pass\n...\n'

     >>> class Foo():
     ...    def cheese(self):
     ...        pass
   - ...
   ?    -
   + ...

   ---

   Ran 1 test in 0.032s

   FAILED (failures=1)
6. tirkarthi

   added

   3.7 (EOL)end of lifeend of life

   3.8 (EOL)end of lifeend of life

   on Mar 19, 2019
7. iritkatriel

   closed this as completedon Oct 20, 2021
8. ezio-melotti

   transferred this issue fromon Apr 10, 2022