Skip to content

Add a header for autogenerated classes #596

Open
@ktekelioglu

Description

@ktekelioglu

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):

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions