Added black trailing comma style fix

[VukW]

Fixes #830 : applies new black settings to the whole repo. No logic updates, linting style only

Proposed Changes

• Resolve black CI versions conflict: now two black checks are executed. The first by psf/black@stable now runs the latest black version; the second, manual by python -m black --check . runs a hardcoded 23.11.0 version. As their required fixes differ, CI fails (it's not possible to fit both versions simultaneously). Thus , hardcoded 23.11.0 for first step also.
• Fixed black trainling-comma setting
• Changed black coverage behavior: instead of covering gandlf_* scripts only, black covers (almost) all the repo now
• Excluded some files from black coverage: files that require style fixes not connected to the trailing-comma setting
• Added all changes trailing-comma requires

Checklist

• CONTRIBUTING guide has been followed.
• PR is based on the current GaNDLF master .
• Non-breaking change (does not break existing functionality): provide as many details as possible for any breaking change.
• Function/class source code documentation added/updated (ensure typing is used to provide type hints, including and not limited to using Optional if a variable has a pre-defined value).
• Code has been blacked for style consistency and linting.
• If applicable, version information has been updated in GANDLF/version.py.
• If adding a git submodule, add to list of exceptions for black styling in pyproject.toml file.
• Usage documentation has been updated, if appropriate.
• Tests added or modified to cover the changes; if coverage is reduced, please give explanation.
• If customized dependency installation is required (i.e., a separate pip install step is needed for PR to be functional), please ensure it is reflected in all the files that control the CI, namely: python-test.yml, and all docker files [1,2,3].

[github-actions]

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.01%. Comparing base (3e0480a) to head (03b7ce9).

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #832      +/-   ##
==========================================
- Coverage   95.03%   95.01%   -0.02%     
==========================================
  Files         120      120              
  Lines        8270     8270              
==========================================
- Hits         7859     7858       -1     
- Misses        411      412       +1     

Flag	Coverage Δ
unittests	95.01% <100.00%> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sarthakpati]

Added a small comment (needs to be checked for lint)

[Geeks-Sid]

Is this trailing automated with a particular fixed version?

[sarthakpati]

Is this trailing automated with a particular fixed version?

Do you mean for the parameter skip_magic_trailing_comma? I think it should be supported in all versions since it was introduced. The idea to have the fixed version is to ensure that (if) any behavior changes are introduced by black in future versions, we know which version has been working for us, and making a change to incorporate any (hypothetical) future behavior is a deliberate decision on our part.

[VukW]

Is this trailing automated with a particular fixed version?

Sorry, @Geeks-Sid didn't get your question. The original goal was just to add skip_magic_trailing_comma = true setting into black config. However, during this fix a few additional issues arised:

• Black didn't really check the repo code because of include = 'gandlf_*' setting in pyproject.toml. That made black to check only gandlf_* scripts, leaving all other files not covered. => Solution: remove this setting, covering all the project, adding all the necessary black changes.
• In CI workflow black version in first step wasn't fixed, thus black CI always fails because checks are made by two conflicting black versions simultaneously => Solution: to fix black version in CI to 23.11.0 (just because we are using this version right now)

Not sure if I answered the question; if smth is still unclear, feel free to ask!

[Geeks-Sid]

Understood. LGTM. Quite long of a PR. Well done.

[szmazurek]

LGTM