This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5995

contrib: enforce wrapping too-long lines with () instead of \
ClosedPublic

Authored by durin42 on Feb 20 2019, 7:34 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGe2472b12c842: contrib: enforce wrapping too-long lines with () instead of \
Summary

This is the style I prefer, and an anecdotal exploration of styles
recommended in style guides etc. Further, to quote pep8:

The preferred way of wrapping long lines is by using Python's implied
line continuation inside parentheses, brackets and braces. Long lines
can be broken over multiple lines by wrapping expressions in
parentheses. These should be used in preference to using a backslash
for line continuation.

So I think this is a virtuous change.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

durin42 created this revision.Feb 20 2019, 7:34 PM
Closed by commit rHGe2472b12c842: contrib: enforce wrapping too-long lines with () instead of \ (authored by durin42). · Explain WhyFeb 21 2019, 4:28 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 14165

contrib/check-code.py

utestfilters = [ utestfilters = [
(r"<<(\S+)((.|\n)*?\n > \1)", rephere), (r"<<(\S+)((.|\n)*?\n > \1)", rephere),
(r"( +)(#([^!][^\n]*\S)?)", repcomment), (r"( +)(#([^!][^\n]*\S)?)", repcomment),
] ]
pypats = [ pypats = [
[ [
(r'\\$', 'Use () to wrap long lines in Python, not \\'),
(r'^\s*def\s*\w+\s*\(.*,\s*\(', (r'^\s*def\s*\w+\s*\(.*,\s*\(',
"tuple parameter unpacking not available in Python 3+"), "tuple parameter unpacking not available in Python 3+"),
(r'lambda\s*\(.*,.*\)', (r'lambda\s*\(.*,.*\)',
"tuple parameter unpacking not available in Python 3+"), "tuple parameter unpacking not available in Python 3+"),
(r'(?<!def)\s+(cmp)\(', "cmp is not available in Python 3+"), (r'(?<!def)\s+(cmp)\(', "cmp is not available in Python 3+"),
(r'(?<!\.)\breduce\s*\(.*', "reduce is not available in Python 3+"), (r'(?<!\.)\breduce\s*\(.*', "reduce is not available in Python 3+"),
(r'\bdict\(.*=', 'dict() is different in Py2 and 3 and is slower than {}', (r'\bdict\(.*=', 'dict() is different in Py2 and 3 and is slower than {}',
'dict-from-generator'), 'dict-from-generator'),

tests/test-contrib-check-code.t

$ cat > correct.py <<NO_CHECK_EOF $ cat > correct.py <<NO_CHECK_EOF
> def toto(arg1, arg2): > def toto(arg1, arg2):
> del arg2 > del arg2
> return (5 + 6, 9) > return (5 + 6, 9)
> NO_CHECK_EOF > NO_CHECK_EOF
$ cat > wrong.py <<NO_CHECK_EOF $ cat > wrong.py <<NO_CHECK_EOF
> def toto( arg1, arg2): > def toto( arg1, arg2):
> del(arg2) > del(arg2)
> return ( 5+6, 9) > return ( 5+6, 9)
> def badwrap():
> return 1 + \\
> 2
> NO_CHECK_EOF > NO_CHECK_EOF
$ cat > quote.py <<NO_CHECK_EOF $ cat > quote.py <<NO_CHECK_EOF
> # let's use quote in comments > # let's use quote in comments
> (''' ( 4x5 ) > (''' ( 4x5 )
> but """\\''' and finally''', > but """\\''' and finally''',
> """let's fool checkpatch""", '1+2', > """let's fool checkpatch""", '1+2',
> '"""', 42+1, """and > '"""', 42+1, """and
> ( 4-1 ) """, "( 1+1 )\" and ") > ( 4-1 ) """, "( 1+1 )\" and ")
gratuitous whitespace in () or [] gratuitous whitespace in () or []
./wrong.py:2: ./wrong.py:2:
> del(arg2) > del(arg2)
Python keyword is not a function Python keyword is not a function
./wrong.py:3: ./wrong.py:3:
> return ( 5+6, 9) > return ( 5+6, 9)
gratuitous whitespace in () or [] gratuitous whitespace in () or []
missing whitespace in expression missing whitespace in expression
./wrong.py:5:
> return 1 + \
Use () to wrap long lines in Python, not \
./quote.py:5: ./quote.py:5:
> '"""', 42+1, """and > '"""', 42+1, """and
missing whitespace in expression missing whitespace in expression
./classstyle.py:4: ./classstyle.py:4:
> class oldstyle_class: > class oldstyle_class:
old-style class, use class foo(object) old-style class, use class foo(object)
./classstyle.py:7: ./classstyle.py:7:
> class empty(): > class empty():