Skip to content

Blocks

hypha.apply.stream_forms.blocks

CHARFIELD_FORMATS module-attribute 

CHARFIELD_FORMATS = [('email', _('Email')), ('url', _('URL'))]

FormFieldBlock

Bases: StructBlock

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

field_class class-attribute instance-attribute 

field_class = forms.CharField

widget class-attribute instance-attribute 

widget = None

Meta

template class-attribute instance-attribute 
template = 'stream_forms/render_field.html'

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
54
55
56
57
58
59
60
61
62
63
64
65
def get_field_kwargs(self, struct_value):
    kwargs = {
        "label": struct_value["field_label"],
        "help_text": conditional_escape(struct_value["help_text"]),
        "required": struct_value.get("required", False),
    }
    if "default_value" in struct_value:
        kwargs["initial"] = struct_value["default_value"]
    form_widget = self.get_widget(struct_value)
    if form_widget is not None:
        kwargs["widget"] = form_widget
    return kwargs

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
106
107
def get_searchable_content(self, value, data):
    return str(data)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

OptionalFormFieldBlock

Bases: FormFieldBlock

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

field_class class-attribute instance-attribute 

field_class = forms.CharField

widget class-attribute instance-attribute 

widget = None

Meta

template class-attribute instance-attribute 
template = 'stream_forms/render_field.html'

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
54
55
56
57
58
59
60
61
62
63
64
65
def get_field_kwargs(self, struct_value):
    kwargs = {
        "label": struct_value["field_label"],
        "help_text": conditional_escape(struct_value["help_text"]),
        "required": struct_value.get("required", False),
    }
    if "default_value" in struct_value:
        kwargs["initial"] = struct_value["default_value"]
    form_widget = self.get_widget(struct_value)
    if form_widget is not None:
        kwargs["widget"] = form_widget
    return kwargs

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
106
107
def get_searchable_content(self, value, data):
    return str(data)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

CharFieldBlock

Bases: OptionalFormFieldBlock

format class-attribute instance-attribute 

format = ChoiceBlock(choices=CHARFIELD_FORMATS, required=False, label=_('Format'))

default_value class-attribute instance-attribute 

default_value = CharBlock(required=False, label=_('Default value'))

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

field_class class-attribute instance-attribute 

field_class = forms.CharField

widget class-attribute instance-attribute 

widget = None

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

label class-attribute instance-attribute 
label = _('Text field (single line)')
icon class-attribute instance-attribute 
icon = 'minus'
template class-attribute instance-attribute 
template = 'stream_forms/render_unsafe_field.html'

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
132
133
134
135
136
137
138
def get_field_class(self, struct_value):
    text_format = struct_value["format"]
    if text_format == "url":
        return forms.URLField
    if text_format == "email":
        return forms.EmailField
    return super().get_field_class(struct_value)

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
140
141
142
143
def get_searchable_content(self, value, data):
    # CharField acts as a fallback. Force data to string
    data = str(data)
    return nh3.clean(data or "", tags=set())

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
54
55
56
57
58
59
60
61
62
63
64
65
def get_field_kwargs(self, struct_value):
    kwargs = {
        "label": struct_value["field_label"],
        "help_text": conditional_escape(struct_value["help_text"]),
        "required": struct_value.get("required", False),
    }
    if "default_value" in struct_value:
        kwargs["initial"] = struct_value["default_value"]
    form_widget = self.get_widget(struct_value)
    if form_widget is not None:
        kwargs["widget"] = form_widget
    return kwargs

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

MultiInputCharFieldBlock

Bases: CharFieldBlock

number_of_inputs class-attribute instance-attribute 

number_of_inputs = IntegerBlock(default=2, label=_('Max number of inputs'))

add_button_text class-attribute instance-attribute 

add_button_text = CharBlock(required=False, default=_('Add new item'))

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

field_class class-attribute instance-attribute 

field_class = forms.CharField

widget class-attribute instance-attribute 

widget = None

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

format class-attribute instance-attribute 

format = ChoiceBlock(choices=CHARFIELD_FORMATS, required=False, label=_('Format'))

default_value class-attribute instance-attribute 

default_value = CharBlock(required=False, label=_('Default value'))

Meta

label class-attribute instance-attribute 
label = _('Text field (single line) (multiple inputs)')
icon class-attribute instance-attribute 
icon = 'bars'

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
132
133
134
135
136
137
138
def get_field_class(self, struct_value):
    text_format = struct_value["format"]
    if text_format == "url":
        return forms.URLField
    if text_format == "email":
        return forms.EmailField
    return super().get_field_class(struct_value)

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
54
55
56
57
58
59
60
61
62
63
64
65
def get_field_kwargs(self, struct_value):
    kwargs = {
        "label": struct_value["field_label"],
        "help_text": conditional_escape(struct_value["help_text"]),
        "required": struct_value.get("required", False),
    }
    if "default_value" in struct_value:
        kwargs["initial"] = struct_value["default_value"]
    form_widget = self.get_widget(struct_value)
    if form_widget is not None:
        kwargs["widget"] = form_widget
    return kwargs

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
140
141
142
143
def get_searchable_content(self, value, data):
    # CharField acts as a fallback. Force data to string
    data = str(data)
    return nh3.clean(data or "", tags=set())

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

TextFieldBlock

Bases: OptionalFormFieldBlock

default_value class-attribute instance-attribute 

default_value = TextBlock(required=False, label=_('Default value'))

word_limit class-attribute instance-attribute 

word_limit = IntegerBlock(default=1000, label=_('Word limit'))

widget class-attribute instance-attribute 

widget = forms.Textarea(attrs={'rows': 5})

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

field_class class-attribute instance-attribute 

field_class = forms.CharField

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

label class-attribute instance-attribute 
label = _('Text field (multi line)')
icon class-attribute instance-attribute 
icon = 'edit'
template class-attribute instance-attribute 
template = 'stream_forms/render_unsafe_field.html'

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
166
167
def get_searchable_content(self, value, data):
    return nh3.clean(data or "", tags=set())

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
54
55
56
57
58
59
60
61
62
63
64
65
def get_field_kwargs(self, struct_value):
    kwargs = {
        "label": struct_value["field_label"],
        "help_text": conditional_escape(struct_value["help_text"]),
        "required": struct_value.get("required", False),
    }
    if "default_value" in struct_value:
        kwargs["initial"] = struct_value["default_value"]
    form_widget = self.get_widget(struct_value)
    if form_widget is not None:
        kwargs["widget"] = form_widget
    return kwargs

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

NumberFieldBlock

Bases: OptionalFormFieldBlock

default_value class-attribute instance-attribute 

default_value = CharBlock(required=False, label=_('Default value'))

widget class-attribute instance-attribute 

widget = forms.NumberInput

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

field_class class-attribute instance-attribute 

field_class = forms.CharField

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

label class-attribute instance-attribute 
label = _('Number field')
icon class-attribute instance-attribute 
icon = 'decimal'

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
179
180
def get_searchable_content(self, value, data):
    return None

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
54
55
56
57
58
59
60
61
62
63
64
65
def get_field_kwargs(self, struct_value):
    kwargs = {
        "label": struct_value["field_label"],
        "help_text": conditional_escape(struct_value["help_text"]),
        "required": struct_value.get("required", False),
    }
    if "default_value" in struct_value:
        kwargs["initial"] = struct_value["default_value"]
    form_widget = self.get_widget(struct_value)
    if form_widget is not None:
        kwargs["widget"] = form_widget
    return kwargs

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

CheckboxFieldBlock

Bases: OptionalFormFieldBlock

default_value class-attribute instance-attribute 

default_value = BooleanBlock(required=False)

field_class class-attribute instance-attribute 

field_class = forms.BooleanField

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

widget class-attribute instance-attribute 

widget = None

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

label class-attribute instance-attribute 
label = _('Checkbox field')
icon class-attribute instance-attribute 
icon = 'tick-inverse'
template class-attribute instance-attribute 
template = 'stream_forms/render_checkbox_field.html'

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
193
194
def get_searchable_content(self, value, data):
    return None

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
196
197
def no_response(self):
    return False

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
54
55
56
57
58
59
60
61
62
63
64
65
def get_field_kwargs(self, struct_value):
    kwargs = {
        "label": struct_value["field_label"],
        "help_text": conditional_escape(struct_value["help_text"]),
        "required": struct_value.get("required", False),
    }
    if "default_value" in struct_value:
        kwargs["initial"] = struct_value["default_value"]
    form_widget = self.get_widget(struct_value)
    if form_widget is not None:
        kwargs["widget"] = form_widget
    return kwargs

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

RadioButtonsFieldBlock

Bases: OptionalFormFieldBlock

choices class-attribute instance-attribute 

choices = ListBlock(CharBlock(label=_('Choice')))

field_class class-attribute instance-attribute 

field_class = forms.ChoiceField

widget class-attribute instance-attribute 

widget = forms.RadioSelect

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

label class-attribute instance-attribute 
label = _('Radio buttons')
icon class-attribute instance-attribute 
icon = 'radio-empty'

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
210
211
212
213
def get_field_kwargs(self, struct_value):
    kwargs = super().get_field_kwargs(struct_value)
    kwargs["choices"] = [(choice, choice) for choice in struct_value["choices"]]
    return kwargs

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
106
107
def get_searchable_content(self, value, data):
    return str(data)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

GroupToggleBlock

Bases: FormFieldBlock

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), default=True, required=False)

choices class-attribute instance-attribute 

choices = ListBlock(CharBlock(label=_('Choice')), help_text=_('Please create only two choices for toggle. First choice will revel the group and the second hide it. Additional choices will be ignored.'))

field_class class-attribute instance-attribute 

field_class = forms.ChoiceField

widget class-attribute instance-attribute 

widget = forms.RadioSelect

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

Meta

label class-attribute instance-attribute 
label = _('Group fields')
icon class-attribute instance-attribute 
icon = 'group'
help_text class-attribute instance-attribute 
help_text = _('Remember to end group using Group fields end block.')

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
235
236
237
238
239
240
241
242
243
244
245
246
247
248
def get_field_kwargs(self, struct_value):
    kwargs = super().get_field_kwargs(struct_value)
    field_choices = [(choice, choice) for choice in struct_value["choices"]]
    total_choices = len(field_choices)
    if total_choices > 2:
        # For toggle we need only two choices
        field_choices = field_choices[:2]
    elif total_choices < 2:
        field_choices = [
            ("yes", _("Yes")),
            ("no", _("No")),
        ]
    kwargs["choices"] = field_choices
    return kwargs

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
106
107
def get_searchable_content(self, value, data):
    return str(data)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

GroupToggleEndBlock

Bases: StaticBlock

Meta

label class-attribute instance-attribute 
label = _('Group fields end')
icon class-attribute instance-attribute 
icon = 'group'
admin_text class-attribute instance-attribute 
admin_text = _('End of Group fields Block')

DropdownFieldBlock

Bases: RadioButtonsFieldBlock

widget class-attribute instance-attribute 

widget = forms.Select

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

field_class class-attribute instance-attribute 

field_class = forms.ChoiceField

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

choices class-attribute instance-attribute 

choices = ListBlock(CharBlock(label=_('Choice')))

Meta

label class-attribute instance-attribute 
label = _('Dropdown field')
icon class-attribute instance-attribute 
icon = 'arrow-down'

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
265
266
267
268
def get_field_kwargs(self, struct_value):
    kwargs = super().get_field_kwargs(struct_value)
    kwargs["choices"].insert(0, BLANK_CHOICE_DASH[0])
    return kwargs

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
106
107
def get_searchable_content(self, value, data):
    return str(data)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

CheckboxesFieldBlock

Bases: OptionalFormFieldBlock

checkboxes class-attribute instance-attribute 

checkboxes = ListBlock(CharBlock(label=_('Checkbox')))

field_class class-attribute instance-attribute 

field_class = forms.MultipleChoiceField

widget class-attribute instance-attribute 

widget = forms.CheckboxSelectMultiple

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

label class-attribute instance-attribute 
label = _('Multiple checkboxes field')
icon class-attribute instance-attribute 
icon = 'tasks'
template class-attribute instance-attribute 
template = 'stream_forms/render_list_field.html'

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
282
283
284
285
def get_field_kwargs(self, struct_value):
    kwargs = super().get_field_kwargs(struct_value)
    kwargs["choices"] = [(choice, choice) for choice in struct_value["checkboxes"]]
    return kwargs

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
287
288
289
290
291
def prepare_data(self, value, data, serialize=False):
    if not data:
        return data
    base_prepare = super().prepare_data
    return [base_prepare(value, item, serialize) for item in data]

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
293
294
def get_searchable_content(self, value, data):
    return data

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

DatePickerInput 

DatePickerInput(*args, **kwargs)

Bases: DateInput

Source code in hypha/apply/stream_forms/blocks.py 
298
299
300
301
302
303
304
305
306
307
308
309
def __init__(self, *args, **kwargs):
    attrs = kwargs.get("attrs")
    if attrs is None:
        attrs = {}
    attrs.update(
        {
            "data-provide": "datepicker",
            "data-date-format": "yyyy-mm-dd",
        }
    )
    kwargs["attrs"] = attrs
    super().__init__(*args, **kwargs)

DateFieldBlock

Bases: OptionalFormFieldBlock

default_value class-attribute instance-attribute 

default_value = DateBlock(required=False)

field_class class-attribute instance-attribute 

field_class = forms.DateField

widget class-attribute instance-attribute 

widget = DatePickerInput

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

label class-attribute instance-attribute 
label = _('Date field')
icon class-attribute instance-attribute 
icon = 'date'

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
322
323
def get_searchable_content(self, value, data):
    return None

decode 

decode(value)
Source code in hypha/apply/stream_forms/blocks.py 
325
326
327
def decode(self, value):
    if value:
        return parse(value).date()

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
54
55
56
57
58
59
60
61
62
63
64
65
def get_field_kwargs(self, struct_value):
    kwargs = {
        "label": struct_value["field_label"],
        "help_text": conditional_escape(struct_value["help_text"]),
        "required": struct_value.get("required", False),
    }
    if "default_value" in struct_value:
        kwargs["initial"] = struct_value["default_value"]
    form_widget = self.get_widget(struct_value)
    if form_widget is not None:
        kwargs["widget"] = form_widget
    return kwargs

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

HTML5TimeInput

Bases: TimeInput

input_type class-attribute instance-attribute 

input_type = 'time'

TimeFieldBlock

Bases: OptionalFormFieldBlock

default_value class-attribute instance-attribute 

default_value = TimeBlock(required=False)

field_class class-attribute instance-attribute 

field_class = forms.TimeField

widget class-attribute instance-attribute 

widget = HTML5TimeInput

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

label class-attribute instance-attribute 
label = _('Time field')
icon class-attribute instance-attribute 
icon = 'time'

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
344
345
def get_searchable_content(self, value, data):
    return None

decode 

decode(value)
Source code in hypha/apply/stream_forms/blocks.py 
347
348
349
def decode(self, value):
    if value:
        return parse(value).time()

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
54
55
56
57
58
59
60
61
62
63
64
65
def get_field_kwargs(self, struct_value):
    kwargs = {
        "label": struct_value["field_label"],
        "help_text": conditional_escape(struct_value["help_text"]),
        "required": struct_value.get("required", False),
    }
    if "default_value" in struct_value:
        kwargs["initial"] = struct_value["default_value"]
    form_widget = self.get_widget(struct_value)
    if form_widget is not None:
        kwargs["widget"] = form_widget
    return kwargs

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

DateTimePickerInput 

DateTimePickerInput(attrs=None, date_format=None, time_format=None)

Bases: SplitDateTimeWidget

Source code in hypha/apply/stream_forms/blocks.py 
353
354
355
356
357
358
def __init__(self, attrs=None, date_format=None, time_format=None):
    super().__init__(attrs=attrs, date_format=date_format, time_format=time_format)
    self.widgets = (
        DatePickerInput(attrs=attrs, format=date_format),
        HTML5TimeInput(attrs=attrs, format=time_format),
    )

widgets instance-attribute 

widgets = (DatePickerInput(attrs=attrs, format=date_format), HTML5TimeInput(attrs=attrs, format=time_format))

decompress 

decompress(value)
Source code in hypha/apply/stream_forms/blocks.py 
360
361
362
363
def decompress(self, value):
    if isinstance(value, str):
        value = parse_datetime(value)
    return super().decompress(value)

DateTimeFieldBlock

Bases: OptionalFormFieldBlock

default_value class-attribute instance-attribute 

default_value = DateTimeBlock(required=False)

field_class class-attribute instance-attribute 

field_class = forms.SplitDateTimeField

widget class-attribute instance-attribute 

widget = DateTimePickerInput

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

label class-attribute instance-attribute 
label = _('Date+time field')
icon class-attribute instance-attribute 
icon = 'date'

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
376
377
def get_searchable_content(self, value, data):
    return None

decode 

decode(value)
Source code in hypha/apply/stream_forms/blocks.py 
379
380
381
def decode(self, value):
    if value:
        return isoparse(value)

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
54
55
56
57
58
59
60
61
62
63
64
65
def get_field_kwargs(self, struct_value):
    kwargs = {
        "label": struct_value["field_label"],
        "help_text": conditional_escape(struct_value["help_text"]),
        "required": struct_value.get("required", False),
    }
    if "default_value" in struct_value:
        kwargs["initial"] = struct_value["default_value"]
    form_widget = self.get_widget(struct_value)
    if form_widget is not None:
        kwargs["widget"] = form_widget
    return kwargs

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize=False)
Source code in hypha/apply/stream_forms/blocks.py 
90
91
def prepare_data(self, value, data, serialize=False):
    return nh3_value(str(data))

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

UploadableMediaBlock

Bases: OptionalFormFieldBlock

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

field_class class-attribute instance-attribute 

field_class = forms.CharField

widget class-attribute instance-attribute 

widget = None

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

template class-attribute instance-attribute 
template = 'stream_forms/render_file_field.html'

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
388
389
def get_searchable_content(self, value, data):
    return None

prepare_data 

prepare_data(value, data, serialize)
Source code in hypha/apply/stream_forms/blocks.py 
391
392
393
394
395
396
397
def prepare_data(self, value, data, serialize):
    if serialize:
        if data:
            return data.serialize()
        return None

    return data

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
54
55
56
57
58
59
60
61
62
63
64
65
def get_field_kwargs(self, struct_value):
    kwargs = {
        "label": struct_value["field_label"],
        "help_text": conditional_escape(struct_value["help_text"]),
        "required": struct_value.get("required", False),
    }
    if "default_value" in struct_value:
        kwargs["initial"] = struct_value["default_value"]
    form_widget = self.get_widget(struct_value)
    if form_widget is not None:
        kwargs["widget"] = form_widget
    return kwargs

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

ImageFieldBlock

Bases: UploadableMediaBlock

field_class class-attribute instance-attribute 

field_class = forms.ImageField

widget class-attribute instance-attribute 

widget = ClearableFileInput

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

label class-attribute instance-attribute 
label = _('Image field')
icon class-attribute instance-attribute 
icon = 'image'

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
54
55
56
57
58
59
60
61
62
63
64
65
def get_field_kwargs(self, struct_value):
    kwargs = {
        "label": struct_value["field_label"],
        "help_text": conditional_escape(struct_value["help_text"]),
        "required": struct_value.get("required", False),
    }
    if "default_value" in struct_value:
        kwargs["initial"] = struct_value["default_value"]
    form_widget = self.get_widget(struct_value)
    if form_widget is not None:
        kwargs["widget"] = form_widget
    return kwargs

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize)
Source code in hypha/apply/stream_forms/blocks.py 
391
392
393
394
395
396
397
def prepare_data(self, value, data, serialize):
    if serialize:
        if data:
            return data.serialize()
        return None

    return data

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
388
389
def get_searchable_content(self, value, data):
    return None

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

FileFieldBlock

Bases: UploadableMediaBlock

This doesn't know how to save the uploaded files

You must implement this if you want to reuse it.

field_class class-attribute instance-attribute 

field_class = SingleFileField

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

widget class-attribute instance-attribute 

widget = None

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

label class-attribute instance-attribute 
label = _('Single File field')
icon class-attribute instance-attribute 
icon = 'download'

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
421
422
423
424
425
426
427
428
429
def get_field_kwargs(self, struct_value):
    kwargs = super().get_field_kwargs(struct_value)
    kwargs["help_text"] = mark_safe(
        _("{help_text} Accepted file types are {file_types}").format(
            help_text=kwargs["help_text"],
            file_types=settings.FILE_ACCEPT_ATTR_VALUE,
        )
    )
    return kwargs

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

prepare_data 

prepare_data(value, data, serialize)
Source code in hypha/apply/stream_forms/blocks.py 
391
392
393
394
395
396
397
def prepare_data(self, value, data, serialize):
    if serialize:
        if data:
            return data.serialize()
        return None

    return data

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
388
389
def get_searchable_content(self, value, data):
    return None

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
109
110
def no_response(self):
    return "-"

MultiFileFieldBlock

Bases: UploadableMediaBlock

field_class class-attribute instance-attribute 

field_class = MultiFileField

field_label class-attribute instance-attribute 

field_label = CharBlock(label=_('Label'))

help_text class-attribute instance-attribute 

help_text = RichTextBlock(required=False, label=_('Help text'))

widget class-attribute instance-attribute 

widget = None

required class-attribute instance-attribute 

required = BooleanBlock(label=_('Required'), required=False)

Meta

icon class-attribute instance-attribute 
icon = 'download'
label class-attribute instance-attribute 
label = _('Multiple File field')
template class-attribute instance-attribute 
template = 'stream_forms/render_multi_file_field.html'

get_field_kwargs 

get_field_kwargs(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
440
441
442
443
444
445
446
447
448
def get_field_kwargs(self, struct_value):
    kwargs = super().get_field_kwargs(struct_value)
    kwargs["help_text"] = mark_safe(
        _("{help_text} Accepted file types are {file_types}").format(
            help_text=kwargs["help_text"],
            file_types=settings.FILE_ACCEPT_ATTR_VALUE,
        )
    )
    return kwargs

prepare_data 

prepare_data(value, data, serialize)
Source code in hypha/apply/stream_forms/blocks.py 
450
451
452
453
454
455
def prepare_data(self, value, data, serialize):
    if serialize:
        if data:
            return [file.serialize() for file in data]
        return None
    return data

no_response 

no_response()
Source code in hypha/apply/stream_forms/blocks.py 
457
458
def no_response(self):
    return [super().no_response()]

get_slug 

get_slug(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
45
46
def get_slug(self, struct_value):
    return force_str(slugify(anyascii(struct_value["field_label"])))

get_field_class 

get_field_class(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
48
49
def get_field_class(self, struct_value):
    return self.field_class

get_widget 

get_widget(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
51
52
def get_widget(self, struct_value):
    return self.widget

get_field 

get_field(struct_value)
Source code in hypha/apply/stream_forms/blocks.py 
67
68
69
def get_field(self, struct_value):
    field_kwargs = self.get_field_kwargs(struct_value)
    return self.get_field_class(struct_value)(**field_kwargs)

decode 

decode(value)

Convert JSON representation into actual python objects

Source code in hypha/apply/stream_forms/blocks.py 
71
72
73
def decode(self, value):
    """Convert JSON representation into actual python objects"""
    return value

serialize 

serialize(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
75
76
77
78
79
80
81
def serialize(self, value, context):
    field_kwargs = self.get_field_kwargs(value)
    return {
        "question": field_kwargs["label"],
        "answer": context.get("data"),
        "type": self.name,
    }

serialize_no_response 

serialize_no_response(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
83
84
85
86
87
88
def serialize_no_response(self, value, context):
    return {
        "question": value["field_label"],
        "answer": "-",
        "type": "no_response",
    }

render 

render(value, context)
Source code in hypha/apply/stream_forms/blocks.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def render(self, value, context):
    data = context.get("data")
    data = self.prepare_data(value, data, context.get("serialize", False))

    context.update(data=data or self.no_response())

    if context.get("serialize"):
        if not data:
            return self.serialize_no_response(value, context)
        return self.serialize(value, context)

    return super().render(value, context)

get_searchable_content 

get_searchable_content(value, data)
Source code in hypha/apply/stream_forms/blocks.py 
388
389
def get_searchable_content(self, value, data):
    return None

HeadingBlock

Bases: StructBlock

HEADER_SIZE class-attribute instance-attribute 

HEADER_SIZE = [('h2', 'H2'), ('h3', 'H3'), ('h4', 'H4')]

heading_text class-attribute instance-attribute 

heading_text = CharBlock(classname='title', required=True)

size class-attribute instance-attribute 

size = ChoiceBlock(choices=HEADER_SIZE, default='h2')

Meta

icon class-attribute instance-attribute 
icon = 'title'
template class-attribute instance-attribute 
template = 'stream_forms/heading_field.html'

FormFieldsBlock

Bases: StreamBlock

text_markup class-attribute instance-attribute 

text_markup = RichTextBlock(group=_('Custom'), label=_('Paragraph'))

header_markup class-attribute instance-attribute 

header_markup = HeadingBlock(group=_('Custom'), label=_('Section header'))

char class-attribute instance-attribute 

char = CharFieldBlock(group=_('Fields'))

multi_inputs_char class-attribute instance-attribute 

multi_inputs_char = MultiInputCharFieldBlock(group=_('Fields'))

text class-attribute instance-attribute 

text = TextFieldBlock(group=_('Fields'))

number class-attribute instance-attribute 

number = NumberFieldBlock(group=_('Fields'))

checkbox class-attribute instance-attribute 

checkbox = CheckboxFieldBlock(group=_('Fields'))

radios class-attribute instance-attribute 

radios = RadioButtonsFieldBlock(group=_('Fields'))

dropdown class-attribute instance-attribute 

dropdown = DropdownFieldBlock(group=_('Fields'))

checkboxes class-attribute instance-attribute 

checkboxes = CheckboxesFieldBlock(group=_('Fields'))

date class-attribute instance-attribute 

date = DateFieldBlock(group=_('Fields'))

time class-attribute instance-attribute 

time = TimeFieldBlock(group=_('Fields'))

datetime class-attribute instance-attribute 

datetime = DateTimeFieldBlock(group=_('Fields'))

image class-attribute instance-attribute 

image = ImageFieldBlock(group=_('Fields'))

file class-attribute instance-attribute 

file = FileFieldBlock(group=_('Fields'))

multi_file class-attribute instance-attribute 

multi_file = MultiFileFieldBlock(group=_('Fields'))

group_toggle class-attribute instance-attribute 

group_toggle = GroupToggleBlock(group=_('Custom'))

group_toggle_end class-attribute instance-attribute 

group_toggle_end = GroupToggleEndBlock(group=_('Custom'))

Meta

label class-attribute instance-attribute 
label = _('Form fields')