https://github.com/hoishing/ptag
pythonic way to create HTML/XML/SVG tags
https://github.com/hoishing/ptag
html python svg tag template xml
Last synced: 5 months ago
JSON representation
pythonic way to create HTML/XML/SVG tags
- Host: GitHub
- URL: https://github.com/hoishing/ptag
- Owner: hoishing
- License: mit
- Created: 2024-08-18T03:49:05.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T03:28:10.000Z (over 1 year ago)
- Last Synced: 2024-11-10T01:57:51.386Z (over 1 year ago)
- Topics: html, python, svg, tag, template, xml
- Language: Python
- Homepage: https://pypi.org/project/ptag/
- Size: 134 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ptag
[![ci-badge]][ci-url] [![pypi-badge]][pypi-url] [![MIT-badge]][MIT-url] [![black-badge]][black-url]
> generate html/svg tags hierarchy with context manager
---
> [!NOTE]
> The repository has been archived. Initially, using a context manager to construct the DOM structure seemed "Pythonic" syntactically. However, I later discovered that this approach introduced an additional layer of complexity and negatively impacted performance at a larger scale. As a result, I developed **[tagit](https://github.com/hoishing/tagit)**, a much simpler and more performant DOM library. It exclusively handles string inputs and outputs without complex features, while still managing the DOM structure purely within Python code.
- use ⭐️ context manager ⭐️ to create tag hierarchy
- create value-less(boolean) attributes with positional argument
- handy for using with [UnoCSS] attributify mode
- all standard html and svg elements are exported as functions
- pure python, no external dependencies
- high test coverage
## Quick Start
- Installation: `pip install ptag`
- base signature
- `element(content = None, *args, **kwargs) -> Tag`
```python
# common elements
from ptag import div, img, p, ul, li, label, input_,
# for creating custom element
from ptag import Tag
# for pretty print
from ptag import prettify
# empty tag
print(div())
#
# None content is ignored
print(div(None))
#
# empty string content creates closing tag
print(div(""))
#
# tag as content
print(div(img(src="url"), id="bar"))
#
# content mix with strings and tags
print(div(["foo", img(src="url"), "bar")])
#
foobar
```
- use with context manager
```python
with ul() as bullets:
li("foo")
li("bar")
print(bullets)
#
- foo
- bar
```
- pretty print
```python
print(bullets.prettify())
#
- foo
- bar
#
#
#
```
- use trailing underscore to work around python keyword and built-in functions
- attributes:
- `class_` -> `class`
- `for_` -> `for`
- elements:
- `del_` -> `del`
- `input_` -> `input`
- `map_` -> `map`
- `object_` -> `object`
```python
print(label("foo", for_="bar"))
# foo
print(input_(None, class_="foo", name="bar", type="checkbox", value="baz"))
#
```
- position args -> value-less attribute.
- boolean attribute: eg. `checked`, `disabled`, `selected`
- assign tailwind classes with [UnoCSS] attributify mode
```python
print(div("foo", "clear-both", "m-2", "rounded", id="baz"))
#
```
- keyword argument with value None is ignored
```python
tag = div(None, "m-2", "rounded", id="baz", style=None)
print(tag)
#
```
- append content and attributes to existing tag
```python
tag = div()
tag.affix(p("bar"), "m-2", "rounded", id="baz")
print(tag)
#
bar
```
- create custom element
- signature:
- `Tag(name: str, content = None, *args, **kwargs) -> str`
```python
my_tag = Tag("MyTag", "foo", "bar", "corge", id="baz", class_="qux")
print(my_tag)
# foo
```
- more examples could be found in [tests] package
## Limitations
- `prettify()` method doesn't support attribute without value
- use kwargs instead of positional args if prettifying is needed
- eg. `selected` -> `selected=""`
## Need Help?
- [github issue]
- [x.com posts]
- [contact the author]
[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-url]: https://github.com/psf/black
[ci-badge]: https://github.com/hoishing/ptag/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/hoishing/ptag/actions/workflows/ci.yml
[contact the author]: https://hoishing.github.io
[github issue]: https://github.com/hoishing/ptag/issues
[MIT-badge]: https://img.shields.io/github/license/hoishing/ptag
[MIT-url]: https://opensource.org/licenses/MIT
[pypi-badge]: https://img.shields.io/pypi/v/ptag
[pypi-url]: https://pypi.org/project/ptag/
[tests]: https://github.com/hoishing/ptag/tree/main/tests
[UnoCSS]: https://github.com/unocss/unocss
[x.com posts]: https://x.com/hoishing