Unofficial Python port of server-side rendering from AMP Optimizer
Project description
AMP Renderer
Unofficial Python port of server-side rendering from AMP Optimizer. Supports Python 3.6 and above.
AMP Renderer performs the following optimizations:
- Inject the specific layout markup into each AMP element
- Insert the AMP runtime styles into the document
- Remove the AMP boilerplate styles, if possible
- Mark the document as “transformed” with the appropriate tags on the
htmlelement - Insert
imgtags for images with the data-hero attribute
It also makes these formatting updates:
- Remove empty
classandstyletags for AMP HTML elements - Convert tag names and attribute names to lowercase
- Convert numerical attribute values to strings
- Use double quotes ("") for attributes, and escape double quotes inside attribute values
- Remove whitespace between html attributes
- If desired, removes comments (disabled by default)
- If desired, trims whitespace around HTML attribute values (disabled by default, and not always a good idea)
AMPRenderer can be used on a block of arbitrary HTML, but when used on a full document, it will insert the AMP runtime styles and, if possible, remove the AMP boilerplate styles.
Boilerplate styles can be removed except in these cases:
- An AMP element uses an unsupported value for the
layoutattribute amp-audiois used- There is at least one
amp-experimentactive - Transformation fails for one or more elements due to an invalid attribute value for
media,sizes, orheights - Any render-delaying extension is used. Currently this means:
amp-dynamic-css-classesamp-story
If boilerplate styles can’t be removed, the attribute no_boilerplate will be set to True after calling render; otherwise it will be False. Until render runs, the no_boilerplate attribute isn’t set at all.
Usage
If using Django, you can use the Django AMP Renderer middleware.
Otherwise, install via PyPI:
pip install amp-renderer
Minimal usage:
from amp_renderer import AMPRenderer
...
RUNTIME_VERSION = "012345678" /* Current AMP runtime version number */
RUNTIME_STYLES = "..." /* Current contents of https://cdn.ampproject.org/v0.css */
renderer = AMPRenderer(
runtime_version=RUNTIME_VERSION,
runtime_styles=RUNTIME_STYLES)
original_html = """
<!doctype html>
<html ⚡>
...
</html>
"""
result = renderer.render(original_html)
print(result)
Remove comments and/or trim attributes:
renderer.should_strip_comments = True
renderer.should_trim_attributes = True
result = renderer.render(original_html)
print(result)
The AMPRenderer class inherits from HTMLParser, and can be similarly extended.
Testing, etc.
Install requrements:
make install
Sort imports (Requires Python >= 3.8):
make format
Lint (Requires Python >= 3.8):
make lint
Test:
make test
Discussion
There are still some aspects of the official AMP Optimizer implementation that haven’t been addressed yet. PRs welcome.
General
-
Tested against AMP Optimizer’s ServerSideRendering spec - Automatic runtime version management
Dynamic attributes
-
Supportsizes,media, andheightsvia CSS injection -
Group CSS injections formediaattributes by shared media queries to reduce necessary bytes - Support percent values in
heights - Warn or fail if CSS injection puts the
amp-customelement over the byte limit
Hero Images
-
Injectimgtag foramp-imgs with thedata-heroattribute - Enforce 2-image limit on
data-hero - Autodetect hero images
- Support hero image functionality for
amp-iframe,amp-video, andamp-video-iframe
Performance
The Python AMP Renderer does not insert preload links into the head of the DOM object for hero images; This can be done by hand for more control over the critical path.
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 amp-renderer-2.0.1.tar.gz.
File metadata
- Download URL: amp-renderer-2.0.1.tar.gz
- Upload date:
- Size: 22.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f3bc3a5739bdfbf5cf7867e4dc9d4ade106d350263558c85f43901e1e678e58d |
|
| MD5 | b327aff4b2c390a11f8624d4ac11ed37 |
|
| BLAKE2b-256 | 412cce83e3d26362d83113ace1ebd74c3834f728c266bc7a9a5803d47b229963 |
File details
Details for the file amp_renderer-2.0.1-py3-none-any.whl.
File metadata
- Download URL: amp_renderer-2.0.1-py3-none-any.whl
- Upload date:
- Size: 22.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 03db430eb0f6d7f0a8b48f3e953d05162ac1d626ad03dbbf6ce52688113a4dd4 |
|
| MD5 | c2d5fb9027f35eb9828594ec3a693acf |
|
| BLAKE2b-256 | 3258144a3e1b3942d8d8a4773728bb5f1b47cc0983907380ceafc5062e0eef68 |
