Merge branch 'master' into update-docs

willkg · web-flow · commit cbaf304f4342 · 2017-10-31T14:11:25.000-04:00
diff --git a/.travis.yml b/.travis.yml
@@ -5,13 +5,12 @@ python:
   - "3.3"
   - "3.4"
   - "3.5"
+  - "3.6"
   - "pypy"
 
 sudo: false
 
-cache:
-  directories:
-    - $HOME/.cache/pip
+cache: pip
 
 env:
   - USE_OPTIONAL=true
diff --git a/html5lib/filters/alphabeticalattributes.py b/html5lib/filters/alphabeticalattributes.py
@@ -8,13 +8,24 @@
     from ordereddict import OrderedDict
 
 
+def _attr_key(attr):
+    """Return an appropriate key for an attribute for sorting
+
+    Attributes have a namespace that can be either ``None`` or a string. We
+    can't compare the two because they're different types, so we convert
+    ``None`` to an empty string first.
+
+    """
+    return (attr[0][0] or ''), attr[0][1]
+
+
 class Filter(base.Filter):
     def __iter__(self):
         for token in base.Filter.__iter__(self):
             if token["type"] in ("StartTag", "EmptyTag"):
                 attrs = OrderedDict()
                 for name, value in sorted(token["data"].items(),
-                                          key=lambda x: x[0]):
+                                          key=_attr_key):
                     attrs[name] = value
                 token["data"] = attrs
             yield token
diff --git a/html5lib/tests/test_alphabeticalattributes.py b/html5lib/tests/test_alphabeticalattributes.py
@@ -0,0 +1,81 @@
+from __future__ import absolute_import, division, unicode_literals
+
+try:
+    from collections import OrderedDict
+except ImportError:
+    from ordereddict import OrderedDict
+
+import pytest
+
+import html5lib
+from html5lib.filters.alphabeticalattributes import Filter
+from html5lib.serializer import HTMLSerializer
+
+
+@pytest.mark.parametrize('msg, attrs, expected_attrs', [
+    (
+        'no attrs',
+        {},
+        {}
+    ),
+    (
+        'one attr',
+        {(None, 'alt'): 'image'},
+        OrderedDict([((None, 'alt'), 'image')])
+    ),
+    (
+        'multiple attrs',
+        {
+            (None, 'src'): 'foo',
+            (None, 'alt'): 'image',
+            (None, 'style'): 'border: 1px solid black;'
+        },
+        OrderedDict([
+            ((None, 'alt'), 'image'),
+            ((None, 'src'), 'foo'),
+            ((None, 'style'), 'border: 1px solid black;')
+        ])
+    ),
+])
+def test_alphabetizing(msg, attrs, expected_attrs):
+    tokens = [{'type': 'StartTag', 'name': 'img', 'data': attrs}]
+    output_tokens = list(Filter(tokens))
+
+    attrs = output_tokens[0]['data']
+    assert attrs == expected_attrs
+
+
+def test_with_different_namespaces():
+    tokens = [{
+        'type': 'StartTag',
+        'name': 'pattern',
+        'data': {
+            (None, 'id'): 'patt1',
+            ('http://www.w3.org/1999/xlink', 'href'): '#patt2'
+        }
+    }]
+    output_tokens = list(Filter(tokens))
+
+    attrs = output_tokens[0]['data']
+    assert attrs == OrderedDict([
+        ((None, 'id'), 'patt1'),
+        (('http://www.w3.org/1999/xlink', 'href'), '#patt2')
+    ])
+
+
+def test_with_serializer():
+    """Verify filter works in the context of everything else"""
+    parser = html5lib.HTMLParser()
+    dom = parser.parseFragment('<svg><pattern xlink:href="#patt2" id="patt1"></svg>')
+    walker = html5lib.getTreeWalker('etree')
+    ser = HTMLSerializer(
+        alphabetical_attributes=True,
+        quote_attr_values='always'
+    )
+
+    # FIXME(willkg): The "xlink" namespace gets dropped by the serializer. When
+    # that gets fixed, we can fix this expected result.
+    assert (
+        ser.render(walker(dom)) ==
+        '<svg><pattern id="patt1" href="#patt2"></pattern></svg>'
+    )
diff --git a/requirements-install.sh b/requirements-install.sh
@@ -1,17 +1,15 @@
 #!/bin/bash -ex
 
-pip install pip==6.1.0
+if [[ $SIX_VERSION ]]; then
+  pip install six==$SIX_VERSION
+fi
 
-pip install -U -r requirements-test.txt
+pip install -r requirements-test.txt
 
 if [[ $USE_OPTIONAL == "true" ]]; then
-  pip install -U -r requirements-optional.txt
-fi
-
-if [[ $SIX_VERSION ]]; then
-  pip install six==$SIX_VERSION
+  pip install -r requirements-optional.txt
 fi
 
 if [[ $CI == "true" ]]; then
-  pip install -U codecov
+  pip install codecov
 fi
diff --git a/setup.cfg b/setup.cfg
@@ -9,3 +9,6 @@ exclude = .git,__pycache__,.tox,doc
 [flake8]
 ignore = N
 max-line-length = 139
+
+[metadata]
+license_file = LICENSE
diff --git a/setup.py b/setup.py
@@ -70,6 +70,7 @@ def default_environment():
     'Programming Language :: Python :: 3.3',
     'Programming Language :: Python :: 3.4',
     'Programming Language :: Python :: 3.5',
+    'Programming Language :: Python :: 3.6',
     'Topic :: Software Development :: Libraries :: Python Modules',
     'Topic :: Text Processing :: Markup :: HTML'
 ]
diff --git a/tox.ini b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = {py26,py27,py33,py34,py35,pypy}-{base,optional},doc
+envlist = {py26,py27,py33,py34,py35,py36,pypy}-{base,optional}
 
 [testenv]
 deps =
@@ -14,7 +14,7 @@ deps =
   doc: Sphinx
 
 commands =
-  {envbindir}/py.test
+  {envbindir}/py.test {posargs}
   {toxinidir}/flake8-run.sh
 
 [testenv:doc]

Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,7 @@ def default_environment():`
`70`	`70`	`'Programming Language :: Python :: 3.3',`
`71`	`71`	`'Programming Language :: Python :: 3.4',`
`72`	`72`	`'Programming Language :: Python :: 3.5',`
	`73`	`+ 'Programming Language :: Python :: 3.6',`
`73`	`74`	`'Topic :: Software Development :: Libraries :: Python Modules',`
`74`	`75`	`'Topic :: Text Processing :: Markup :: HTML'`
`75`	`76`	`]`