Runtype

Modules

  • Validation (isa & issubclass)
    • Functions
      • isa()
      • ensure_isa()
      • assert_isa()
      • issubclass()
      • is_subtype()
    • Element-wise validation
    • How does it work?
  • Dataclass
    • Decorator
      • dataclass()
    • Added methods
      • replace()
      • astuple()
      • aslist()
      • json()
    • Configuration
      • Configuration
        • Configuration.on_default()
        • Configuration.ensure_isa()
        • Configuration.cast()
      • PythonConfiguration
    • Casting
    • Sampling
    • Performance
      • Compared to Pydantic
  • Dispatch
    • What is multiple-dispatch?
    • Runtype’s dispatcher
    • Basic Use
    • Decorator
      • multidispatch()
      • Dispatch()
      • MultiDispatch
      • DispatchError
    • Specificity
    • Ambiguity in Dispatch
    • MyPy support
    • Performance
    • Limitations
  • Type Classes
    • Types
      • Type
      • AnyType
      • DataType
      • SumType
      • ProductType
      • ContainerType
      • GenericType
      • PhantomType
      • PhantomGenericType
      • Validator
        • Validator.validate_instance()
        • Validator.test_instance()
      • Constraint

Overview

  • Typing support
  • Benchmarks
    • Validation (isinstance)
    • Dispatch
Runtype
  • Index

Index

A | C | D | E | G | I | J | M | O | P | R | S | T | V

A

  • AnyType (class in runtype.base_types)
  • aslist() (in module runtype.dataclass)
  • assert_isa() (in module runtype.validation)
  • astuple() (in module runtype.dataclass)

C

  • cast() (runtype.dataclass.Configuration method)
  • Configuration (class in runtype.dataclass)
  • Constraint (class in runtype.base_types)
  • ContainerType (class in runtype.base_types)

D

  • dataclass() (in module runtype.dataclass)
  • DataType (class in runtype.base_types)
  • Dispatch() (in module runtype)
  • DispatchError (class in runtype.dispatch)

E

  • ensure_isa() (in module runtype.validation)
    • (runtype.dataclass.Configuration method)

G

  • GenericType (class in runtype.base_types)

I

  • is_subtype() (in module runtype.validation)
  • isa() (in module runtype.validation)
  • issubclass() (in module runtype.validation)

J

  • json() (in module runtype.dataclass)

M

  • MultiDispatch (class in runtype.dispatch)
  • multidispatch() (in module runtype)

O

  • on_default() (runtype.dataclass.Configuration method)

P

  • PhantomGenericType (class in runtype.base_types)
  • PhantomType (class in runtype.base_types)
  • ProductType (class in runtype.base_types)
  • PythonConfiguration (class in runtype.dataclass)

R

  • replace() (in module runtype.dataclass)

S

  • SumType (class in runtype.base_types)

T

  • test_instance() (runtype.base_types.Validator method)
  • Type (class in runtype.base_types)

V

  • validate_instance() (runtype.base_types.Validator method)
  • Validator (class in runtype.base_types)

© Copyright 2020, Erez Shinan.

Built with Sphinx using a theme provided by Read the Docs.