Skip to content

Simple fields

Factory functions that return FieldSpec instances for common scalar types. Each factory accepts keyword arguments for validation constraints like required, max_length, min_value, choices, etc.

See Simple Fields reference for a summary table and Field Arguments for all available keyword arguments.

String 

String(max_length: int = 255, min_length: int | None = None, sanitize: bool = True, **kwargs: Any) -> str
Source code in src/protean/fields/simple.py 
128
129
130
131
132
133
def String(  # type: ignore[misc]
    max_length: int = 255,
    min_length: int | None = None,
    sanitize: bool = True,
    **kwargs: Any,
) -> str: ...

Text 

Text(sanitize: bool = True, **kwargs: Any) -> str
Source code in src/protean/fields/simple.py 
135
def Text(sanitize: bool = True, **kwargs: Any) -> str: ...  # type: ignore[misc]

Integer 

Integer(min_value: int | None = None, max_value: int | None = None, **kwargs: Any) -> int
Source code in src/protean/fields/simple.py 
137
138
139
140
141
def Integer(  # type: ignore[misc]
    min_value: int | None = None,
    max_value: int | None = None,
    **kwargs: Any,
) -> int: ...

Float 

Float(min_value: float | None = None, max_value: float | None = None, **kwargs: Any) -> float
Source code in src/protean/fields/simple.py 
143
144
145
146
147
def Float(  # type: ignore[misc]
    min_value: float | None = None,
    max_value: float | None = None,
    **kwargs: Any,
) -> float: ...

Boolean 

Boolean(**kwargs: Any) -> bool
Source code in src/protean/fields/simple.py 
149
def Boolean(**kwargs: Any) -> bool: ...  # type: ignore[misc]

Date 

Date(**kwargs: Any) -> date
Source code in src/protean/fields/simple.py 
151
def Date(**kwargs: Any) -> datetime.date: ...  # type: ignore[misc]

DateTime 

DateTime(**kwargs: Any) -> datetime
Source code in src/protean/fields/simple.py 
153
def DateTime(**kwargs: Any) -> datetime.datetime: ...  # type: ignore[misc]

Identifier 

Identifier(identifier: bool = False, **kwargs: Any) -> str
Source code in src/protean/fields/simple.py 
155
def Identifier(identifier: bool = False, **kwargs: Any) -> str: ...  # type: ignore[misc]

Auto 

Auto(increment: bool = False, identifier: bool = False, identity_strategy: str | None = None, identity_function: str | Callable | None = None, identity_type: str | None = None, **kwargs: Any) -> str
Source code in src/protean/fields/simple.py 
157
158
159
160
161
162
163
164
def Auto(  # type: ignore[misc]
    increment: bool = False,
    identifier: bool = False,
    identity_strategy: str | None = None,
    identity_function: str | Callable | None = None,
    identity_type: str | None = None,
    **kwargs: Any,
) -> str: ...