Forms

Your code needs to be in a file named forms.py or folder named forms inside your Application.

File or Folder Layout

File Folder

root/
|
|--  apps/
|    `--  MY_APP/
|         `-- forms.py            --> <File> - Your code in HERE!
|
`-- etc...

root/
|
|--  apps/
|    `--  MY_APP/
|         `-- forms/              --> <Directory> - Your Forms in HERE!
|             |-- __init__.py     --> <File> - Your IMPORTS in HERE!
|             `-- etc...
|
`-- etc...

Tools

Fastberry input-values can only have a Single Typing. You'll mainly use 3 tools to create the forms.

1. fastberry.input(str)
2. fastberry.value
3. fastberry.filters(regex = list(tuple), rules = list(function))

Value References

Name	API Reference
default	The default value
required	Default: False. Does the field requires an input value?
regex	Regex (validators) key = Regex-Pattern and value = Error-Message
rules	Custom (validators) returns None or Error-Message(s)
filters	Transform-Data with Regex & Rules

Python Code

Tip

Values can only have a Single Type.

However, you can wrap it around a list for example: list[int]

File Folder

forms.py

# -*- coding: utf-8 -*-
"""
    Forms - Complex Inputs
"""
import fastberry as fb

# Create Group "Form"
form = fb.input("form")

# Create your <forms> here.

@form  # (name="CustonInputName")
class Search:
    """(Form) Read The Docs"""

    name = fb.value(
        # Single Typing
        str,
        default=None,
        required=True,
    )
    count = fb.value(
        int,
        default=999,
    )
    cash = fb.value(
        float,
        default=44.4,
    )
    amount = fb.value(
        fb.decimal,
        default="55.5",
    )
    start_date = fb.value(
        fb.date,
        default="2022-11-10",
    )
    end_datetime = fb.value(
        fb.datetime,
        default="2022-11-10T16:35:56.216344",
    )
    timestamp = fb.value(
        fb.time,
        default="16:35:04.872130",
    )


@form
class User:
    """(Complex-Form) Read The Docs"""

    email = fb.value(
        str,
        default="demo@helloworld.com",
        regex={
            r"[\w\.-]+@[\w\.-]+": "invalid email address"
        },
        rules=[
            (lambda v: v.startswith("demo") or "invalid input")
        ],
        filters=fb.filters(
            regex=[
                ("^hello", "hola"),
                ("com", "api"),
            ],  # ("^hello"...) [Won't Work]: We used { regex } to check if it startswith "hello".
            rules=[
                (lambda v: v.upper())
            ],
        ),
    )

__init__.py

# -*- coding: utf-8 -*-
"""
    Forms - Init
"""

# Import your <cruds> here.
from .demo import Search, User

demo.py

# -*- coding: utf-8 -*-
"""
    API - Complex Inputs
"""

# Fastberry
import fastberry as fb

# Create Group "Form"
form = fb.input("form")

# Create your API (GraphQL) here.

@form  # (name="CustonInputName")
class Search:
    """(Form) Read The Docs"""

    name = fb.value(
        str,  # Single Typing
        default=None,
    )
    count = fb.value(
        int,
        default=None,
    )
    cash = fb.value(
        float,
        default=None,
    )
    amount = fb.value(
        fb.decimal,
        default=None,
    )
    start_date = fb.value(
        fb.date,
        default=None,
    )
    end_datetime = fb.value(
        fb.datetime,
        default=None,
    )
    timestamp = fb.value(
        fb.time,
        default=None,
        required=True,
    )

@form
class User:
    """(Complex-Form) Read The Docs"""

    email = fb.value(
        str,
        default="demo@helloworld.com",
        regex={r"[\w\.-]+@[\w\.-]+": "invalid email address"},
        rules=[(lambda v: v.startswith("demo") or "invalid input")],
        filters=fb.filters(
            regex=[
                ("^hello", "hola"),
                ("com", "api"),
            ],  # ("^hello"...) [Doesn't Work]: We used { regex } to check if it startswith "hello".
            rules=[(lambda v: v.upper())],
        ),
    )