Short way to get all field names of a pydantic class

You can do simply

TestClass.model_fields 

Update January 2024: This answer was my method to get the fields before pydantic v1. In v1 the __fields__ was added. This was then deprecated with the introduction of model_fields in v2.

Okay the solution is to use a class-method instead of an instance method:

from pydantic import BaseModel, Field class AdaptedModel(BaseModel): @classmethod def get_field_names(cls,alias=False): return list(cls.schema(alias).get("properties").keys()) class TestClass(AdaptedModel): test: str = Field(alias="TEST") 

We are using Python 3.6.8 and apparently it was already introduce. For completeness sake can somebody comment since when @classmethod exists? I assume since 3.6.

Here's a solution that combines the answers from miksus and 5th to support listing field names by their alias:

from pydantic import BaseModel from pydantic.fields import ModelField, Field class AdaptedModel(BaseModel): base_field_1: str = Field(alias="base_field_1_alias") @classmethod def get_field_names(cls, by_alias=False) -> list[str]: field_names = [] for k, v in cls.__fields__.items(): if by_alias and isinstance(v, ModelField): field_names.append(v.alias) else: field_names.append(k) return field_names class TestClass(AdaptedModel): test_field_1: str = Field(alias="test_field_1_alias") test_field_2: str 

To be used in the following manner:

print(TestClass.get_field_names(by_alias=True)) 

which outputs

['base_field_1_alias', 'test_field_1_alias', 'test_field_2'] 

Or you can get a list of non-aliased names with by_alias=False (the default):

print(TestClass.get_field_names(by_alias=False)) 

which outputs:

['base_field_1', 'test_field_1', 'test_field_2'] 

Edit

Here's a pydantic v2 equivalent:

from pydantic import BaseModel from pydantic.fields import Field class AdaptedModel(BaseModel): base_field_1: str = Field(alias="base_field_1_alias") @classmethod def get_field_names(cls, by_alias=False) -> list[str]: field_names = [] for k, v in cls.model_fields.items(): if by_alias and v.alias: field_names.append(v.alias) else: field_names.append(k) return field_names class TestClass(AdaptedModel): test_field_1: str = Field(alias="test_field_1_alias") test_field_2: str 

If you need also the type of each field you might just use jsonref:

import jsonref from pprint import pprint from enum import Enum class Values(Enum): a = 'a' b = 'b' class Mdl(BaseModel): par: Values = Field( title="par", description="description of my parameter" ) par2: str = Field( title="par2", description="description of my parameter" ) par3: int = Field( title="par3", description="description of my parameter" ) class Config: """ Automatically convert enum to values """ use_enum_values = True pprint(jsonref.loads(Mdl.schema_json())) 

produces

{'definitions': {'Values': {'description': 'An enumeration.', 'enum': ['a', 'b'], 'title': 'Values'}}, 'properties': {'par': {'allOf': [{'title': 'Values', 'description': 'An enumeration.', 'enum': ['a', 'b']}], 'description': 'description of my parameter', 'title': 'MyParameter'}, 'par2': {'description': 'description of my parameter', 'title': 'MyParameter', 'type': 'string'}, 'par3': {'description': 'description of my parameter', 'title': 'MyParameter', 'type': 'integer'}}, 'required': ['par', 'par2', 'par3'], 'title': 'Mdl', 'type': 'object'} 

Latter might further cleaned with

sch = jsonref.loads(Mdl.schema_json()) for par in sch['properties']: if 'allOf' in sch['properties']['par']: if 'enum' in sch['properties']['par']['allOf'][0]: sch['properties']['par']['title'] = sch['properties']['par']['allOf'][0]['title'] sch['properties']['par']['allowed_values'] = sch['properties']['par']['allOf'][0]['enum'] sch['properties']['par'].pop('allOf') 

that returns

{'definitions': {'Values': {'description': 'An enumeration.', 'enum': ['a', 'b'], 'title': 'Values'}}, 'properties': {'par': {'allowed_values': ['a', 'b'], 'description': 'description of my parameter', 'title': 'Values'}, 'par2': {'description': 'description of my parameter', 'title': 'MyParameter', 'type': 'string'}, 'par3': {'description': 'description of my parameter', 'minimum': 0, 'title': 'MyParameter', 'type': 'integer'}}, 'required': ['par', 'par2', 'par3'], 'title': 'Mdl', 'type': 'object'}