Invalid identifiers generated

[kalzoo]

Describe the bug

Schema fields may generate client models which contain invalid identifiers.

Example

    Foo:
      additionalProperties: false
      properties:
        1Q:
          title: 1Q
          type: object
        2Q:
          title: 2Q
          type: object
      required:
        - 1Q
        - 2Q
      title: Foo
      type: object

generates a class which is invalid Python:

class Foo:
    """  """
    1_q: Dict[Any, Any]
    2_q: Dict[Any, Any]

    def to_dict(self) -> Dict[str, Any]:
        1_q = self.1_q

        2_q = self.2_q


        return {
            "1Q": 1_q,
            "2Q": 2_q,
        }

Expected behavior

The output should be sanitized in some way. Python's str.isidentifier can help, and the output could be prefixed by _ (although that could appear to be private, and thus confusing), or __, or field_, or something else.

In our manually-written clients, we replace it with one_q and two_q, but that's not generally applicable in openapi-python-client (for reasons to include internationalization and maintaining semantic meaning)

As it stands now, this requires manual correction after generation. If the intent is (eventually) to support all valid OpenAPI schemas, then this would have to be addressed at some point.

Desktop (please complete the following information):

• OS: OSX 10.15.6
• Python Version: 3.7.3
• openapi-python-client version: 0.6.1

Thanks! Happy to send a PR for it.

[dbanty]

Thanks @kalzoo, this is definitely something we should address. I do like the field_ option better to avoid the Python private syntax. If you want to take a crack at it, I'd be happy to accept a PR. I believe this would just be some additional sanitization on parser.properties.Property.python_name

[dbanty]

Thanks for the report and the fix for this @kalzoo! It'll be in the next release (0.6.2). My plan is to wait until a couple more things are complete before doing a release, but if you need this soon just let me know and I'll put the release together sooner.

[kalzoo]

That works for me! The patching setup I have is good for the short term. Thanks again.