Coding Conventions: Integrate Black and Flake8

Basically the integration and config should match the one in engine#96 (closed).

The only caveat: Everything in src/rest/** should be excluded from auto-formatting as this is generated API code.

changed milestone to %1.0-alpha2 — Precise Pheasant

added P2 label

assigned to @david

mentioned in issue engine#96 (closed)

marked this issue as related to engine#96 (closed)

added To Do label

marked this issue as related to steering#86 (closed)

changed the description

Add:

The only caveat: Everything in [src/rest/**](https://gitlab.servus.at/aura/engine-api/-/tree/master/src/rest should be excluded from auto-formatting as this is generated API code.

changed the description

The only caveat: Everything in src/rest/** should be excluded from auto-formatting as this is generated API code.

Are you really sure, that all files in this directories are autogenerated?

I just stumbled upon a misspelled true (instead of True) token (introduced in ab3e6ead).

In general the commit history of that path does not look like the result of automatically generated code.

I would really like to clean up stuff like:

• from __future__ import absolute_imports: this is part of Python since 3.0
• import six: this should not be relevant for python3 code
• unnecessary noqa exceptions

I guess, it would be sufficient to exclude src/rest/models/ instead of the full src/rest/ directory?

Are you really sure, that all files in this directories are autogenerated?

Yes.

I just stumbled upon a misspelled true (instead of True) token (introduced in ab3e6ead).

Thanks for pointing that out. That's an issue in the code generator. I've noted it in #5 (closed). For now it's not so relevant, because these tests are not executed yet.

I would really like to clean up stuff like: ...

All these things you mention are generated.

I guess, it would be sufficient to exclude src/rest/models/ instead of the full src/rest/ directory?

No, this would make the merges and API changes more complicated. Currently only the Service class calls in the Controller methods need to be manually merged.

Thanks for the link to the README. Now I understand, how this code is supposed to be updated.

I would recommend to add a line like "Generated via https://app.swaggerhub.com/apis/AURA-Engine/engine-api/` to the commit message for such half-automated updates. This would clarify the nature of these files for contributors.

And maybe you could mention in the README, how contributors can gain write permissions for the above app.swaggerhub.com project.

I would recommend to add a line like "Generated via https://app.swaggerhub.com/apis/AURA-Engine/engine-api/` to the commit message for such half-automated updates. This would clarify the nature of these files for contributors.

Thanks for the suggestion. Will think about that in the future.

And maybe you could mention in the README, how contributors can gain write permissions for the above app.swaggerhub.com project.

In my opinion that's not different to other types of contributions. Contributors are advised to:

1. Read the README.md
2. Read the CONTRIBUTING.md. This is an established approach and already hints to get in touch with the maintainers, in case of questions and planned contributions.

closed