OpenQuizz
Une application de gestion des contenus pédagogiques
ClassName Class Reference
Inheritance diagram for ClassName:
Collaboration diagram for ClassName:

Public Member Functions

def __init__ (self, dash=False, **kwargs)
 
def output (self, key, obj, **kwargs)
 
- Public Member Functions inherited from String
def __init__ (self, *args, **kwargs)
 
def format (self, value)
 
def schema (self)
 
- Public Member Functions inherited from Raw
def __init__ (self, default=None, attribute=None, title=None, description=None, required=None, readonly=None, example=None, mask=None, **kwargs)
 
def __schema__ (self)
 

Data Fields

 dash
 
- Data Fields inherited from String
 enum
 
 discriminator
 
 required
 
- Data Fields inherited from StringMixin
 min_length
 
 max_length
 
 pattern
 
- Data Fields inherited from Raw
 attribute
 
 default
 
 title
 
 description
 
 required
 
 readonly
 
 example
 
 mask
 

Detailed Description

Return the serialized object class name as string.

:param bool dash: If `True`, transform CamelCase to kebab_case.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  dash = False,
**  kwargs 
)

Member Function Documentation

◆ output()

def output (   self,
  key,
  obj,
**  kwargs 
)
Pulls the value for the given key from the object, applies the
field's formatting and returns the result. If the key is not found
in the object, returns the default value. Field classes that create
values which do not require the existence of the key in the object
should override this and return the desired value.

:raises MarshallingError: In case of formatting problem

Reimplemented from Raw.

Field Documentation

◆ dash

dash

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