Add black lint

[kiblik1]

fixes #482
The apply black codestyle is huge I know :( but I don´t know any way to disable the job for old files and it would have to be run eventually.

[yaacov]

what does this action do ?
will it fail if the code is not formatted correctly ?

if it checks for changes after applying black then it's actually a linter ?
and if it just apply changes (e.g. reforamt) maybe we don't need it as ci ?

[yaacov]

this action will fail on bad formating, so it's actually a linter action,
can we rename it "blake" , because we already do a basic linting using flake8

[yaacov]

Please note that the --check flag is required so that the workflow fails if Black finds files that need to be formatted.
options: "--check --verbose"

If we want to fail code contributions that do not follow code standard we need to add
Ref: https://black.readthedocs.io/en/stable/integrations/github_actions.html

[yaacov]

i see that the --check is default, no need to add it ... 👍

[yaacov]

nitpick II:

we should add black to the requirements file:
https://github.com/RedHat-Israel/ROSE/blob/master/requirements-dev.txt

not sure if use this files:
https://github.com/RedHat-Israel/ROSE/blob/master/Pipfile - do we need to keep it? if we do, wee need to add black
https://github.com/RedHat-Israel/ROSE/blob/master/.travis.yml - anyone run it ? if we do, wee need to add black

[yaacov]

lgtm

[nirs]

Blint is too creative but we can improve it later.

@sleviim can you ack the changes in the course python code?

[sleviim]

WOW!
I definitely like this one!

[sleviim]

Some suggestions, please share your thoughts.
It looks really good without my suggestions as well, so I can merge it anyway if you like.

[sleviim]

lint failed:
./docs/course_materials/exercises/test_exercises/03_Variables_and_datatypes/test_homework_strings.py:62:17: W503 line break before binary operator
+ "make sure to include the previous variables",
^
16 W503 line break before binary operator
Error: Process completed with exit code 1.

[nirs]

lint failed: ./docs/course_materials/exercises/test_exercises/03_Variables_and_datatypes/test_homework_strings.py:62:17: W503 line break before binary operator + "make sure to include the previous variables", ^ 16 W503 line break before binary operator Error: Process completed with exit code 1.

This means the code needs reformatting with black. @kiblik1 can you do reformat and post a version that pass CI?

[yaacov]

@nirs W503 is very strange rule,
pep thinks it's ok to break lines before operator:
https://peps.python.org/pep-0008/#should-a-line-break-before-or-after-a-binary-operator

W503 should be disabled by default ?
maybe best is to add it to the ignore rules ?

Ref:
https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#id1

When breaking a line, Black will break it before a binary operator. This is compliant with PEP 8 as of April 2016. There’s a disabled-by-default warning in Flake8 which goes against this PEP 8 recommendation called W503 line break before binary operator. It should not be enabled in your configuration.

p.s.
@kiblik1 hi, sorry for comment #483 (comment) I see you folowed the rules in blake docs
If you change the rules and add W503, you should revert and use black recommendations, like you originally did, @nirs WDYT ?

[nirs]

@yaacov right, disable W503.

[sleviim]

Hi, not sure who should disable it.
@yaacov is it you?
(sorry if it's not)

[yaacov]

@yaacov is it you?

@sleviim I don't have permissions, it's you, @nir or @kiblik1

[sleviim]

Wondering if it's better to squash all those changes or merge them as is
@nirs @yaacov

[yaacov]

yes, I am for squashing 🦑