[FMT] apply toml formatting hook on pyproject.toml

[Remi-Gau]

Closes #3870

Changes proposed in this pull request:

• adds a pre-commit hook for toml formatting to the pre-commit config
• apply the hook

Advantages

• toml is formatted

Drawback

• only if people install the hook (could be solved by adding something in CI)

[github-actions]

👋 @Remi-Gau Thanks for creating a PR!

Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft.

Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.

• PR has an interpretable title.
• PR links to Github issue with mention Closes #XXXX (see our documentation on PR structure)
• Code is PEP8-compliant (see our documentation on coding style)
• Changelog or what's new entry in doc/changes/latest.rst (see our documentation on PR structure)

For new features:

• There is at least one unit test per new function / class (see our documentation on testing)
• The new feature is demoed in at least one relevant example.

For bug fixes:

• There is at least one test that would fail under the original bug conditions.

We will review it as quick as possible, feel free to ping us with questions if needed.

[Remi-Gau]

The default config of this formater sorts the content of the toml alphabetically which has its pros and cons

[Remi-Gau]

Can check if there is more config option to avoid this reformatting

[codecov]

Codecov Report

Merging #3872 (a61721e) into main (a95149b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #3872   +/-   ##
=======================================
  Coverage   91.60%   91.60%           
=======================================
  Files         134      134           
  Lines       15705    15705           
  Branches     3270     3270           
=======================================
  Hits        14386    14386           
  Misses        770      770           
  Partials      549      549           

Flag	Coverage Δ
macos-latest_3.10	91.52% <ø> (ø)
macos-latest_3.11	91.52% <ø> (ø)
macos-latest_3.8	91.48% <ø> (ø)
macos-latest_3.9	91.48% <ø> (ø)
ubuntu-latest_3.10	91.52% <ø> (ø)
ubuntu-latest_3.11	91.52% <ø> (ø)
ubuntu-latest_3.8	91.48% <ø> (ø)
ubuntu-latest_3.9	91.48% <ø> (ø)
windows-latest_3.10	91.46% <ø> (ø)
windows-latest_3.11	91.46% <ø> (ø)
windows-latest_3.8	91.43% <ø> (ø)
windows-latest_3.9	91.43% <ø> (ø)

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

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[emdupre]

Any particular reason why 2 spaces instead of 4 ? I can't find a good, accepted style guide for TOML, so I'd think this is just developer preference.

[Remi-Gau]

I honestly went with what was in the read of the pre-commit hook repo? You want 4, let's do 4.you want 8, let's do 8. You want 16... Get me a larger screen.

[emdupre]

😂 Just wanted to confirm that there wasn't a style guide I was missing ! I'm fine with 2 or 4.

[Remi-Gau]

given that our code uses 4, let's go with 4 to avoid the mental gymnastic of 4 for python, 2 for toml (my brain is too old and unflexible for those exercises)

[bthirion]

LGTM so far.

[ymzayek]

I do prefer the original order for some tables like project but I'm not too bothered by it. LGTM otherwise, thx!

[Remi-Gau]

OK let's get this in then