| + | Type | +Default | +Details | +
|---|---|---|---|
| name | +str | ++ | The project name to deploy | +
| mount | +bool_arg | +True | +Create a mounted volume at /app/data? | +
+FastHTML is Fast
+ +``` python +# Called without the `show()` function, the raw HTML is displayed +sentence +``` + +``` html ++FastHTML is Fast
+``` + +------------------------------------------------------------------------ + +source + +### attrmap_x + +> attrmap_x (o) + +------------------------------------------------------------------------ + +source + +### ft_html + +> ft_html (tag:str, *c, id=None, cls=None, title=None, style=None, +> attrmap=None, valmap=None, ft_cls=None, auto_id=None, **kwargs) + +------------------------------------------------------------------------ + +source + +### ft_hx + +> ft_hx (tag:str, *c, target_id=None, hx_vals=None, id=None, cls=None, +> title=None, style=None, accesskey=None, contenteditable=None, +> dir=None, draggable=None, enterkeyhint=None, hidden=None, +> inert=None, inputmode=None, lang=None, popover=None, +> spellcheck=None, tabindex=None, translate=None, hx_get=None, +> hx_post=None, hx_put=None, hx_delete=None, hx_patch=None, +> hx_trigger=None, hx_target=None, hx_swap=None, hx_swap_oob=None, +> hx_include=None, hx_select=None, hx_select_oob=None, +> hx_indicator=None, hx_push_url=None, hx_confirm=None, +> hx_disable=None, hx_replace_url=None, hx_disabled_elt=None, +> hx_ext=None, hx_headers=None, hx_history=None, +> hx_history_elt=None, hx_inherit=None, hx_params=None, +> hx_preserve=None, hx_prompt=None, hx_request=None, hx_sync=None, +> hx_validate=None, **kwargs) + +``` python +ft_html('a', _at_click_dot_away=1) +``` + +``` html + +``` + +``` python +ft_html('a', **{'@click.away':1}) +``` + +``` html + +``` + +``` python +ft_html('a', {'@click.away':1}) +``` + +``` html + +``` + +``` python +ft_hx('a', hx_vals={'a':1}) +``` + +``` html + +``` + +------------------------------------------------------------------------ + +source + +### File + +> File (fname) + +*Use the unescaped text in file `fname` directly* + +For tags that have a `name` attribute, it will be set to the value of +`id` if not provided explicitly: + +``` python +Form(Button(target_id='foo', id='btn'), + hx_post='/', target_id='tgt', id='frm') +``` + +``` html + +``` + +------------------------------------------------------------------------ + +source + +### fill_form + +> fill_form (form:fastcore.xml.FT, obj) + +*Fills named items in `form` using attributes in `obj`* + +``` python +@dataclass +class TodoItem: + title:str; id:int; done:bool; details:str; opt:str='a' + +todo = TodoItem(id=2, title="Profit", done=True, details="Details", opt='b') +check = Label(Input(type="checkbox", cls="checkboxer", name="done", data_foo="bar"), "Done", cls='px-2') +form = Form(Fieldset(Input(cls="char", id="title", value="a"), check, Input(type="hidden", id="id"), + Select(Option(value='a'), Option(value='b'), name='opt'), + Textarea(id='details'), Button("Save"), + name="stuff")) +form = fill_form(form, todo) +assert '' in to_xml(form) +form +``` + +``` html + +``` + +------------------------------------------------------------------------ + +source + +### fill_dataclass + +> fill_dataclass (src, dest) + +*Modifies dataclass in-place and returns it* + +``` python +nt = TodoItem('', 0, False, '') +fill_dataclass(todo, nt) +nt +``` + + TodoItem(title='Profit', id=2, done=True, details='Details', opt='b') + +------------------------------------------------------------------------ + +source + +### find_inputs + +> find_inputs (e, tags='input', **kw) + +*Recursively find all elements in `e` with `tags` and attrs matching +`kw`* + +``` python +inps = find_inputs(form, id='title') +test_eq(len(inps), 1) +inps +``` + + [input((),{'value': 'Profit', 'id': 'title', 'class': 'char', 'name': 'title'})] + +You can also use lxml for more sophisticated searching: + +``` python +elem = lx.fromstring(to_xml(form)) +test_eq(elem.xpath("//input[@id='title']/@value"), ['Profit']) +``` + +------------------------------------------------------------------------ + +source + +### **getattr** + +> __getattr__ (tag) + +------------------------------------------------------------------------ + +source + +### html2ft + +> html2ft (html, attr1st=False) + +*Convert HTML to an `ft` expression* + +``` python +h = to_xml(form) +hl_md(html2ft(h), 'python') +``` + +``` python +Form( + Fieldset( + Input(value='Profit', id='title', name='title', cls='char'), + Label( + Input(type='checkbox', name='done', data_foo='bar', checked='1', cls='checkboxer'), + 'Done', + cls='px-2' + ), + Input(type='hidden', id='id', name='id', value='2'), + Select( + Option(value='a'), + Option(value='b', selected='1'), + name='opt' + ), + Textarea('Details', id='details', name='details'), + Button('Save'), + name='stuff' + ) +) +``` + +``` python +hl_md(html2ft(h, attr1st=True), 'python') +``` + +``` python +Form( + Fieldset(name='stuff')( + Input(value='Profit', id='title', name='title', cls='char'), + Label(cls='px-2')( + Input(type='checkbox', name='done', data_foo='bar', checked='1', cls='checkboxer'), + 'Done' + ), + Input(type='hidden', id='id', name='id', value='2'), + Select(name='opt')( + Option(value='a'), + Option(value='b', selected='1') + ), + Textarea('Details', id='details', name='details'), + Button('Save') + ) +) +``` + +------------------------------------------------------------------------ + +source + +### sse_message + +> sse_message (elm, event='message') + +*Convert element `elm` into a format suitable for SSE streaming* + +``` python +print(sse_message(Div(P('hi'), P('there')))) +``` + + event: message + data:hi
+ data:there
+ data:| + | Type | +Default | +Details | +
|---|---|---|---|
| appname | +NoneType | +None | +Name of the module | +
| app | +str | +app | +App instance to be served | +
| host | +str | +0.0.0.0 | +If host is 0.0.0.0 will convert to localhost | +
| port | +NoneType | +None | +If port is None it will default to 5001 or the PORT environment +variable | +
| reload | +bool | +True | +Default is to reload the app upon code changes | +
| reload_includes | +list[str] | str | None | +None | +Additional files to watch for changes | +
| reload_excludes | +list[str] | str | None | +None | +Files to ignore for changes | +
there
' in txt +``` + +``` python +@rt('/oops') +def get(nope): return nope +test_warns(lambda: cli.get('/oops?nope=1')) +``` + +``` python +def test_r(cli, path, exp, meth='get', hx=False, **kwargs): + if hx: kwargs['headers'] = {'hx-request':"1"} + test_eq(getattr(cli, meth)(path, **kwargs).text, exp) + +ModelName = str_enum('ModelName', "alexnet", "resnet", "lenet") +fake_db = [{"name": "Foo"}, {"name": "Bar"}] +``` + +``` python +@rt('/html/{idx}') +async def get(idx:int): return Body(H4(f'Next is {idx+1}.')) +``` + +``` python +@rt("/models/{nm}") +def get(nm:ModelName): return nm + +@rt("/files/{path}") +async def get(path: Path): return path.with_suffix('.txt') + +@rt("/items/") +def get(idx:int|None = 0): return fake_db[idx] + +@rt("/idxl/") +def get(idx:list[int]): return str(idx) +``` + +``` python +r = cli.get('/html/1', headers={'hx-request':"1"}) +assert '15, Lorem
" in response +``` + +``` python +# Testing POST with Content-Type: application/json +@app.post("/bodytext") +def index(body): return body + +response = cli.post('/bodytext', headers={"Content-Type": "application/json"}, data=s).text +test_eq(response, '{"b": "Lorem", "a": 15}') +``` + +``` python +files = [ ('files', ('file1.txt', b'content1')), + ('files', ('file2.txt', b'content2')) ] +``` + +``` python +@rt("/uploads") +async def post(files:list[UploadFile]): + return ','.join([(await file.read()).decode() for file in files]) + +res = cli.post('/uploads', files=files) +print(res.status_code) +print(res.text) +``` + + 200 + content1,content2 + +``` python +@rt("/setsess") +def get(sess, foo:str=''): + now = datetime.now() + sess['auth'] = str(now) + return f'Set to {now}' + +@rt("/getsess") +def get(sess): return f'Session time: {sess["auth"]}' + +print(cli.get('/setsess').text) +time.sleep(0.01) + +cli.get('/getsess').text +``` + + Set to 2024-10-11 09:46:57.944986 + + 'Session time: 2024-10-11 09:46:57.944986' + +``` python +@rt("/sess-first") +def post(sess, name: str): + sess["name"] = name + return str(sess) + +cli.post('/sess-first', data={'name': 2}) + +@rt("/getsess-all") +def get(sess): return sess['name'] + +test_eq(cli.get('/getsess-all').text, '2') +``` + +``` python +@rt("/upload") +async def post(uf:UploadFile): return (await uf.read()).decode() + +with open('../../CHANGELOG.md', 'rb') as f: + print(cli.post('/upload', files={'uf':f}, data={'msg':'Hello'}).text[:15]) +``` + + # Release notes + +``` python +@rt("/form-submit/{list_id}") +def options(list_id: str): + headers = { + 'Access-Control-Allow-Origin': '*', + 'Access-Control-Allow-Methods': 'POST', + 'Access-Control-Allow-Headers': '*', + } + return Response(status_code=200, headers=headers) +``` + +``` python +h = cli.options('/form-submit/2').headers +test_eq(h['Access-Control-Allow-Methods'], 'POST') +``` + +``` python +from fasthtml.authmw import user_pwd_auth +``` + +``` python +def _not_found(req, exc): return Div('nope') + +app,cli,rt = get_cli(FastHTML(exception_handlers={404:_not_found})) + +txt = cli.get('/').text +assert '| + | Type | +Default | +Details | +
|---|---|---|---|
| db_file | +Optional | +None | +Database file name, if needed | +
| render | +Optional | +None | +Function used to render default database class | +
| hdrs | +Optional | +None | +Additional FT elements to add to | +
| ftrs | +Optional | +None | +Additional FT elements to add to end of | +
| tbls | +Optional | +None | +Experimental mapping from DB table names to dict table +definitions | +
| before | +Union | +None | +Functions to call prior to calling handler | +
| middleware | +Optional | +None | +Standard Starlette middleware | +
| live | +bool | +False | +Enable live reloading | +
| debug | +bool | +False | +Passed to Starlette, indicating if debug tracebacks should be +returned on errors | +
| routes | +Optional | +None | +Passed to Starlette | +
| exception_handlers | +Optional | +None | +Passed to Starlette | +
| on_startup | +Optional | +None | +Passed to Starlette | +
| on_shutdown | +Optional | +None | +Passed to Starlette | +
| lifespan | +Optional | +None | +Passed to Starlette | +
| default_hdrs | +bool | +True | +Include default FastHTML headers such as HTMX script? | +
| pico | +Optional | +None | +Include PicoCSS header? | +
| surreal | +Optional | +True | +Include surreal.js/scope headers? | +
| htmx | +Optional | +True | +Include HTMX header? | +
| ws_hdr | +bool | +False | +Include HTMX websocket extension header? | +
| secret_key | +Optional | +None | +Signing key for sessions | +
| key_fname | +str | +.sesskey | +Session cookie signing key file name | +
| session_cookie | +str | +session_ | +Session cookie name | +
| max_age | +int | +31536000 | +Session cookie expiry time | +
| sess_path | +str | +/ | +Session cookie path | +
| same_site | +str | +lax | +Session cookie same site policy | +
| sess_https_only | +bool | +False | +Session cookie HTTPS only? | +
| sess_domain | +Optional | +None | +Session cookie domain | +
| htmlkw | +Optional | +None | +Attrs to add to the HTML tag | +
| bodykw | +Optional | +None | +Attrs to add to the Body tag | +
| reload_attempts | +Optional | +1 | +Number of reload attempts when live reloading | +
| reload_interval | +Optional | +1000 | +Time between reload attempts in ms | +
| static_path | +str | +. | +Where the static file route points to, defaults to root dir | +
| kwargs | ++ | + | + |
| Returns | +Any | ++ | + |
| + | Type | +Details | +
|---|---|---|
| css | +str | +CSS to be included in the light media query | +
| + | Type | +Details | +
|---|---|---|
| css | +str | +CSS to be included in the dark media query | +
| + | Type | +Default | +Details | +
|---|---|---|---|
| sel | +str | +.marked | +CSS selector for markdown elements | +
| + | Type | +Default | +Details | +
|---|---|---|---|
| sel | +str | +.marked | +CSS selector for markdown elements | +
| inline_delim | +str | +$ | +Delimiter for inline math | +
| display_delim | +str | +$$ | +Delimiter for long math | +
| math_envs | +NoneType | +None | +List of environments to render as display math | +
| + | Type | +Default | +Details | +
|---|---|---|---|
| sel | +str | +pre code | +CSS selector for code elements. Default is industry standard, be +careful before adjusting it | +
| langs | +str | list | tuple | +python | +Language(s) to highlight | +
| light | +str | +atom-one-light | +Light theme | +
| dark | +str | +atom-one-dark | +Dark theme | +
| + | Type | +Default | +Details | +
|---|---|---|---|
| sel | +str | +.sortable | +CSS selector for sortable elements | +
| ghost_class | +str | +blue-background-class | +When an element is being dragged, this is the class used to +distinguish it from the rest | +
head
+Let's do this
+`,
+``, `W%{fOi)&Wj%)Qqi)XPTLzU5X`bZ+2M|F7=?c9b|dY%bx`6
zkxFKo(1^gh78oWOYz1-!T=O;a(ia#EYSXO};B>IEN0TT^p+NIuxx@^I
_5bs{&~537G(j1J#Rps^
Socials
+ +OG and Twitter social card headers
++
source
+