Skip to main content
Ctrl+K

Oblate 1.2.1 documentation

  • Tutorial
  • User Guide
  • API Reference
  • Changelog
  • GitHub
  • Tutorial
  • User Guide
  • API Reference
  • Changelog
  • GitHub

Section Navigation

  • Schemas
  • Fields
  • Validators
  • Configuration
  • Error Handling
  • Contexts
  • Type Validation
  • User Guide

User Guide#

This section contains guides and tutorials for various features of the library. Unlike the main API reference, this section covers the topics in a much easy to understand and friendly way.

If you’re looking for a quickstart tutorial, check the Tutorial section.

  • Schemas
    • Introduction
    • Schema Context
    • Inheriting Schemas
    • Updating schema
    • Serializing schema
    • Preprocessing data
    • Schema State
    • Slotted Schemas
    • Representation of schema
    • Frozen Schemas
    • Passing unknown fields
    • Hooks
    • Operations after initialization
  • Fields
    • Defining fields
    • Optional fields and defaults
    • Noneable (nullable) fields
    • Strict Mode
    • Frozen Fields
    • Extra Metadata
    • Custom Fields
    • Custom data keys
    • Nested schemas
    • Typing fields
    • Data Structures Fields
  • Validators
    • Defining validators
    • Raw Validators
    • Class-based validators
    • Prebuilt Validators
  • Configuration
    • Schema configuration
    • Global configuration
    • More information
  • Error Handling
    • Introduction
    • ValidationError and FieldError
    • User side errors
    • Error formatting
    • Raw error formatting
    • Attaching arbitrary state
    • Custom error messages
  • Contexts
    • Introduction
    • Schema Context
    • Field Contexts
    • Error Context
    • Context States
  • Type Validation
    • Type validation example
    • Supported types and limitations

previous

Validators

next

Schemas

Show Source

© Copyright 2023, Izhar Ahmad (izxxr).

Created using Sphinx 7.2.6.

Built with the PyData Sphinx Theme 0.15.2.