Skip to content

Add pyairtable.models.schema.FieldType enum #444

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.

Sign up for GitHub

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

Merged
mesozoic merged 1 commit into from
Nov 5, 2025
Merged

Add pyairtable.models.schema.FieldType enum #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 84 additions & 34 deletions pyairtable/models/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import importlib
from datetime import datetime
from enum import Enum
from functools import partial
from typing import (
TYPE_CHECKING,
Expand Down Expand Up @@ -30,6 +31,55 @@
from pyairtable import orm


class FieldType(str, Enum):
"""
Enumeration of all field types supported by Airtable.

Usage:
>>> from pyairtable.models.schema import FieldType
>>> FieldType.SINGLE_LINE_TEXT
FieldType('singleLineText')
"""

AI_TEXT = "aiText"
AUTO_NUMBER = "autoNumber"
BARCODE = "barcode"
BUTTON = "button"
CHECKBOX = "checkbox"
COUNT = "count"
CREATED_BY = "createdBy"
CREATED_TIME = "createdTime"
CURRENCY = "currency"
DATE = "date"
DATE_TIME = "dateTime"
DURATION = "duration"
EMAIL = "email"
EXTERNAL_SYNC_SOURCE = "externalSyncSource"
FORMULA = "formula"
LAST_MODIFIED_BY = "lastModifiedBy"
LAST_MODIFIED_TIME = "lastModifiedTime"
MANUAL_SORT = "manualSort"
MULTILINE_TEXT = "multilineText"
MULTIPLE_ATTACHMENTS = "multipleAttachments"
MULTIPLE_COLLABORATORS = "multipleCollaborators"
MULTIPLE_LOOKUP_VALUES = "multipleLookupValues"
MULTIPLE_RECORD_LINKS = "multipleRecordLinks"
MULTIPLE_SELECTS = "multipleSelects"
NUMBER = "number"
PERCENT = "percent"
PHONE_NUMBER = "phoneNumber"
RATING = "rating"
RICH_TEXT = "richText"
ROLLUP = "rollup"
SINGLE_COLLABORATOR = "singleCollaborator"
SINGLE_LINE_TEXT = "singleLineText"
SINGLE_SELECT = "singleSelect"
URL = "url"

def __repr__(self) -> str:
return f"FieldType({self.value!r})"
Comment on lines +79 to +80
Copy link

Copilot AI Nov 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The custom __repr__ method is unnecessary. The default Enum.__repr__ already provides a suitable representation (e.g., <FieldType.SINGLE_LINE_TEXT: 'singleLineText'>). Unless there's a specific requirement for this exact format, the default should be sufficient.

Suggested change
def __repr__(self) -> str:
return f"FieldType({self.value!r})"

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Collaborator Author

@mesozoic mesozoic Nov 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, I think the existing representation is ugly, and I will have to stare at this all the time. 😁



FieldSpecifier: TypeAlias = Union[str, "orm.fields.AnyField"]

_T = TypeVar("_T", bound=Any)
Expand Down Expand Up @@ -755,7 +805,7 @@ class AITextFieldConfig(AirtableModel):
Field configuration for `AI text <https://airtable.com/developers/web/api/field-model#aitext>`__.
"""

type: Literal["aiText"]
type: Literal[FieldType.AI_TEXT]
options: "AITextFieldOptions"


Expand All @@ -772,31 +822,31 @@ class AutoNumberFieldConfig(AirtableModel):
Field configuration for `Auto number <https://airtable.com/developers/web/api/field-model#autonumber>`__.
"""

type: Literal["autoNumber"]
type: Literal[FieldType.AUTO_NUMBER]


class BarcodeFieldConfig(AirtableModel):
"""
Field configuration for `Barcode <https://airtable.com/developers/web/api/field-model#barcode>`__.
"""

type: Literal["barcode"]
type: Literal[FieldType.BARCODE]


class ButtonFieldConfig(AirtableModel):
"""
Field configuration for `Button <https://airtable.com/developers/web/api/field-model#button>`__.
"""

type: Literal["button"]
type: Literal[FieldType.BUTTON]


class CheckboxFieldConfig(AirtableModel):
"""
Field configuration for `Checkbox <https://airtable.com/developers/web/api/field-model#checkbox>`__.
"""

type: Literal["checkbox"]
type: Literal[FieldType.CHECKBOX]
options: "CheckboxFieldOptions"


Expand All @@ -810,7 +860,7 @@ class CountFieldConfig(AirtableModel):
Field configuration for `Count <https://airtable.com/developers/web/api/field-model#count>`__.
"""

type: Literal["count"]
type: Literal[FieldType.COUNT]
options: "CountFieldOptions"


Expand All @@ -824,23 +874,23 @@ class CreatedByFieldConfig(AirtableModel):
Field configuration for `Created by <https://airtable.com/developers/web/api/field-model#createdby>`__.
"""

type: Literal["createdBy"]
type: Literal[FieldType.CREATED_BY]


class CreatedTimeFieldConfig(AirtableModel):
"""
Field configuration for `Created time <https://airtable.com/developers/web/api/field-model#createdtime>`__.
"""

type: Literal["createdTime"]
type: Literal[FieldType.CREATED_TIME]


class CurrencyFieldConfig(AirtableModel):
"""
Field configuration for `Currency <https://airtable.com/developers/web/api/field-model#currencynumber>`__.
"""

type: Literal["currency"]
type: Literal[FieldType.CURRENCY]
options: "CurrencyFieldOptions"


Expand All @@ -854,7 +904,7 @@ class DateFieldConfig(AirtableModel):
Field configuration for `Date <https://airtable.com/developers/web/api/field-model#dateonly>`__.
"""

type: Literal["date"]
type: Literal[FieldType.DATE]
options: "DateFieldOptions"


Expand All @@ -867,7 +917,7 @@ class DateTimeFieldConfig(AirtableModel):
Field configuration for `Date and time <https://airtable.com/developers/web/api/field-model#dateandtime>`__.
"""

type: Literal["dateTime"]
type: Literal[FieldType.DATE_TIME]
options: "DateTimeFieldOptions"


Expand All @@ -890,7 +940,7 @@ class DurationFieldConfig(AirtableModel):
Field configuration for `Duration <https://airtable.com/developers/web/api/field-model#durationnumber>`__.
"""

type: Literal["duration"]
type: Literal[FieldType.DURATION]
options: "DurationFieldOptions"


Expand All @@ -903,15 +953,15 @@ class EmailFieldConfig(AirtableModel):
Field configuration for `Email <https://airtable.com/developers/web/api/field-model#email>`__.
"""

type: Literal["email"]
type: Literal[FieldType.EMAIL]


class ExternalSyncSourceFieldConfig(AirtableModel):
"""
Field configuration for `Sync source <https://airtable.com/developers/web/api/field-model#syncsource>`__.
"""

type: Literal["externalSyncSource"]
type: Literal[FieldType.EXTERNAL_SYNC_SOURCE]
options: "SingleSelectFieldOptions"


Expand All @@ -920,7 +970,7 @@ class FormulaFieldConfig(AirtableModel):
Field configuration for `Formula <https://airtable.com/developers/web/api/field-model#formula>`__.
"""

type: Literal["formula"]
type: Literal[FieldType.FORMULA]
options: "FormulaFieldOptions"


Expand All @@ -936,15 +986,15 @@ class LastModifiedByFieldConfig(AirtableModel):
Field configuration for `Last modified by <https://airtable.com/developers/web/api/field-model#lastmodifiedby>`__.
"""

type: Literal["lastModifiedBy"]
type: Literal[FieldType.LAST_MODIFIED_BY]


class LastModifiedTimeFieldConfig(AirtableModel):
"""
Field configuration for `Last modified time <https://airtable.com/developers/web/api/field-model#lastmodifiedtime>`__.
"""

type: Literal["lastModifiedTime"]
type: Literal[FieldType.LAST_MODIFIED_TIME]
options: "LastModifiedTimeFieldOptions"


Expand All @@ -959,23 +1009,23 @@ class ManualSortFieldConfig(AirtableModel):
Field configuration for ``manualSort`` field type (not documented).
"""

type: Literal["manualSort"]
type: Literal[FieldType.MANUAL_SORT]


class MultilineTextFieldConfig(AirtableModel):
"""
Field configuration for `Long text <https://airtable.com/developers/web/api/field-model#multilinetext>`__.
"""

type: Literal["multilineText"]
type: Literal[FieldType.MULTILINE_TEXT]


class MultipleAttachmentsFieldConfig(AirtableModel):
"""
Field configuration for `Attachments <https://airtable.com/developers/web/api/field-model#multipleattachment>`__.
"""

type: Literal["multipleAttachments"]
type: Literal[FieldType.MULTIPLE_ATTACHMENTS]
options: "MultipleAttachmentsFieldOptions"


Expand All @@ -992,15 +1042,15 @@ class MultipleCollaboratorsFieldConfig(AirtableModel):
Field configuration for `Multiple Collaborators <https://airtable.com/developers/web/api/field-model#multicollaborator>`__.
"""

type: Literal["multipleCollaborators"]
type: Literal[FieldType.MULTIPLE_COLLABORATORS]


class MultipleLookupValuesFieldConfig(AirtableModel):
"""
Field configuration for `Lookup <https://airtable.com/developers/web/api/field-model#lookup>__`.
"""

type: Literal["multipleLookupValues"]
type: Literal[FieldType.MULTIPLE_LOOKUP_VALUES]
options: "MultipleLookupValuesFieldOptions"


Expand All @@ -1016,7 +1066,7 @@ class MultipleRecordLinksFieldConfig(AirtableModel):
Field configuration for `Link to another record <https://airtable.com/developers/web/api/field-model#foreignkey>__`.
"""

type: Literal["multipleRecordLinks"]
type: Literal[FieldType.MULTIPLE_RECORD_LINKS]
options: "MultipleRecordLinksFieldOptions"


Expand All @@ -1033,7 +1083,7 @@ class MultipleSelectsFieldConfig(AirtableModel):
Field configuration for `Multiple select <https://airtable.com/developers/web/api/field-model#multiselect>`__.
"""

type: Literal["multipleSelects"]
type: Literal[FieldType.MULTIPLE_SELECTS]
options: "SingleSelectFieldOptions"


Expand All @@ -1042,7 +1092,7 @@ class NumberFieldConfig(AirtableModel):
Field configuration for `Number <https://airtable.com/developers/web/api/field-model#decimalorintegernumber>`__.
"""

type: Literal["number"]
type: Literal[FieldType.NUMBER]
options: "NumberFieldOptions"


Expand All @@ -1055,7 +1105,7 @@ class PercentFieldConfig(AirtableModel):
Field configuration for `Percent <https://airtable.com/developers/web/api/field-model#percentnumber>`__.
"""

type: Literal["percent"]
type: Literal[FieldType.PERCENT]
options: "NumberFieldOptions"


Expand All @@ -1064,15 +1114,15 @@ class PhoneNumberFieldConfig(AirtableModel):
Field configuration for `Phone <https://airtable.com/developers/web/api/field-model#phone>`__.
"""

type: Literal["phoneNumber"]
type: Literal[FieldType.PHONE_NUMBER]


class RatingFieldConfig(AirtableModel):
"""
Field configuration for `Rating <https://airtable.com/developers/web/api/field-model#rating>`__.
"""

type: Literal["rating"]
type: Literal[FieldType.RATING]
options: "RatingFieldOptions"


Expand All @@ -1087,15 +1137,15 @@ class RichTextFieldConfig(AirtableModel):
Field configuration for `Rich text <https://airtable.com/developers/web/api/field-model#rich-text>`__.
"""

type: Literal["richText"]
type: Literal[FieldType.RICH_TEXT]


class RollupFieldConfig(AirtableModel):
"""
Field configuration for `Rollup <https://airtable.com/developers/web/api/field-model#rollup>__`.
"""

type: Literal["rollup"]
type: Literal[FieldType.ROLLUP]
options: "RollupFieldOptions"


Expand All @@ -1112,23 +1162,23 @@ class SingleCollaboratorFieldConfig(AirtableModel):
Field configuration for `Collaborator <https://airtable.com/developers/web/api/field-model#collaborator>`__.
"""

type: Literal["singleCollaborator"]
type: Literal[FieldType.SINGLE_COLLABORATOR]


class SingleLineTextFieldConfig(AirtableModel):
"""
Field configuration for `Single line text <https://airtable.com/developers/web/api/field-model#simpletext>`__.
"""

type: Literal["singleLineText"]
type: Literal[FieldType.SINGLE_LINE_TEXT]


class SingleSelectFieldConfig(AirtableModel):
"""
Field configuration for `Single select <https://airtable.com/developers/web/api/field-model#select>`__.
"""

type: Literal["singleSelect"]
type: Literal[FieldType.SINGLE_SELECT]
options: "SingleSelectFieldOptions"


Expand All @@ -1146,7 +1196,7 @@ class UrlFieldConfig(AirtableModel):
Field configuration for `Url <https://airtable.com/developers/web/api/field-model#urltext>`__.
"""

type: Literal["url"]
type: Literal[FieldType.URL]


class UnknownFieldConfig(AirtableModel):
Expand Down
Loading