Linting and code formatting

[katoss]

Hi everyone,

in this PR/on this branch I'm trying to collect commits related to general code formatting and linting.

These are the issues I've addressed or plan to address (I added names according to who gave me feedback on this, but of course feel free to review any of them!):

1. Linting

• @Robaina, @Batalex, @khynder
• 4e1a75b, 91482b1: Added black to poetry and formatted the analysis file with it
• Open Question: I am wondering now where to best integrate black, I read that it is possible as pre-commit hook and in the CI (as suggested by @Robaina ). Maybe even both? Then there would be a local check before committing, and also a later check in case some contributor does not use the pre-commit hook. What do you think?

2. Type hints

• 0fe257e: Added type hints (@Robaina )

3. Specific formatting issues:

• ca2c2de: Moved "__all__" below imports (@Batalex)
• 263df2f, ffcd08b: Replaced concats with format strings (@Robaina , @Batalex)

Best,
@katoss

[codecov]

Codecov Report

Patch coverage: 95.83% and project coverage change: +0.21 🎉

Comparison is base (2ed2dba) 79.38% compared to head (0a2b4b1) 79.59%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main       #2      +/-   ##
==========================================
+ Coverage   79.38%   79.59%   +0.21%     
==========================================
  Files           2        2              
  Lines          97       98       +1     
==========================================
+ Hits           77       78       +1     
  Misses         20       20              

Impacted Files	Coverage Δ
src/cardsort/analysis.py	78.94% <95.65%> (+0.22%)	⬆️
src/cardsort/__init__.py	100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[Batalex]

You can take a look at https://pre-commit.ci/ so that you can integrate black in your CI

[Robaina]

Nice use of typing! much clearer now

[katoss]

You can take a look at https://pre-commit.ci/ so that you can integrate black in your CI

@Batalex I have not entirely understood this service yet. I add black to the pre-commit file (which I haven't created it), and then this service will automatically perform the precommit as part of the CI?

[Batalex]

You can take a look at https://pre-commit.ci/ so that you can integrate black in your CI

@Batalex I have not entirely understood this service yet. I add black to the pre-commit file (which I haven't created it), and then this service will automatically perform the precommit as part of the CI?

Yes, that is the idea. I have yet to use this service myself, so this is not by any means required for our review process.

[katoss]

Yes, that is the idea. I have yet to use this service myself, so this is not by any means required for our review process.

I tried it and it seems to work :) I will convert this draft to a PR, I think we are good to go with this one, too

[Batalex]

I noticed a few typos in the code (treshold instead of threshold). It's up to you if you want to fix it in this PR.
Otherwise, LGTM ✔︎

[Batalex]

If you'd like, you could use comments to disable black for these lines:

# fmt: off
expected = [...]

# fmt: on

[katoss]

oh yes, great, I already wondered if this is really the intended behavior in this case, listing one value in each line. I didn't know that black could be disabled for specific lines, will do