metadata-utils 1.0.0__py3-none-any.whl

metadata_utils/__init__.py

@@ -0,0 +1,39 @@
+# stdlib
+import unicodedata
+from typing import Dict
+from xml.sax.saxutils import escape
+from xml.sax.saxutils import unescape
+
+__VERSION__ = "1.0.0"
+
+
+# ==============================================================================
+
+
+# https://wiki.python.org/moin/EscapingHtml
+# escape() and unescape() takes care of "&" , "<" and ">"
+# we need to handle quotes, so we don't break things
+html_attribute_escape_table: Dict[str, str] = {'"': "&quot;", "'": "&apos;"}
+html_attribute_unescape_table: Dict[str, str] = {
+    v: k for (k, v) in html_attribute_escape_table.items()
+}
+
+
+def html_attribute_escape(text: str) -> str:
+    """Escape text for insertion into a quoted HTML attribute."""
+    return escape(text, html_attribute_escape_table)
+
+
+def html_attribute_unescape(text: str) -> str:
+    """Decode the five named entities emitted by html_attribute_escape."""
+    return unescape(text, html_attribute_unescape_table)
+
+
+def force_clean_ascii_NFKD(text: str) -> bytes:
+    """Apply NFKD, then return ASCII bytes, dropping non-ASCII characters."""
+    return unicodedata.normalize("NFKD", text).encode("ascii", "ignore")
+
+
+def force_clean_ascii_NFKC(text: str) -> bytes:
+    """Apply NFKC, then return ASCII bytes, dropping non-ASCII characters."""
+    return unicodedata.normalize("NFKC", text).encode("ascii", "ignore")

metadata_utils-1.0.0.dist-info/METADATA

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: metadata_utils
+Version: 1.0.0
+Summary: Lightweight Metadata Support
+Home-page: https://github.com/jvanasco/metadata_utils
+Author: Jonathan Vanasco
+Author-email: jvanasco@2xlp.com
+License: MIT
+Keywords: web
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: testing
+Requires-Dist: pytest; extra == "testing"
+Requires-Dist: mypy; extra == "testing"
+Dynamic: license-file
+
+![Python package](https://github.com/jvanasco/metadata_utils/workflows/Python%20package/badge.svg)
+
+metadata_utils
+==============
+
+This package offers lightweight tools for dealing with metadata in HTML.
+
+## Quoted HTML attributes
+
+Use `html_attribute_escape` on text before inserting it into a quoted HTML
+attribute.
+
+```python
+from metadata_utils import html_attribute_escape, html_attribute_unescape
+
+title = 'Fish & "Chips"'
+escaped = html_attribute_escape(title)
+assert f'<span title="{escaped}"></span>' == (
+    '<span title="Fish &amp; &quot;Chips&quot;"></span>'
+)
+assert html_attribute_unescape(escaped) == title
+```
+
+`html_attribute_unescape` decodes one layer of the five named entities emitted
+by the escape function (`&amp;`, `&lt;`, `&gt;`, `&quot;`, and `&apos;`).
+Other named and numeric references pass through unchanged.
+
+## ASCII normalization
+
+Both helpers apply Unicode normalization, drop any remaining non-ASCII
+characters, and return `bytes`. Both expand the `fi` ligature into `fi`.
+NFKD decomposes `é` so the ASCII `e` survives. NFKC keeps the composed
+`é`, which is dropped during ASCII encoding.
+
+```python
+from metadata_utils import force_clean_ascii_NFKC, force_clean_ascii_NFKD
+
+assert force_clean_ascii_NFKD("fi café") == b"fi cafe"
+assert force_clean_ascii_NFKC("fi café") == b"fi caf"
+```

metadata_utils-1.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+metadata_utils/__init__.py,sha256=4RQRccBLVi4xSRzE4SajOnML1f9DRdrKg4CFLp46kE4,1326
+metadata_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+metadata_utils-1.0.0.dist-info/licenses/LICENSE,sha256=We9VXp3Rba9vYbeWWEX6B5IX7E51lMXnerTQm7O64s0,1105
+metadata_utils-1.0.0.dist-info/METADATA,sha256=JE2Kl76qdn3sQSBOiubWl8xyKuUxrllL8okotuipe4s,2377
+metadata_utils-1.0.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+metadata_utils-1.0.0.dist-info/top_level.txt,sha256=856ves0QhFzSuRhgtFZwDp6O6XT1_Mxq8f2wE0NAkpE,15
+metadata_utils-1.0.0.dist-info/RECORD,,

metadata_utils-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

metadata_utils-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 "jonathan vanasco <jonathan@2xlp.com>"
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

metadata_utils-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+metadata_utils