style guide

[bjuergens]

I noticed in some PR there is a lot of clutter because of inconsistent style.

We should define some style-guides (e.g. " vs ' for strings, for order of imports, and for formatting string). We should just follow the official style guides as far as possible.

---

Here is an example how bad formatting can create problems:

at first glance it looks, like nothing has changed at all. You have to consciously look for differences to notice, that the import of ConfigClass has been removed.

I suggest we simply use the "Optimize Imports" feature of pycharm; https://www.jetbrains.com/help/pycharm/creating-and-optimizing-imports.html#optimize-imports-in-project

There is a official python style guide on this, which -convieniently- describes exactly what the pycharm feature does already: https://www.python.org/dev/peps/pep-0008/#imports

---

Adopting this change would come with the follow practical changes:

• I make one big PR, which changes all styles across all files
• you press ctrl-alt-oand ctrl-alt-L before commiting a file (or whenever you remember to do so)
• I add a check to the actions-runner, which will give a warning (not an error) when the formatting is bad

[bjuergens]

some info for github actions for style checks:

• general idea: https://wkrzywiec.medium.com/how-to-write-good-quality-python-code-with-github-actions-2f635a2ab09a
• currently my favorit implementation: https://wemake-python-stylegui.de/en/latest/pages/usage/integrations/github-actions.html

basically this can be implemented by adding 6 lines to the CI-config:

- name: wemake-python-styleguide
  uses: wemake-services/wemake-python-styleguide
  with:
    reporter: 'github-pr-check'
  env:
    GITHUB_TOKEN: ${{ secrets.github_token }}

I am a little confused/annoyed, that a secret token needs to be passed to it though.

note: This tool can be used as a simple checker, that adds a little yellow flag at the end of a PR, when the style check fails. But It can also act as a reviewer, that provides a code-review and automatically suggestests changes.

[pdeubel]

I don't like the secret token either, maybe it is necessary so that it can comment on files to do its code-review.

Style related: I use Optimize Imports and Rearrange Code from PyCharm and double quotes for all stings. Other than that I try to follow Pep8.

As long as this is done with any tool in the Action Runner I'm fine with it. Did you do #82 by hand or can this be done in the Action Runner automatically?

[bjuergens]

Did you do #82 by hand or can this be done in the Action Runner automatically?

pycharm somewhere has a button that runs the code-formatter on all files in a project. That's what I used for #82.

[pdeubel]

Ok I would vote for pycharm