Generated code style

[pawamoy]

Would you consider taking extra care to follow style conventions in the generated code?

I noticed a few things, like spaces at the beginning and end of docstrings, or an extra blank line after a function return type annotation.

I can send small PRs with style-fixes if you want 🙂

[dbanty]

I'd certainly welcome any style improvements. I often find it difficult to wrangle spacing jinja2 templates especially around optional clauses. Currently I believe the generator runs Black on generated clients to try and clean up some of the offenses but flake8 is definitely much pickier.

Just know that if you change the templates the end to end test will fail unless you generating the "golden master". I believe how to do all of that is outlined in the CONTRIBUTING.md

[dbanty]

I think the goal should probably be running flake8 in the end to end test using the same profile that this project uses.

[pawamoy]

I wrote a small post about Jinja2 spacing here: https://pawamoy.github.io/posts/how-to-deal-with-jinja2-spacing/. Basically, to make sure optional clause completely disappear without leaving blank lines behind when they are false, you can do this:

class Run:
    def pause(self):
        print("pausing")
    {%- if stoppable %}


    def stop(self):
        print("stopping")
    {%- endif %}


    def resume(self):
      print("resuming")

...or that:

class Run:
    def pause(self):
        print("pausing")


    {% if stoppable -%}
    def stop(self):
        print("stopping")


    {% endif -%}
    def resume(self):
        print("resuming")

[dbanty]

Thanks @pawamoy, this is the best explanation of the -% syntax I've seen. Jinja's documentation is quite terse- though looking back at it after reading your post it finally makes sense 😅. This should help with improving spacing in future versions.

[dbanty]

0.6.1 will run autoflake on generated clients to clean up extra imports/variables. I also explicitly ignore a bare exception warning on union types (since covering all the possible exceptions would be a pain).

Combined with spacing improvements in 0.6.0 the end to end test now passes flake8! If you encounter any more specific issues let me know and we'll address them one by one (and add tests to catch them).