Last edited 2023-10-15 16:12:07.740465+00:00
view.py allows you to return three things from a route: the body, the headers, and the status code.
You can simply return these via a tuple:
@app.get("/")
async def index():
return "you are not worthy", 400, {"x-worthiness": "0"}
In fact, it can be in any order you want:
@app.get("/")
async def index():
return {"x-worthiness": "0"}, "you are not worthy", 400
Note: The entirety of this documentation will use the async def notation for routes, but synchronous routes work just fine:
@app.get("/")
def index():
return "i am not async"
If you need to return a more complicated object, you can put a __view_result__ function on it:
class MyObject:
def __view_result__(self) -> str:
return "123"
@app.get("/")
async def index():
return MyObject()
You can import any standard HTML components from the view.components module:
from view.components import html, title, head, body, h1
from view import new_app
app = new_app()
@app.get("/")
async def index():
return html(
head(
title("Hello, view.py!"),
),
body(
h1("This is my website!"),
),
)
app.run()
The above would translate to the following HTML snippet:
<html>
<head>
<title>Hello, view.py!</title>
<body>
<h1>This is my website!</h1>
</body>
</html>
You can pass an infinite number of children to a component, and it will be translated to the proper HTML:
div(p("a"), p("b"), p("c"))
Would translate to:
<div>
<p>a</p>
<p>b</p>
<p>c</p>
</div>
All built in components come with their respected attributes, per the HTML specification:
@app.get("/")
async def index():
return html(lang="en")
Since the class keyword is reserved in Python, view.py uses the parameter name cls instead:
div(cls="hello")
There's no need for any fancy mechanics when making a custom component, so you can just use a normal function:
def my_header(content: str):
return div(h1(content))
If you need to, you can use view.Response as an object wrapper for responses:
import view
app = view.new_app()
@app.get("/")
async def index():
res = view.Response("my response!")
return res
app.run()
You may also easily use cookies with the response type:
@app.get("/")
async def index():
res = view.Response("my response!")
res.cookie("hello", "world")
return res
A response object may also be used to wrap a __view_result__, like so:
class MyObject():
def __view_result__(self):
return "hello", 201
@app.get("/")
async def index():
return view.Response(MyObject(), 200) # Returns 200 instead of 201
While it's not required, the view.HTML type may come in handy if you're returning lots of HTML. You may pass 4 total types:
view.HTML("<h1>Hi!</h1>") # Renders HTML from a string
view.HTML(pathlib.Path("my_file.html")) # Renders HTML from a file
view.HTML(view.html(...)) # Render HTML from a component
with open("my_file.html") as f:
view.HTML(f) # Render HTML from a file wrapper