Formatron v0.4.2
Formatron empowers everyone to control the output format of language models with minimal overhead.
Loading...
Searching...
No Matches
formatron.schemas.pydantic.FieldInfo Class Reference

A wrapper for pydantic FieldInfo. More...

Public Member Functions

 __init__ (self, pydantic.fields.FieldInfo field)
 Initialize the field information.
 
 __repr__ (self)
 
 __str__ (self)
 

Protected Attributes

 _field
 

Properties

typing.Type[typing.Any]|None annotation (self)
 
bool required (self)
 

Detailed Description

A wrapper for pydantic FieldInfo.

Definition at line 18 of file pydantic.py.

Constructor & Destructor Documentation

◆ __init__()

formatron.schemas.pydantic.FieldInfo.__init__ ( self,
pydantic.fields.FieldInfo field )

Initialize the field information.

Definition at line 24 of file pydantic.py.

Member Function Documentation

◆ __repr__()

formatron.schemas.pydantic.FieldInfo.__repr__ ( self)

Definition at line 53 of file pydantic.py.

◆ __str__()

formatron.schemas.pydantic.FieldInfo.__str__ ( self)

Definition at line 56 of file pydantic.py.

◆ annotation()

typing.Type[typing.Any] | None formatron.schemas.pydantic.FieldInfo.annotation ( self)

Definition at line 35 of file pydantic.py.

◆ required()

bool formatron.schemas.pydantic.FieldInfo.required ( self)

Definition at line 48 of file pydantic.py.

Member Data Documentation

◆ _field

formatron.schemas.pydantic.FieldInfo._field
protected

Definition at line 25 of file pydantic.py.


The documentation for this class was generated from the following file: