Added black formater for the code with code-checker on pull #1610

kumuji · 2020-04-26T10:30:09Z

Before submitting

Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
Did you read the contributor guideline, Pull Request section?
Did you make sure to update the docs?
Did you write any new necessary tests?
If you made a notable change (that affects users), did you update the CHANGELOG?

What does this PR do?

Fixes # (issue).
As discussed in slack, this is a pr for adding black with github actions.

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

codecov · 2020-04-26T10:44:55Z

Codecov Report

Merging #1610 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #1610   +/-   ##
======================================
  Coverage      86%     86%           
======================================
  Files          75      75           
  Lines        4705    4705           
======================================
  Hits         4064    4064           
  Misses        641     641

black.toml

requirements.txt

.github/workflows/code-formating-check.yml

requirements.txt

black.toml

.github/workflows/code-formating-check.yml

nateraw · 2020-04-27T23:20:57Z

May I point you to the transformers library for inspiration/guidance?

Their setup.cfg configures this with isort and flake8. Additionally, their Makefile provides simple commands for devs to run before pushing up. No confusing precommit hooks in their build pipeline, just checks to see if it matches the desired format.

If your PR doesn't match, you just quickly run the make style command and push the changes back up to get the build to pass the style checks.

williamFalcon · 2020-05-17T12:56:02Z

@kumuji @Borda let's get this merged?

williamFalcon · 2020-05-17T13:07:56Z

@kumuji

Run black --config=black.toml --check .
Error: Could not open file black.toml: Error reading configuration file: [Errno 2] No such file or directory: 'black.toml'
##[error]Process completed with exit code 1.

kumuji · 2020-05-17T13:15:19Z

I can move it to setup.cfg, now I know how. I will update soon, just a few days

pyproject.toml

.github/workflows/code-formatting-check.yml

mergify · 2020-05-27T13:11:18Z

Great job! =)

mergify · 2020-05-30T03:07:54Z

This pull request is now in conflict... :(

mergify · 2020-06-02T22:48:40Z

This pull request is now in conflict... :(

Added throught black.toml other options are hard so far No caching for black github action Moved from black.toml to pyproject.toml Exclude not only yml but also yaml Update pyproject.toml Co-authored-by: Thomas Johansen <thomasjo@gmail.com> Update .github/workflows/code-formatting-check.yml mergify Remove formating check E231 error ignoring because of black formating Updated CONTRIBUTING to the master

Black skipping string normalization

setup.cfg

mergify · 2020-06-03T15:37:10Z

Great job! =)

…nto black

mergify · 2020-06-03T16:21:21Z

Great job! =)

awaelchli · 2020-06-03T17:03:09Z

so this applies black everytime we merge a PR into master? and will it only affect changed lines or always the whole file someone edits?

kumuji · 2020-06-03T17:16:39Z

So far it would do nothing.

But later, after black would be applied to the whole repo, you will have to install pre-commit, so it will format the code before you commit:

python -m pip install pre-commit
pre-commit install

Also there is github action such that on every push/pull black would check files. (It is not activated yet)

So, the github action is only checking and will check all files

Borda · 2020-06-03T17:17:41Z

so this applies black everytime we merge a PR into master? and will it only affect changed lines or always the whole file someone edits?

The check is commented so it still optional not mandatory...
Just to define common rules if someone is using black =)

awaelchli · 2020-06-03T17:19:45Z

great! will try it out

* black Added throught black.toml other options are hard so far No caching for black github action Moved from black.toml to pyproject.toml Exclude not only yml but also yaml Update pyproject.toml Co-authored-by: Thomas Johansen <thomasjo@gmail.com> Update .github/workflows/code-formatting-check.yml mergify Remove formating check E231 error ignoring because of black formating Updated CONTRIBUTING to the master * Update .github/workflows/code-formatting-check.yml * Bump black to 19.10b0 version * resolved incorrect merge of CONTRIBUTING, Black skipping string normalization * Minor fixes in CONTRIBUTING, two typos * Update setup.cfg * chlog Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com> Co-authored-by: Jirka <jirka@pytorchlightning.ai>

mergify bot requested a review from a team April 26, 2020 10:30

Borda assigned jeremyjordan Apr 26, 2020

Borda added discussion In a discussion stage feature Is an improvement or enhancement labels Apr 26, 2020

Borda added this to the 0.7.5 milestone Apr 26, 2020

justusschock requested changes Apr 26, 2020

View reviewed changes

black.toml Outdated Show resolved Hide resolved

requirements.txt Outdated Show resolved Hide resolved

mergify bot requested a review from a team April 26, 2020 11:36

Borda requested changes Apr 26, 2020

View reviewed changes

mergify bot requested a review from a team April 26, 2020 22:47

thomasjo reviewed Apr 27, 2020

View reviewed changes

.github/workflows/code-formating-check.yml Outdated Show resolved Hide resolved

kumuji marked this pull request as draft April 28, 2020 12:30

Borda modified the milestones: 0.7.6, 0.8.0, 0.7.7 May 12, 2020

williamFalcon changed the title ~~Added black formater for the code with code-checker on pull~~ [WIP] Added black formater for the code with code-checker on pull May 17, 2020

kumuji force-pushed the black branch from 16f7bbe to b4d1e4b Compare May 18, 2020 10:14

kumuji marked this pull request as ready for review May 18, 2020 10:48

kumuji changed the title ~~[WIP] Added black formater for the code with code-checker on pull~~ Added black formater for the code with code-checker on pull May 18, 2020

kumuji requested review from Borda and removed request for a team May 18, 2020 12:29

mergify bot requested a review from a team May 18, 2020 12:30

thomasjo reviewed May 18, 2020

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

Borda approved these changes May 18, 2020

View reviewed changes

.github/workflows/code-formatting-check.yml Outdated Show resolved Hide resolved

mergify bot requested a review from a team May 18, 2020 22:44

kumuji force-pushed the black branch from 028e707 to 617a1e8 Compare May 27, 2020 10:49

Borda requested changes May 27, 2020

View reviewed changes

.github/workflows/code-formatting-check.yml Show resolved Hide resolved

mergify bot requested a review from a team May 27, 2020 11:38

Borda reviewed May 27, 2020

View reviewed changes

.github/workflows/code-formatting-check.yml Outdated Show resolved Hide resolved

Borda approved these changes May 27, 2020

View reviewed changes

Borda added the ready PRs ready to be merged label May 27, 2020

kumuji force-pushed the black branch from 39df0f1 to 88ee319 Compare May 30, 2020 10:00

kumuji requested a review from Borda May 30, 2020 16:43

kumuji and others added 5 commits June 3, 2020 15:35

Update .github/workflows/code-formatting-check.yml

6876751

Bump black to 19.10b0 version

2b5f2c7

resolved incorrect merge of CONTRIBUTING,

b6e482d

Black skipping string normalization

Minor fixes in CONTRIBUTING, two typos

be934c3

Borda force-pushed the black branch from 3d6e678 to be934c3 Compare June 3, 2020 13:35

Borda reviewed Jun 3, 2020

View reviewed changes

setup.cfg Outdated Show resolved Hide resolved

Update setup.cfg

c0b95aa

Borda added 2 commits June 3, 2020 17:43

chlog

9be71b8

Merge branch 'black' of https://github.com/kumuji/pytorch-lightning i…

3a3fe22

…nto black

Borda merged commit fd7814d into Lightning-AI:master Jun 3, 2020

akihironitta mentioned this pull request Dec 25, 2020

ci: Introduce code formatter Lightning-Universe/lightning-bolts#482

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added black formater for the code with code-checker on pull #1610

Added black formater for the code with code-checker on pull #1610

kumuji commented Apr 26, 2020 •

edited

Loading

codecov bot commented Apr 26, 2020 •

edited

Loading

nateraw commented Apr 27, 2020

williamFalcon commented May 17, 2020

williamFalcon commented May 17, 2020

kumuji commented May 17, 2020

mergify bot commented May 27, 2020

mergify bot commented May 30, 2020

mergify bot commented Jun 2, 2020

mergify bot commented Jun 3, 2020

mergify bot commented Jun 3, 2020

awaelchli commented Jun 3, 2020

kumuji commented Jun 3, 2020 •

edited

Loading

Borda commented Jun 3, 2020

awaelchli commented Jun 3, 2020

Added black formater for the code with code-checker on pull #1610

Added black formater for the code with code-checker on pull #1610

Conversation

kumuji commented Apr 26, 2020 • edited Loading

Before submitting

What does this PR do?

PR review

Did you have fun?

codecov bot commented Apr 26, 2020 • edited Loading

Codecov Report

nateraw commented Apr 27, 2020

williamFalcon commented May 17, 2020

williamFalcon commented May 17, 2020

kumuji commented May 17, 2020

mergify bot commented May 27, 2020

mergify bot commented May 30, 2020

mergify bot commented Jun 2, 2020

mergify bot commented Jun 3, 2020

mergify bot commented Jun 3, 2020

awaelchli commented Jun 3, 2020

kumuji commented Jun 3, 2020 • edited Loading

Borda commented Jun 3, 2020

awaelchli commented Jun 3, 2020

kumuji commented Apr 26, 2020 •

edited

Loading

codecov bot commented Apr 26, 2020 •

edited

Loading

kumuji commented Jun 3, 2020 •

edited

Loading