psf / black / 2159
96%

DEFAULT BRANCH: master
Ran
Jobs 5
Files 8
Run time 39s
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
2159

push

travis-ci

web-flow 
Fix empty line handling when formatting typing stubs (#1646)

Black used to erroneously remove all empty lines between non-function
code and decorators when formatting typing stubs. Now a single empty
line is enforced.

I chose for putting empty lines around decorated classes that have empty
bodies since removing empty lines around such classes would cause a
formatting issue that seems to be impossible to fix.

For example:

```
class A: ...
@some_decorator
class B: ...
class C: ...
class D: ...

@some_other_decorator
def foo(): -> None: ...
```

It is easy to enforce no empty lines between class A, B, and C.
Just return 0, 0 for a line that is a decorator and precedes an stub
class. Fortunately before this commit, empty lines after that class
would be removed already.

Now let's look at the empty line between class D and function foo. In
this case, there should be an empty line there since it's class code next
to function code. The problem is that when deciding to add X empty lines
before a decorator, you can't tell whether it's before a class or a
function. If the decorator is before a function, then an empty line
is needed, while no empty lines are needed when the decorator is
before a class.

So even though I personally prefer no empty lines around decorated
classes, I had to go the other way surrounding decorated classes with
empty lines.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>

4794 of 5020 relevant lines covered (95.5%)

3.81 hits per line

Jobs
ID Job ID Ran Files Coverage
1 2159.1 (TEST_CMD="pre-commit run --all-files --show-diff-on-failure") 0
0.0
 Travis Job 2159.1
2 2159.2 (TEST_CMD="coverage run -m unittest") 0
95.24
 Travis Job 2159.2
3 2159.3 (TEST_CMD="coverage run -m unittest") 0
95.24
 Travis Job 2159.3
4 2159.4 (TEST_CMD="coverage run -m unittest") 0
95.33
 Travis Job 2159.4
5 2159.5 (TEST_CMD="coverage run -m unittest") 0
95.29
 Travis Job 2159.5
Source Files on build 2159
Detailed source file information is not available for this build.