endec 0.5.1__cp310-cp310-manylinux_2_24_aarch64.whl

endec/__init__.py

@@ -0,0 +1,5 @@
+from ._endec import encode, decode
+from . import _endec
+
+__doc__ = _endec.__doc__
+__all__ = ["encode", "decode"]

endec/_endec.pyi

@@ -0,0 +1,20 @@
+from typing import Literal
+
+EncodeErrorHandler = Literal["strict", "xmlcharrefreplace"]
+DecodeErrorHandler = Literal["strict", "replace"]
+DecodeBomHandler = Literal["evaluate", "evaluateall", "strip", "ignore"]
+
+def encode(
+    input_str: str,
+    /,
+    encoding: str = "utf-8",
+    errors: EncodeErrorHandler = "strict",
+) -> bytes: ...
+def decode(
+    input_bytes: bytes,
+    /,
+    encoding: str = "utf-8",
+    errors: DecodeErrorHandler = "strict",
+    *,
+    bom: DecodeBomHandler = "evaluate",
+) -> str: ...

endec/exceptions.py

@@ -0,0 +1,44 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from typing import Optional
+
+
+class DecodeError(UnicodeError):
+    encoding: str
+    target: bytes
+    reason: "Optional[str]"
+
+    def __init__(
+        self, encoding: str, target: bytes, reason: "Optional[str]" = None, /
+    ) -> None:
+        self.encoding = encoding
+        self.target = target
+        self.reason = reason
+
+    def __str__(self) -> str:
+        reason = ""
+        if self.reason:
+            reason = self.reason + "\n"
+
+        return reason + f"decoding with '{self.encoding}' codec failed"
+
+
+class EncodeError(UnicodeError):
+    encoding: str
+    target: str
+    reason: "Optional[str]"
+
+    def __init__(
+        self, encoding: str, target: str, reason: "Optional[str]" = None, /
+    ) -> None:
+        self.encoding = encoding
+        self.target = target
+        self.reason = reason
+
+    def __str__(self) -> str:
+        reason = ""
+        if self.reason:
+            reason = self.reason + "\n"
+
+        return reason + f"encoding with '{self.encoding}' codec failed"

endec-0.5.1.dist-info/METADATA

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: endec
+Version: 0.5.1
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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 :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Utilities
+License-File: LICENSE
+Summary: Web-compatible encoding and decoding library
+Keywords: encoding_rs,web,codec
+Author-email: Thitat Auareesuksakul <flux@thitat.net>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://github.com/fluxth/endec/releases
+Project-URL: Homepage, https://github.com/fluxth/endec
+Project-URL: Source, https://github.com/fluxth/endec
+
+# endec
+
+[![PyPI - Version](https://img.shields.io/pypi/v/endec)](https://pypi.org/project/endec/)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/endec)
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/fluxth/endec/build.yml)
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/fluxth/endec/test.yml?label=tests)
+
+Web-compatible **en**coding and **dec**oding library
+
+**endec** uses [`encoding_rs`](https://github.com/hsivonen/encoding_rs) (which powers Firefox) under the hood.
+
+## Supported Python versions
+
+- CPython 3.8 or higher
+- PyPy 3.11 or higher
+
+## Installation
+
+### Using [uv package manager](https://github.com/astral-sh/uv) (recommended)
+
+```bash
+uv add endec
+```
+
+### Using [Poetry package manager](https://github.com/python-poetry/poetry)
+
+```bash
+poetry add endec
+```
+
+### Using pip
+
+```bash
+pip install endec
+```
+
+## Examples
+
+### Codecs
+
+Please refer to [WHATWG Web Encoding Standard](https://encoding.spec.whatwg.org/#concept-encoding-get) for available codecs.
+
+### Encode
+
+```python
+import endec
+
+utf8_bytes = endec.encode("こんにちは")
+assert utf8_bytes == b"\xe3\x81\x93\xe3\x82\x93\xe3\x81\xab\xe3\x81\xa1\xe3\x81\xaf"
+
+iso2022jp_bytes = endec.encode("㊤㊥㊦", "iso-2022-jp")
+assert iso2022jp_bytes == b"\x1b$B-e-f-g\x1b(B"
+
+"㊤㊥㊦".encode("iso-2022-jp")  # Standard Library `encode`
+# UnicodeEncodeError: 'iso2022_jp' codec can't encode character '\u32a4' in position 0: illegal multibyte sequence
+```
+
+### Decode
+
+```python
+import endec
+
+utf8_str = endec.decode(b"\xe3\x81\x93\xe3\x82\x93\xe3\x81\xab\xe3\x81\xa1\xe3\x81\xaf")
+assert utf8_str == "こんにちは"
+
+iso2022jp_str = endec.decode(b"\x1b$B-e-f-g\x1b(B", "iso-2022-jp")
+assert iso2022jp_str == "㊤㊥㊦"
+
+b"\x1b$B-e-f-g\x1b(B".decode("iso-2022-jp")  # Standard Library `decode`
+# UnicodeDecodeError: 'iso2022_jp' codec can't decode bytes in position 3-4: illegal multibyte sequence
+```
+
+### Error Handling
+
+```python
+import endec
+from endec.exceptions import EncodeError, DecodeError
+
+try:
+    invalid_encode = endec.encode("漢字", "ascii")
+except EncodeError as exc:
+    # endec.exceptions.EncodeError: encoding with 'windows-1252' codec failed
+    raise exc
+
+try:
+    invalid_decode = endec.decode(b"\x42\xff\x42", "iso-2022-jp")
+except DecodeError as exc:
+    # endec.exceptions.DecodeError: decoding with 'ISO-2022-JP' codec failed
+    raise exc
+```
+
+## License
+
+This project is licensed under the terms of the [MIT license](https://github.com/fluxth/endec/blob/main/LICENSE).
+

endec-0.5.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+endec/__init__.py,sha256=QHs4ebnMRPpR5cUVLh4FpZLdlc0ooJBgLgk83mw_iaA,113
+endec/_endec.cpython-310-aarch64-linux-gnu.so,sha256=SCrppekLe9KzthY6BH_YtND4_bznwjAz10vcR5XGo3M,857680
+endec/_endec.pyi,sha256=93qe9Ra7ZsUiL2vfv-2_Gz2G8PrtKofjioxLOlK7AV8,515
+endec/exceptions.py,sha256=0vllesQZ3btKIArFIPyccwTHfSMxenbYsaQUIH717oY,1060
+endec/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+endec-0.5.1.dist-info/METADATA,sha256=Tq5uuiJAxQzYrSxEZ1G9otxiAYRrSHoge8yux-0atQE,3915
+endec-0.5.1.dist-info/WHEEL,sha256=kQux7wO-30csvTekiYoC_esFcWQsxSalJPZydrf2nyc,110
+endec-0.5.1.dist-info/licenses/LICENSE,sha256=Dix8fgnEM4M0liTQ0rUrcP-Qon1T4G_IHBXFRNiIyxg,1064
+endec-0.5.1.dist-info/RECORD,,

endec-0.5.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.11.0)
+Root-Is-Purelib: false
+Tag: cp310-cp310-manylinux_2_24_aarch64

endec-0.5.1.dist-info/licenses/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 fluxth
+
+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.
+