Skip to content

Factories

hypha.apply.stream_forms.testing.factories

NON_FILE_BLOCK_FACTORY_DEFINITION module-attribute 

NON_FILE_BLOCK_FACTORY_DEFINITION = {'text_markup': factory.SubFactory(ParagraphBlockFactory), 'char': factory.SubFactory(CharFieldBlockFactory), 'text': factory.SubFactory(TextFieldBlockFactory), 'number': factory.SubFactory(NumberFieldBlockFactory), 'checkbox': factory.SubFactory(CheckboxFieldBlockFactory), 'radios': factory.SubFactory(RadioFieldBlockFactory), 'dropdown': factory.SubFactory(DropdownFieldBlockFactory), 'checkboxes': factory.SubFactory(CheckboxesFieldBlockFactory), 'date': factory.SubFactory(DateFieldBlockFactory), 'time': factory.SubFactory(TimeFieldBlockFactory), 'datetime': factory.SubFactory(DateTimeFieldBlockFactory)}

BLOCK_FACTORY_DEFINITION module-attribute 

BLOCK_FACTORY_DEFINITION = {**NON_FILE_BLOCK_FACTORY_DEFINITION, 'image': factory.SubFactory(ImageFieldBlockFactory), 'file': factory.SubFactory(FileFieldBlockFactory), 'multi_file': factory.SubFactory(MultiFileFieldBlockFactory)}

NonFileFormFieldsBlockFactory module-attribute 

NonFileFormFieldsBlockFactory = StreamFieldUUIDFactory(NON_FILE_BLOCK_FACTORY_DEFINITION)

FormFieldsBlockFactory module-attribute 

FormFieldsBlockFactory = StreamFieldUUIDFactory(BLOCK_FACTORY_DEFINITION)

AnswerFactory

Bases: Factory

AddFormFieldsMetaclass

Bases: FactoryMetaClass

FormDataFactory

Bases: Factory

ParagraphBlockFactory

Bases: BlockFactory

Meta

model class-attribute instance-attribute 
model = RichTextBlock

FormFieldBlockFactory

Bases: StructBlockFactory

default_value class-attribute instance-attribute 

default_value = factory.Faker('sentence')

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.FormFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
125
126
127
128
@classmethod
def make_answer(cls, params=None):
    params = params or {}
    return cls.default_value.evaluate(None, None, dict(params, locale=None))

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

CharFieldBlockFactory

Bases: FormFieldBlockFactory

default_value class-attribute instance-attribute 

default_value = factory.Faker('sentence')

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.CharFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
125
126
127
128
@classmethod
def make_answer(cls, params=None):
    params = params or {}
    return cls.default_value.evaluate(None, None, dict(params, locale=None))

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

TextFieldBlockFactory

Bases: FormFieldBlockFactory

default_value class-attribute instance-attribute 

default_value = factory.Faker('sentence')

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.TextFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
125
126
127
128
@classmethod
def make_answer(cls, params=None):
    params = params or {}
    return cls.default_value.evaluate(None, None, dict(params, locale=None))

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

DateFieldBlockFactory

Bases: FormFieldBlockFactory

default_value class-attribute instance-attribute 

default_value = factory.Faker('date_object')

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.DateFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
125
126
127
128
@classmethod
def make_answer(cls, params=None):
    params = params or {}
    return cls.default_value.evaluate(None, None, dict(params, locale=None))

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

TimeFieldBlockFactory

Bases: FormFieldBlockFactory

default_value class-attribute instance-attribute 

default_value = factory.LazyFunction(lambda: factory.Faker('time_object').evaluate(None, None, {'locale': None}).replace(microsecond=0))

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.TimeFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
125
126
127
128
@classmethod
def make_answer(cls, params=None):
    params = params or {}
    return cls.default_value.evaluate(None, None, dict(params, locale=None))

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

DateTimeFieldBlockFactory

Bases: FormFieldBlockFactory

default_value class-attribute instance-attribute 

default_value = factory.LazyFunction(lambda: factory.Faker('date_time').evaluate(None, None, {'locale': None}).replace(microsecond=0))

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.DateTimeFieldBlock

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
183
184
185
186
187
188
189
190
191
192
@classmethod
def make_form_answer(cls, params=None):
    if params:
        date_time = params
    else:
        date_time = super().make_form_answer(params)
    return {
        "date": str(date_time.date()),
        "time": str(date_time.time().replace(microsecond=0)),
    }

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
125
126
127
128
@classmethod
def make_answer(cls, params=None):
    params = params or {}
    return cls.default_value.evaluate(None, None, dict(params, locale=None))

NumberFieldBlockFactory

Bases: FormFieldBlockFactory

default_value class-attribute instance-attribute 

default_value = 100

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.NumberFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
201
202
203
@classmethod
def make_answer(cls, params=None):
    return cls.default_value

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

CheckboxFieldBlockFactory

Bases: FormFieldBlockFactory

choices class-attribute instance-attribute 

choices = ['check_one', 'check_two']

default_value class-attribute instance-attribute 

default_value = factory.Faker('sentence')

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.CheckboxFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
212
213
214
@classmethod
def make_answer(cls, params=None):
    return cls.choices[0]

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

CheckboxesFieldBlockFactory

Bases: FormFieldBlockFactory

checkboxes class-attribute instance-attribute 

checkboxes = ['check_multiple_one', 'check_multiple_two', 'check_multiple_three']

default_value class-attribute instance-attribute 

default_value = factory.Faker('sentence')

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.CheckboxesFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
223
224
225
@classmethod
def make_answer(cls, params=None):
    return cls.checkboxes[0:2]

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

RadioFieldBlockFactory

Bases: FormFieldBlockFactory

choices class-attribute instance-attribute 

choices = ['first', 'second']

default_value class-attribute instance-attribute 

default_value = factory.Faker('sentence')

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.RadioButtonsFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
234
235
236
@classmethod
def make_answer(cls, params=None):
    return cls.choices[0]

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

DropdownFieldBlockFactory

Bases: FormFieldBlockFactory

choices class-attribute instance-attribute 

choices = ['first', 'second']

default_value class-attribute instance-attribute 

default_value = factory.Faker('sentence')

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.DropdownFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
245
246
247
@classmethod
def make_answer(cls, params=None):
    return cls.choices[0]

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

UploadedFile 

UploadedFile(name, content, content_type=...)

Bases: SimpleUploadedFile

Utilized to make functionality closer to that of StreamFieldFile

Requires a filename attribute which is pulled from the existing _name

Source code in hypha/apply/stream_forms/testing/factories.py 
256
257
258
def __init__(self, name, content, content_type=...):
    super().__init__(name, content, content_type)
    self.filename = self._name

filename instance-attribute 

filename = self._name

UploadableMediaFactory

Bases: FormFieldBlockFactory

default_value class-attribute instance-attribute 

default_value = factory.django.FileField()

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.FormFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
264
265
266
267
268
269
270
271
@classmethod
def make_answer(cls, params=None):
    params = params or {}
    params.setdefault("data", b"this is some content")
    if params.get("filename") is None:
        params["filename"] = "test_example.pdf"
    file_name, file = cls.default_value._make_content(params)
    return UploadedFile(file_name, file.read())

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

ImageFieldBlockFactory

Bases: UploadableMediaFactory

default_value class-attribute instance-attribute 

default_value = factory.django.ImageField()

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.ImageFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
264
265
266
267
268
269
270
271
@classmethod
def make_answer(cls, params=None):
    params = params or {}
    params.setdefault("data", b"this is some content")
    if params.get("filename") is None:
        params["filename"] = "test_example.pdf"
    file_name, file = cls.default_value._make_content(params)
    return UploadedFile(file_name, file.read())

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

FileFieldBlockFactory

Bases: UploadableMediaFactory

default_value class-attribute instance-attribute 

default_value = factory.django.FileField()

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.FileFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
264
265
266
267
268
269
270
271
@classmethod
def make_answer(cls, params=None):
    params = params or {}
    params.setdefault("data", b"this is some content")
    if params.get("filename") is None:
        params["filename"] = "test_example.pdf"
    file_name, file = cls.default_value._make_content(params)
    return UploadedFile(file_name, file.read())

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

MultiFileFieldBlockFactory

Bases: UploadableMediaFactory

default_value class-attribute instance-attribute 

default_value = factory.django.FileField()

field_label class-attribute instance-attribute 

field_label = factory.Faker('sentence')

help_text class-attribute instance-attribute 

help_text = factory.LazyAttribute(lambda o: RichText(f'Help text for {o._Resolver__step.builder.factory_meta.model.__name__}'))

Meta

model class-attribute instance-attribute 
model = stream_blocks.MultiFileFieldBlock

make_answer classmethod 

make_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
290
291
292
@classmethod
def make_answer(cls, params=None):
    return [UploadableMediaFactory.make_answer() for _ in range(2)]

make_form_answer classmethod 

make_form_answer(params=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
130
131
132
133
134
@classmethod
def make_form_answer(cls, params=None):
    if params:
        return params
    return cls.make_answer(params or {})

StreamFieldDataEncoder

Bases: DjangoJSONEncoder

default 

default(o)
Source code in hypha/apply/stream_forms/testing/factories.py 
296
297
298
299
300
301
302
def default(self, o):
    if isinstance(o, File):
        return {
            "name": o.name,
            "filename": o.filename,
        }
    return super().default(o)

StreamFieldUUIDFactory

Bases: StreamFieldFactory

evaluate 

evaluate(instance, step, extra)
Source code in hypha/apply/stream_forms/testing/factories.py 
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
def evaluate(self, instance, step, extra):
    params = self.build_form(extra)
    blocks = super().evaluate(instance, step, params)
    ret_val = []
    factories = {
        k: v.get_factory()
        for k, v in self.stream_block_factory.__dict__.items()
        if isinstance(v, factory.SubFactory)
    }
    # Convert to JSON so we can add id before create
    for block_name, value in blocks:
        block = factories[block_name]._meta.model()

        value = block.get_prep_value(self.filtered_child_block_value(block, value))
        ret_val.append(
            {"type": block_name, "value": value, "id": str(uuid.uuid4())}
        )
    return json.dumps(ret_val, cls=DjangoJSONEncoder)

build_form 

build_form(data)
Source code in hypha/apply/stream_forms/testing/factories.py 
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
def build_form(self, data):
    extras = defaultdict(dict)
    exclusions = []
    multiples = {}
    for field, value in data.items():
        # we dont care about position
        name, attr = field.split("__")
        if name == "exclude":
            exclusions.append(attr)
        elif name == "multiple":
            multiples[attr] = value
        else:
            extras[name] = {attr: value}

    defined_both = set(exclusions) & set(multiples)
    if defined_both:
        raise ValueError(
            "Cant exclude and provide multiple at the same time: {}".format(
                ", ".join(defined_both)
            )
        )

    form_fields = {}
    field_count = 0
    stream_blocks = {
        k: v.get_factory()
        for k, v in self.stream_block_factory.__dict__.items()
        if isinstance(v, factory.SubFactory)
    }
    for field in stream_blocks:
        if field == "text_markup" or field in exclusions or not field:
            pass
        else:
            for _ in range(multiples.get(field, 1)):
                form_fields[f"{field_count}__{field}__"] = ""
                field_count += 1
        if extras[field]:
            for attr, value in extras[field].items():
                form_fields[f"{field_count}__{field}__{attr}"] = value
            field_count += 1

    return form_fields

filtered_child_block_value 

filtered_child_block_value(block, value)
Source code in hypha/apply/stream_forms/testing/factories.py 
368
369
370
371
372
373
374
def filtered_child_block_value(self, block, value):
    filtered_value = value
    if isinstance(value, StructValue):
        filtered_value = {
            key: val for key, val in value.items() if key in block.child_blocks
        }
    return filtered_value

form_response 

form_response(fields, field_values=None)
Source code in hypha/apply/stream_forms/testing/factories.py 
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
def form_response(self, fields, field_values=None):
    if not field_values:
        field_values = {}
    stream_blocks = {
        k: v.get_factory()
        for k, v in self.stream_block_factory.__dict__.items()
        if isinstance(v, factory.SubFactory)
    }
    data = {
        field.id: stream_blocks[field.block.name].make_form_answer(
            field_values.get(field.id, {})
        )
        for field in fields
        if hasattr(stream_blocks[field.block.name], "make_form_answer")
    }
    return flatten_for_form(data)

flatten_for_form 

flatten_for_form(data, field_name='', number=False)
Source code in hypha/apply/stream_forms/testing/factories.py 
423
424
425
426
427
428
429
430
431
432
def flatten_for_form(data, field_name="", number=False):
    result = {}
    for i, (field, value) in enumerate(data.items()):
        if number:
            field = f"{field_name}_{i}"
        if isinstance(value, dict):
            result.update(**flatten_for_form(value, field_name=field, number=True))
        else:
            result[field] = value
    return result