Skip to content

Model Fields

This part of the documentation covers all field classes for defining the Table column types.

Field

class pytql.fields.Field (name: str | None = None, nullable: bool = True, unique: bool = False, editable: bool = True, serialize: bool = True)

         Base class from which other Field classes inherit from.

Parameters:

  • name (str | None) - Name of the column field.
  • nullable (bool) - Option to determine whether the column can be null.
  • unique (bool) - Option to determine whether the column should be unique.
  • editable (bool) - Option to determine whether the column should be editable.
  • serialize (bool) - Option to determine whether the column should be serialized.


BooleanField

class pytql.fields.BooleanField (name: str | None = None, nullable: bool = True, unique: bool = False, editable: bool = True, serialize: bool = True)

        Bases: Field

         Class for setting boolean field values for models.

Parameters:
         BooleanField inherits all its parameters from base class Field .


FloatField

class pytql.fields.FloatField (name: str | None = None, nullable: bool = True, unique: bool = False, editable: bool = True, serialize: bool = True)

        Bases: Field

         Class for setting float field values for models.

Parameters:
         FloatField inherits all its parameters from base class Field .


IntField

class pytql.fields.IntField (name: str | None = None, nullable: bool = True, unique: bool = False, editable: bool = True, serialize: bool = True)

        Bases: Field

         Class for setting integer field values for models.

Parameters:
         IntField inherits all its parameters from base class Field .


CharField

class pytql.fields.CharField (max_length: int = 225, name: str | None = None, nullable: bool = True, unique: bool = False, editable: bool = True, serialize: bool = True, choices: Any | None = None)

        Bases: Field

         Class for setting chracter field values for models. Accepts a max size of 255 characters.

Parameters:

  • max_length (int) - Maximum length of field value.
  • choices (Any | None) - List of choices field values can be selected


TextField

class pytql.fields.TextField (max_length: int = 225, name: str | None = None, nullable: bool = True, unique: bool = False, editable: bool = True, serialize: bool = True, choices: Any | None = None)

        Bases: CharField

         Class for setting chracter field values for models. Accepts a max size of 1024 characters.

Parameters:

  • max_length (int) - Maximum length of field value.
  • choices (Any | None) - List of choices field values can be selected