Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a header for autogenerated classes #596

Open
ktekelioglu opened this issue Aug 3, 2022 · 0 comments · May be fixed by #598
Open

Add a header for autogenerated classes #596

ktekelioglu opened this issue Aug 3, 2022 · 0 comments · May be fixed by #598

Comments

@ktekelioglu
Copy link

What happened?

This issue is linked to #595. When I discovered an issue with the palantir-python-sdk library, it was pretty much impossible to know that the bug was originating from conjure-python until the person who owns the project told me so.

Additionally, after a bug is fixed in this library, there's currently no way to know if a class generated by this library may be impacted by that bug.

What did you want to happen?

Projects that generate code usually include annotations or a header, so that it's clear how this code is generated (examples that come to mind are jOOQ / Immutables) Ideally, this should include a version number, so that it's easier to read changelogs and understand any potential impact.

Here's what a simple implementation could look like:

'''
This file has been generated by conjure-python version x.y.z
https://github.com/palantir/conjure-python
'''

import ...

class TestService(Service):
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant