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

Public Member Functions

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 output (self, key, obj, **kwargs)
 
def __schema__ (self)
 

Data Fields

 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

Marshal a value as a string. Uses ``six.text_type`` so values will
be converted to :class:`unicode` in python2 and :class:`str` in
python3.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
args,
**  kwargs 
)

Reimplemented from StringMixin.

Member Function Documentation

◆ format()

def format (   self,
  value 
)
Formats a field's value. No-op by default - field classes that
modify how the value of existing object keys should be presented should
override this and apply the appropriate formatting.

:param value: The value to format
:raises MarshallingError: In case of formatting problem

Ex::

    class TitleCase(Raw):
def format(self, value):
    return unicode(value).title()

Reimplemented from Raw.

◆ schema()

def schema (   self)

Reimplemented from Raw.

Field Documentation

◆ discriminator

discriminator

◆ enum

enum

◆ required

required

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