Skip to main content

Composable HTML in Python

Project description

* Description
Very basic Python functions to generate HTML in a compasable way.

* Usage

Very much inspired from React.

A component is any function that returns the result of a ~create_element~ call. This function that the element name,

Let us first define a Text component. We will create a text element without any attributes:

#+begin_src python :session
from chp import create_element, create_prop, render_element

def Text(t):
return create_element("span", [], t)

t = Text("YourLabs")
# outputs => "<span >YourLabs</span>"

: <span >YourLabs</span>

Let's now use this component to display text inside of a link:

#+begin_src python :session
def Link(href, children):
href = create_prop("href", href)
return create_element("a", [href], children)

l = Link("", [Text("YourLabs")])
# outputs => "<a href=""><span >YourLabs</span></a>"

: <a href=""><span >YourLabs</span></a>

Let us now define a Menu component that will create links inside of a nav element based on some input. Let's also rename out ~create_element~ and ~create_prop~ functions to ~ce~ and ~cp~ respectively

#+begin_src python :session
ce = create_element
cp = create_prop

def Menu(links=[]):
c = [] # menu children links array
for l in links:
el = Link(l["href"], [Text(l["text"])])

return ce("nav", [cp("class", "menu")], c)

links = [
"href": "",
"text": "YourLabs",
"href": "",
"text": "NovaMedia",

m = Menu(links)
# outputs => <nav class="menu"><a href=""><span >YourLabs</span></a><a href=""><span >NovaMedia</span></a></nav>


Pretty printed, this final output is:
#+begin_src html
<nav class="menu">
<a href="">
<a href="">

Feel free to check out the and files to see how a full page can be built easily using this method. The file writes the html output to another file called output.html.

* Trying it
#+begin_src bash
git clone

python # write html to output.html file
firefox output.html

* Examples

To run the example project:
- pip install --user --editable path/to/chp[dev]
- yarn install; yarn start
- chp-django runserver
- py.test path/to/chp

#+begin_src python
import chp

def FormSchema(is_checked):
return chp.Form([

class PostForm(forms.ModelForm):
def render(self):
is_checked = 'checked' # self.checked
return mark_safe(FormSchema(is_checked).render_element(Form))


~phtml~ becomes a string containing the following html code:

#+begin_src html
<form class="mdc-layout-grid__cell">
<div class="mdc-layout-grid__inner">
<input class="mdc-input__native-control" type="text" id="{{ id }}" value="{{ value }}" name="username"></input>
<div class="mdc-form-field">
<div class="mdc-checkbox">
<input class="mdc-checkbox__native-control" type="checkbox" id="{{ id }}" name="password"></input>
<div class="mdc-checkbox-background"></div>
<label for="{{ id }}">{{ label }}</label>
<div >
{% for error in form.non_field_errors %}
{{ error }}
{% endfor %}

- Testing of the file. Some of the high level results were copy pasted into

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chp-0.0.1.tar.gz (6.6 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page