Format Python script using Black formatter

[za]

What kind of changes does this PR include?

• Fixes or refactors
• A new challenge
• Additional documentation
• Something else

Description

Format Python script using Black formatter so that the style is consistent. Hopefully this will make the code more readable and attract more contributors.

Relations

Closes #1200

References

https://github.com/psf/black

Checklist:

• All the contributions made are solely the work of me and my co-authors
• I tested the changes in this PR (if applicable)
• I added unit tests to ensure my change works (when change in Java or on front-end code)
• I added UI tests to ensure my UI changes work (when change in the overall UI, not needed if just adding a challenge)
• The PR passes pre-commit hooks and automated tests

[commjoen]

Hi @za ,
Can you please take a look on how we can have the formatting done automatically using precommit? Thanks!

[za]

Hi @commjoen ok, I'll have a look.

[za]

Hi @za , Can you please take a look on how we can have the formatting done automatically using precommit? Thanks!

Hi @commjoen I've added black.yml and updated pre-commit.yml file. Can you check?

[commjoen]

Something seems to fail when using the new pre-commit hook, can you please fix the black integration :) ? Then I am very happy to continue :) .

[26/01 4:42:29] ➜  sort_contibutors git:(python-black-formatted) ✗ pre-commit install
pre-commit installed at .git/hooks/pre-commit
[26/01 4:42:34] ➜  sort_contibutors git:(python-black-formatted) ✗ git commit        
[INFO] Initializing environment for https://github.com/psf/black.
An unexpected error has occurred: CalledProcessError: command: ('/usr/local/opt/git/libexec/git-core/git', 'checkout', '22.6b0')
return code: 1
expected return code: 0
stdout: (none)
stderr:
    error: pathspec '22.6b0' did not match any file(s) known to git
    
Check the log at /Users/razr/.cache/pre-commit/pre-commit.log
[26/01 4:42:38] ➜  sort_contibutors git:(python-black-formatted) ✗ git status
On branch python-black-formatted
Your branch is up to date with 'origin/python-black-formatted'.

Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
	modified:   main.py

[za]

Something seems to fail when using the new pre-commit hook, can you please fix the black integration :) ? Then I am very happy to continue :) .

[26/01 4:42:29] ➜  sort_contibutors git:(python-black-formatted) ✗ pre-commit install
pre-commit installed at .git/hooks/pre-commit
[26/01 4:42:34] ➜  sort_contibutors git:(python-black-formatted) ✗ git commit        
[INFO] Initializing environment for https://github.com/psf/black.
An unexpected error has occurred: CalledProcessError: command: ('/usr/local/opt/git/libexec/git-core/git', 'checkout', '22.6b0')
return code: 1
expected return code: 0
stdout: (none)
stderr:
    error: pathspec '22.6b0' did not match any file(s) known to git
    
Check the log at /Users/razr/.cache/pre-commit/pre-commit.log
[26/01 4:42:38] ➜  sort_contibutors git:(python-black-formatted) ✗ git status
On branch python-black-formatted
Your branch is up to date with 'origin/python-black-formatted'.

Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
	modified:   main.py

Updated in the next commit

[commjoen]

Thank you!