a4c11a75e1
* Re-indent the contents of docstrings when indentation changes
Keeping the contents of docstrings completely unchanged when
re-indenting (from 2-space intents to 4, for example) can cause
incorrect docstring indentation:
```
class MyClass:
"""Multiline
class docstring
"""
def method(self):
"""Multiline
method docstring
"""
pass
```
...becomes:
```
class MyClass:
"""Multiline
class docstring
"""
def method(self):
"""Multiline
method docstring
"""
pass
```
This uses the PEP 257 algorithm for determining docstring indentation,
and adjusts the contents of docstrings to match their new indentation
after `black` is applied.
A small normalization is necessary to `assert_equivalent` because the
trees are technically no longer precisely equivalent -- some constant
strings have changed. When comparing two ASTs, whitespace after
newlines within constant strings is thus folded into a single space.
Co-authored-by: Luka Zakrajšek <luka@bancek.net>
* Extract the inner `_v` method to decrease complexity
This reduces the cyclomatic complexity to a level that makes flake8 happy.
* Blacken blib2to3's docstring which had an over-indent
Co-authored-by: Luka Zakrajšek <luka@bancek.net>
Co-authored-by: Zsolt Dollenstein <zsol.zsol@gmail.com>
139 lines
2.0 KiB
Python
139 lines
2.0 KiB
Python
class MyClass:
|
|
"""Multiline
|
|
class docstring
|
|
"""
|
|
|
|
def method(self):
|
|
"""Multiline
|
|
method docstring
|
|
"""
|
|
pass
|
|
|
|
|
|
def foo():
|
|
"""This is a docstring with
|
|
some lines of text here
|
|
"""
|
|
return
|
|
|
|
|
|
def bar():
|
|
'''This is another docstring
|
|
with more lines of text
|
|
'''
|
|
return
|
|
|
|
|
|
def baz():
|
|
'''"This" is a string with some
|
|
embedded "quotes"'''
|
|
return
|
|
|
|
|
|
def troz():
|
|
'''Indentation with tabs
|
|
is just as OK
|
|
'''
|
|
return
|
|
|
|
|
|
def zort():
|
|
"""Another
|
|
multiline
|
|
docstring
|
|
"""
|
|
pass
|
|
|
|
def poit():
|
|
"""
|
|
Lorem ipsum dolor sit amet.
|
|
|
|
Consectetur adipiscing elit:
|
|
- sed do eiusmod tempor incididunt ut labore
|
|
- dolore magna aliqua
|
|
- enim ad minim veniam
|
|
- quis nostrud exercitation ullamco laboris nisi
|
|
- aliquip ex ea commodo consequat
|
|
"""
|
|
pass
|
|
|
|
|
|
def over_indent():
|
|
"""
|
|
This has a shallow indent
|
|
- But some lines are deeper
|
|
- And the closing quote is too deep
|
|
"""
|
|
pass
|
|
|
|
# output
|
|
|
|
class MyClass:
|
|
"""Multiline
|
|
class docstring
|
|
"""
|
|
|
|
def method(self):
|
|
"""Multiline
|
|
method docstring
|
|
"""
|
|
pass
|
|
|
|
|
|
def foo():
|
|
"""This is a docstring with
|
|
some lines of text here
|
|
"""
|
|
return
|
|
|
|
|
|
def bar():
|
|
"""This is another docstring
|
|
with more lines of text
|
|
"""
|
|
return
|
|
|
|
|
|
def baz():
|
|
'''"This" is a string with some
|
|
embedded "quotes"'''
|
|
return
|
|
|
|
|
|
def troz():
|
|
"""Indentation with tabs
|
|
is just as OK
|
|
"""
|
|
return
|
|
|
|
|
|
def zort():
|
|
"""Another
|
|
multiline
|
|
docstring
|
|
"""
|
|
pass
|
|
|
|
|
|
def poit():
|
|
"""
|
|
Lorem ipsum dolor sit amet.
|
|
|
|
Consectetur adipiscing elit:
|
|
- sed do eiusmod tempor incididunt ut labore
|
|
- dolore magna aliqua
|
|
- enim ad minim veniam
|
|
- quis nostrud exercitation ullamco laboris nisi
|
|
- aliquip ex ea commodo consequat
|
|
"""
|
|
pass
|
|
|
|
|
|
def over_indent():
|
|
"""
|
|
This has a shallow indent
|
|
- But some lines are deeper
|
|
- And the closing quote is too deep
|
|
"""
|
|
pass
|