3.0rc

.github/workflows/ci.yml

@@ -17,23 +17,22 @@ jobs:
        python: ["3"]
        os: ["ubuntu-latest"]
        include:
-          - {python: "3.7", os: "ubuntu-22.04"}
-          - {python: "3.8", os: "ubuntu-22.04"}
           - {python: "3.9", os: "ubuntu-22.04"}
           - {python: "3.10", os: "ubuntu-22.04"}
           - {python: "3.11", os: "ubuntu-22.04"}
           - {python: "3.12", os: "ubuntu-22.04"}
+          - {python: "3.13", os: "ubuntu-24.04"}
+          - {python: "pypy3.10", os: "ubuntu-24.04"}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: "Set up Python ${{ matrix.python }}"
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python }}
     - name: "Install dependencies"
       run: |
         # python -m pip install --upgrade pip
         python -m pip install pytest
-        python -m pip install mock
         python -m pip install flake8
         python -m pip install importlib_metadata
         python -m pip install "setuptools>=62"
@@ -48,13 +47,13 @@ jobs:
       run: |
         python -m build --no-isolation
         pip install dist/dominate*.tar.gz
-        pytest
+        pytest --ignore=tests/community
     - name: Coveralls
       env:
         COVERAGE_RCFILE: ".github/workflows/.coveragerc"
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
         python -m pip install coverage
         python -m pip install coveralls
-        coverage run --source=dominate -m pytest
+        coverage run --source=dominate -m pytest --ignore=tests/community
         python -m coveralls --service=github || true

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+
+# 1. Welcome additions
+
+Anything that is part of the official HTML spec is likely welcome.
+
+Common patterns of web development, or ease-of-use features are welcome, so long as they are general and are likely to be useful to a broad group and not targetting any specific implimentation.
+
+## 1.1. Testing
+
+All PRs must have 100% test coverage of new code.
+
+New features should include example usage, including motivations.
+
+
+
+# 2. Not interested
+
+For exceptions to these, see #Community
+
+## 2.2. No 3rd party dependencies
+
+Do not add 3rd party dependencies.
+
+## 2.3. No 3rd party integrations
+
+I am not interested in maintaining integrations with a bunch of random JS/web frameworks/libraries. (i.e. HTMX, Flask, Unpoly, whatever)
+
+
+# 3. Community Packages
+
+If you wish to add a feature that would otherwise be disallowed by the above, you can make a community package. See `community/htmx.py` for a trivial example.
+
+Community packages must not be referenced from the main library, and must not do anything unless explicitly imported.
+

Makefile

@@ -1,5 +1,7 @@
 test:
-	-python2 -m pytest .
+	python3 -m pytest . --ignore=tests/community
+
+test-community:
 	python3 -m pytest .
 
 publish_old: clean test

dominate/_version.py

@@ -1 +1 @@
-__version__ = '2.9.1'
+__version__ = '3.0.0'

dominate/community/htmx.py

@@ -0,0 +1,12 @@
+
+from .. import tags
+
+class HtmxTag:
+  @classmethod
+  def clean_attribute(cls, attribute):
+    attribute = super().clean_attribute(attribute)
+    if attribute.startswith('hx_'):
+      attribute = attribute.replace('_', '-')
+    return attribute
+
+tags.html_tag.__bases__ = (HtmxTag,) + tags.html_tag.__bases__

dominate/dom_tag.py

@@ -441,7 +441,7 @@ def clean_attribute(attribute):
     }.get(attribute, attribute)
 
     # Workaround for Python's reserved words
-    if attribute[0] == '_':
+    if attribute[0] == '_' and len(attribute) > 1:
       attribute = attribute[1:]
 
     # Workaround for dash

tests/community/test_htmx.py

@@ -0,0 +1,7 @@
+
+from dominate import tags
+import dominate.community.htmx
+
+def test_hx():
+  d = tags.div(hx_foo=1)
+  assert d.render() == '<div hx-foo="1"></div>'

tests/test_document.py

@@ -1,6 +1,7 @@
 from dominate import document
 from dominate.tags import *
 
+
 def test_doc():
   d = document()
   assert d.render() == \

tests/test_dom_tag.py

@@ -1,8 +1,5 @@
 import pytest
-try:
-    import mock
-except ImportError:
-    import unittest.mock as mock
+import unittest.mock as mock
 
 from dominate.tags import *
 

tests/test_dom_tag_async.py

@@ -1,8 +1,9 @@
 from asyncio import gather, run, Semaphore
-from dominate.dom_tag import async_context_id
 from textwrap import dedent
 
 from dominate import tags
+from dominate.dom_tag import async_context_id
+
 
 # To simulate sleep without making the tests take a hella long time to complete
 # lets use a pair of semaphores to explicitly control when our coroutines run.
@@ -28,7 +29,7 @@ async def merge():
         sem_1 = Semaphore(0)
         sem_2 = Semaphore(0)
         return await gather(
-            tag_routine_1(sem_1, sem_2), 
+            tag_routine_1(sem_1, sem_2),
             tag_routine_2(sem_1, sem_2)
         )
 
@@ -67,7 +68,7 @@ async def merge():
           <div id="2"></div>
         </div>
     """).strip()
-    
+
     assert tag_2 == dedent("""\
         <div id="3">
           <div id="4"></div>

tests/test_dominate.py

@@ -1,6 +1,6 @@
 
 def test_version():
   import dominate
-  version = '2.9.1'
+  version = '3.0.0'
   assert dominate.version == version
   assert dominate.__version__ == version

tests/test_html.py

@@ -1,12 +1,7 @@
-import dominate
-from dominate.tags import *
 import pytest
-from dominate.util import raw
 
-try:
-  xrange = xrange
-except NameError:
-  xrange = range
+from dominate.tags import *
+from dominate.util import raw
 
 
 def test_arguments():
@@ -43,7 +38,7 @@ def test_add():
   with pytest.raises(ValueError):
     d += None
   d += 1
-  d += xrange(2,3)
+  d += range(2,3)
   d += {'id': 'foo'}
   assert d.render() == '<div id="foo">12</div>'
   assert len(d) == 2
@@ -208,6 +203,9 @@ def test_attributes():
   with pytest.raises(AttributeError):
     x = d['id']
 
+  with div(_foo='a', _='b') as d:
+    assert d.attributes.keys() == {'foo', '_'}
+
   with div() as d:
     attr(data_test=False)
   assert d['data-test'] is False
@@ -329,7 +327,7 @@ def test_pretty():
 
   assert p('goodbye ', i('cruel'), ' world').render() == \
     '''<p>goodbye <i>cruel</i> world</p>'''
-  
+
   assert p('my 1', sup('st'), ' PR').render() == \
     '''<p>my 1<sup>st</sup> PR</p>'''
 

tests/test_svg.py

@@ -4,8 +4,6 @@
 from dominate.tags import *
 from dominate.svg import *
 
-import pytest
-
 
 def base():
   return svg(