Revisit the reserved terms in gapic/utils/reserved_names.py

[Ark-kun]

I've just noticed that the generated classes mangle the license field name:

class Citation(proto.Message):
    r"""Source attributions for content."""
    ...
    license_: str = proto.Field(
        proto.STRING,
        number=5,
    )

https://github.com/googleapis/python-aiplatform/blob/c56dd50310ecc42d6a3b0cd2f30db71e8cad0cf6/google/cloud/aiplatform_v1/types/content.py#L572

I think this is incorrect. license is not a Python reserved keyword and it can definitely be used as an attribute name.

[parthea]

It exists as a built-in constant: https://docs.python.org/3/library/constants.html#constants-added-by-the-site-module

>>> license
Type license() to see the full license text

>>> license()
A. HISTORY OF THE SOFTWARE
==========================

[parthea]

I'm going to close this issue but please feel free to open a new issue with more information.

[Ark-kun]

It exists as a built-in constant

This does not prevent it from being used as a field name.

[parthea]

A decision was made to add the trailing underscore in #514 (Fixes issue #504). Re-opening this issue to keep the discussion going.

[parthea]

In the example from #2015 (comment)

class Citation(proto.Message):
    r"""Source attributions for content."""
    ...
    license: str = proto.Field(
        proto.STRING,
        number=5,
    )

We would be clobbering the built-in constant license. It can be done technically but It is generally bad practice.

Nonetheless, I'll keep this open as a feature request so we can evaluate when we are considering the next breaking change.

(Regardless of whether it can be done technically, it would be a breaking change to remove terms from the reserved words list. )