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

alias_generator not working if there are extra (non-alias) fields #645

gmetzker opened this issue Jul 9, 2019 · 1 comment

alias_generator not working if there are extra (non-alias) fields #645

gmetzker opened this issue Jul 9, 2019 · 1 comment


Copy link

@gmetzker gmetzker commented Jul 9, 2019


Depending on your point of view this might not be a bug but it would be cool to address in any case.

For my models I have special field configurations that I add to the Config.fields. I recently tried the alias_generator option on the Config to force fields to camel case. The problem is when Config.get_field_schema runs it thinks there is a field config so it skips the alias_generator.

It makes sense to skip it if there is an alias but in my case there are other field options but not an alias.

For bugs/questions:

  • OS: OSX
  • Python version import sys; print(sys.version): 3.7.3
  • Pydantic version import pydantic; print(pydantic.VERSION): 0.30.0

Where possible please include a self contained code snippet describing your
bug, question, or where applicable feature request:

import pydantic
import stringcase

  first_name: str
  last_name: str
  class Config:
    alias_generator = stringcase.camelcase
    fields = {
        "first_name": { "myCustomOp": True }

person = Person(first_name="Arthur" last_name="Dent")
d = person.dict(by_alias=True)
# {"first_name": "Arthur", "lastName": "Dent"}

Proposed Solution

Run the generator if it is present and 'alias' is not present.

How does this look for a fix?

def get_field_schema(cls, name: str) -> Dict[str, str]:

    field_config = cls.fields.get(name) or {}

    if isinstance(field_config, str):
        field_config = {'alias': field_config}

    elif cls.alias_generator:

        if not field_config or 'alias' not in field_config:
            alias = cls.alias_generator(name)
            if not isinstance(alias, str):
                raise TypeError(f'Config.alias_generator must return str, not {type(alias)}')

            if not field_config:
                field_config = {}
            field_config['alias'] = alias
    return field_config
Copy link

@Bobronium Bobronium commented Jul 10, 2019

Thanks for the issue, seems like a bug for me. I'll make PR with fix soon


Bobronium added a commit to Bobronium/pydantic that referenced this issue Jul 13, 2019
samuelcolvin added a commit that referenced this issue Jul 24, 2019
* Fix alias_generator and field config conflict (see #645)

* HISTORY.rst update: fix alias_generator and field config conflict

* Merge HISTORY.rst with master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants