A library for building HTML documents with a simple and learnable syntax
Project description
PyHTML Enhanced
A library for building HTML documents with a simple and learnable syntax, inspired by (and similar to) Cenk Altı's PyHTML library, but with improved documentation and type safety.
Features
-
Inline documentation and type safety for all tags.
-
Editor support for many common tags (attribute suggestions).
-
A modern and readable codebase.
-
No dependencies.
-
100% test coverage
Usage
>>> import pyhtml as p
>>> my_website = p.html(
... p.head(
... p.title("Hello, world!"),
... p.script(src="http://example.com/script.js"),
... ),
... p.body(
... p.h1("Hello, world!"),
... p.p("This is my amazing website!"),
... ),
... )
>>> print(str(my_website))
<!DOCTYPE html>
<html>
<head>
<title>
Hello, world!
</title>
<script type="text/javascript" src="http://example.com/script.js"></script>
</head>
<body>
<h1>
Hello, world!
</h1>
<p>
This is my amazing website!
</p>
</body>
</html>
Creating elements
Every HTML tag is represented by a class that generates that HTML code. For
example, to create a <br> element, you could use:
>>> line_break = p.br()
>>> print(str(line_break))
<br/>
Adding children to elements
Any arguments to a tag are used as a child element to the created HTML element.
For example, to create a heading with the text "My awesome website", you
could use
>>> heading = p.h1("My awesome website")
>>> print(str(heading))
<h1>
My awesome website
</h1>
Adding attributes to elements
Any keyword arguments to a tag are used as an attribute of the created HTML element. For example, to create a form submit button, you could use
>>> submit_button = p.input(type="submit")
>>> print(str(submit_button))
<input type="submit"/>
Adding attributes and children
In HTML, attributes are specified within the opening tag. Contrastingly, Python requires keyword arguments (attributes) to be specified after regular arguments (children). To maintain similarity to writing regular HTML, you can call an element in order to add more attributes and children. For example, to create a link to PyHTML's GitHub page, you could use
>>> my_link = p.a(href="https://github.com/COMP1010UNSW/pyhtml-enhanced")("Take a look at the code")
>>> print(str(my_link))
<a href="https://github.com/COMP1010UNSW/pyhtml-enhanced">
Take a look at the code
</a>
HTML comments
You can add comments to HTML (useful for debugging) by using the Comment tag.
>>> comment = p.Comment("This is an HTML comment")
>>> print(str(comment))
<!--
This is an HTML comment
-->
Rendering HTML
Converting your PyHTML into HTML is as simple as stringifying it!
>>> print(str(p.i("How straightforward!")))
<i>
How straightforward!
</i>
Custom tags
Since this library includes all modern HTML tags, it is very unlikely that
you'll need to do create a custom tag. However if you really need to, you can
create a class deriving from Tag.
>>> class fancytag(p.Tag):
... ...
>>> print(fancytag())
<fancytag></fancytag>
Tag base classes
You can derive from various other classes to get more control over how your tag is rendered:
-
Tag: default rendering. -
SelfClosingTag: tag is self-closing, meaning that no child elements are accepted. -
WhitespaceSensitiveTag: tag is whitespace-sensitive, meaning that its child elements are not indented.
Class properties
children: child elementsattributes: element attributes
Rendering control functions
You can also override various functions to control the existing rendering.
-
_get_tag_name: return the name to use for the tag. For example returning"foo"would produce<foo>. -
_get_default_attributes: return the default values for attributes. -
_get_tag_pre_content: return the pre-content for the tag. For example, the<html>tag uses this to add the<!DOCTYPE html>before the opening tag. -
_escape_children: return whether the string child elements should be escaped to prevent HTML injection. -
_render: render the element and its children, returning the list of lines to use for the output. Overriding this should be a last resort, as it is easy to subtly break the rendering process if you aren't careful.
Refer to the documentation for Tag for more information.
Differences to PyHTML
There are some minor usage differences compared to the original PyHTML library.
Uninstantiated classes are only rendered if they are given as the child of an instantiated element.
>>> p.br
<class 'pyhtml.__tags.generated.br'>
>>> print(str(p.html(p.body(p.br))))
<!DOCTYPE html>
<html>
<body>
<br/>
</body>
</html>
Calling an instance of a Tag will return a new tag containing all elements of
the original tag combined with the new attributes and children, but will not
modify the original instance, as I found the old behaviour confusing and
bug-prone.
>>> para = p.p("Base paragraph")
>>> para2 = para("Extra text")
>>> para2
<p>
Base paragraph
Extra text
</p>
>>> para
<p>
Base paragraph
</p>
Known issues
There are a couple of things I haven't gotten round to sorting out yet
- Add default attributes to more tags
- Some tags (eg
<pre>,<script>) currently aren't properly implemented and escape their contents.
How it works
Since there are so many HTML tags, it would be extremely tedious to document
them all manually. In the meta directory, you will find code that solves this
problem with the following steps:
-
Download the Markdown source for MDN's documentation of all HTML elements.
-
Parse the markdown to gather all tag names and descriptions, discarding garbage data and obsolete tags.
-
Use data from a YAML configuration file (
meta/tags.yml) to gather information on suggested attributes and base classes to use for each tag. -
Generate Python code to represent all of these tags, including their documentation.
Credits
Cenkalti/PyHTML
Cenk Altı's work was used as a source of inspiration and reference. Although
all the code in pyhtml-enhanced was written by me, I want to thank them for
the significant help their hard work provided while creating this project,
going as far as to give design advice on request.
MDN Web Docs
Almost all of the documentation was gathered from the MDN Web Docs. It's super neat that all their documentation is open (licensed as CC-BY-SA-2.5 if you're interested).
COMP1010 students and staff
COMP1010's students and staff members have uncovered and helped to resolve many bugs, and have suggested many improvements. I'd like to thank them for all of their help!
License
Source code
Copyright (c) 2023 Miguel Guthridge, COMP1010 UNSW
Source code for the library is open source, using the MIT license. A copy of the license text is available in LICENSE.md
Documentation
Documentation is copied from MDN Web Docs, and is license under CC-BY-SA-2.5. A copy of the license text is available in LICENSE_DOCS.md
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pyhtml_enhanced-2.1.0.tar.gz.
File metadata
- Download URL: pyhtml_enhanced-2.1.0.tar.gz
- Upload date:
- Size: 34.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.9.19 Linux/6.5.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e7c267f65037981d45c8965b39adda4394fb05f71c6ee2221f06fcdc38ddbbc2 |
|
| MD5 | 093b723afe1e99a771ea09982f630570 |
|
| BLAKE2b-256 | 79225cf00dbfe21b01a598039223a10cf20cb53ab3308cd83c7575e4cd52d919 |
File details
Details for the file pyhtml_enhanced-2.1.0-py3-none-any.whl.
File metadata
- Download URL: pyhtml_enhanced-2.1.0-py3-none-any.whl
- Upload date:
- Size: 40.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.9.19 Linux/6.5.0-1018-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cb87c88cafdb7c50e8a1a572e1afb086eff1a5b1989a96dceb4cffbb8eb7b455 |
|
| MD5 | ef84ea8112b651304bcf1e63939eacac |
|
| BLAKE2b-256 | 97f7edce1f5fb9fb106f8253c7489ac312f43c24966207f46114fe44b1fd183d |
