API Documentation

This section covers the detailed API

• Python Objects
  • Schema
    • Schema
      • Schema.output_type
      • Schema.bind()
      • Schema.bind_fields()
      • Schema.get_fields()
      • Schema.get_model()
      • Schema.deserialize()
      • Schema.load_model()
      • Schema.make_field()
      • Schema.make_dataclass()
      • Schema.load_batch()
    • PolymorphicSchema
      • PolymorphicSchema.bind()
      • PolymorphicSchema.choose_schema()
      • PolymorphicSchema.deserialize()
    • RegexSchema
      • RegexSchema.deserialize()
      • RegexSchema.bind_fields()
      • RegexSchema.convert_groupdict()
      • RegexSchema.to_string()
    • ZipSchema
      • ZipSchema.bind()
      • ZipSchema.deserialize()
      • ZipSchema.load_model()
  • Fields
    • Field
      • Field.output_type
      • Field.load()
    • String
      • String.output_type
      • String.deserialize()
      • String.to_string()
    • DateTime
      • DateTime.output_type
      • DateTime.parse_date()
      • DateTime.deserialize()
      • DateTime.post_load()
    • Date
      • Date.output_type
      • Date.deserialize()
    • Boolean
      • Boolean.output_type
      • Boolean.deserialize()
    • Float
      • Float.output_type
      • Float.deserialize()
    • Integer
      • Integer.output_type
      • Integer.deserialize()
    • Exists
      • Exists.output_type
      • Exists.deserialize()
    • Const
      • Const.deserialize()
    • Nested
      • Nested.output_type
      • Nested.bind()
      • Nested.make_accessor()
      • Nested.load()
    • List
      • List.output_type
      • List.bind()
      • List.load()
    • Dictionary
      • Dictionary.output_type
      • Dictionary.load()
    • DelimitedString
      • DelimitedString.output_type
      • DelimitedString.bind()
      • DelimitedString.deserialize()
    • Combine
      • Combine.output_type
      • Combine.bind()
      • Combine.load()
      • Combine.combine_func()
      • Combine.get_model()
    • Alternative
      • Alternative.deserialize()
    • Str
    • DT
    • Bool
    • Int
    • Alt
    • Dict
• Data Objects
  • AttrDict
    • AttrDict.convert()
    • AttrDict.clear()
    • AttrDict.copy()
    • AttrDict.fromkeys()
    • AttrDict.get()
    • AttrDict.items()
    • AttrDict.keys()
    • AttrDict.pop()
    • AttrDict.popitem()
    • AttrDict.setdefault()
    • AttrDict.to_dict()
    • AttrDict.to_json()
    • AttrDict.to_mongo()
    • AttrDict.to_pandas()
    • AttrDict.update()
    • AttrDict.values()
  • ListCollection
    • ListCollection.append()
    • ListCollection.clear()
    • ListCollection.copy()
    • ListCollection.count()
    • ListCollection.explode()
    • ListCollection.extend()
    • ListCollection.index()
    • ListCollection.insert()
    • ListCollection.pop()
    • ListCollection.remove()
    • ListCollection.reverse()
    • ListCollection.sort()
    • ListCollection.to_json()
    • ListCollection.to_list()
    • ListCollection.to_mongo()
    • ListCollection.to_pandas()
    • ListCollection.to_records()
    • ListCollection.unpack()
    • ListCollection.values()
    • ListCollection.values_list()
  • Row
    • Row.to_dict()
    • Row.fields()
    • Row.get()
    • Row.items()
    • Row.values()
    • Row.keys()
    • Row.to_json()
    • Row.to_mongo()
    • Row.to_pandas()
• XML Objects
  • Schema
    • Deserializer
    • Schema
      • Schema.load()
    • PolymorphicSchema
    • RegexSchema
    • ZipSchema
  • Fields
    • Field
    • String
    • DateTime
    • Date
    • Boolean
    • Float
    • Integer
    • Exists
    • Const
    • List
    • Dict
    • Combine
    • Alternative
    • DelimitedString
    • Nested
    • TailField
      • TailField.load()
      • TailField.deserialize()
    • Str
    • DT
    • Bool
    • Int
    • Alt
• HTML Objects
  • Schema
    • Deserializer
    • Schema
      • Schema.load()
    • PolymorphicSchema
    • RegexSchema
    • ZipSchema
  • Fields
    • Field
    • String
    • DateTime
    • Date
    • Boolean
    • Float
    • Integer
    • Exists
    • Const
    • List
    • Dict
    • Combine
    • Alternative
    • DelimitedString
    • Nested
    • TailField
      • TailField.load()
      • TailField.deserialize()
    • Str
    • DT
    • Bool
    • Int
    • Alt
• JSON Objects
  • Schema
    • Schema
      • Schema.load()
      • Schema.load_batch()
    • PolymorphicSchema
    • RegexSchema
    • ZipSchema
  • Fields
    • Field
    • String
    • DateTime
    • Date
    • Boolean
    • Float
    • Integer
    • Exists
    • Const
    • List
    • Dict
    • Combine
    • Alternative
    • DelimitedString
    • Nested
    • TailField
      • TailField.load()
      • TailField.deserialize()
    • Str
    • DT
    • Bool
    • Int
    • Alt