toml-rs 0.3.0__cp314-cp314-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

toml_rs/__init__.py

@@ -0,0 +1,19 @@
+__all__ = (
+    "TOMLDecodeError",
+    "TOMLEncodeError",
+    "__version__",
+    "dump",
+    "dumps",
+    "load",
+    "loads",
+)
+
+from ._lib import (
+    TOMLDecodeError,
+    TOMLEncodeError,
+    __version__,
+    dump,
+    dumps,
+    load,
+    loads,
+)

toml_rs/_lib.py

@@ -0,0 +1,106 @@
+from collections.abc import Callable
+from pathlib import Path
+from typing import Any, BinaryIO, Literal, TextIO, TypeAlias
+
+from ._toml_rs import (
+    _VERSION,
+    _dumps,
+    _loads,
+)
+
+__version__: str = _VERSION
+
+TomlVersion: TypeAlias = Literal["1.0.0", "1.1.0"]
+
+DEFAULT_TOML_VERSION = "1.0.0"
+
+
+def load(
+    fp: BinaryIO,
+    /,
+    *,
+    parse_float: Callable[[str], Any] = float,
+    toml_version: TomlVersion = DEFAULT_TOML_VERSION,
+) -> dict[str, Any]:
+    toml_bytes = fp.read()
+    try:
+        toml_str = toml_bytes.decode()
+    except AttributeError:
+        msg = "File must be opened in binary mode, e.g. use `open('foo.toml', 'rb')`"
+        raise TypeError(msg) from None
+    return loads(toml_str, parse_float=parse_float, toml_version=toml_version)
+
+
+def loads(
+    s: str,
+    /,
+    *,
+    parse_float: Callable[[str], Any] = float,
+    toml_version: TomlVersion = DEFAULT_TOML_VERSION,
+) -> dict[str, Any]:
+    if not isinstance(s, str):
+        msg = f"Expected str object, not '{type(s).__qualname__}'"
+        raise TypeError(msg)
+    return _loads(s, parse_float=parse_float, toml_version=toml_version)
+
+
+def dump(
+    obj: Any,
+    /,
+    file: str | Path | TextIO,
+    inline_tables: set[str] | None = None,
+    *,
+    pretty: bool = False,
+    toml_version: TomlVersion = DEFAULT_TOML_VERSION,
+) -> int:
+    toml_str = _dumps(
+        obj,
+        inline_tables=inline_tables,
+        pretty=pretty,
+        toml_version=toml_version,
+    )
+    if isinstance(file, str):
+        file = Path(file)
+    if isinstance(file, Path):
+        return file.write_text(toml_str, encoding="utf-8")
+
+    return file.write(toml_str)
+
+
+def dumps(
+    obj: Any,
+    /,
+    inline_tables: set[str] | None = None,
+    *,
+    pretty: bool = False,
+    toml_version: TomlVersion = DEFAULT_TOML_VERSION,
+) -> str:
+    return _dumps(
+        obj,
+        inline_tables=inline_tables,
+        pretty=pretty,
+        toml_version=toml_version,
+    )
+
+
+class TOMLDecodeError(ValueError):
+    def __init__(self, msg: str, doc: str, pos: int, *args: Any) -> None:
+        msg = msg.rstrip()
+        super().__init__(msg)
+        lineno = doc.count("\n", 0, pos) + 1
+        if lineno == 1:  # noqa: SIM108
+            colno = pos + 1
+        else:
+            colno = pos - doc.rindex("\n", 0, pos)
+        self.msg = msg
+        self.doc = doc
+        self.pos = pos
+        self.colno = colno
+        self.lineno = lineno
+
+
+class TOMLEncodeError(TypeError):
+    def __init__(self, msg: str, *args: Any) -> None:
+        msg = msg.rstrip()
+        super().__init__(msg)
+        self.msg = msg

toml_rs/_toml_rs.pyi

@@ -0,0 +1,23 @@
+from collections.abc import Callable
+from typing import Any, Literal, TypeAlias
+
+_VERSION: str
+
+TomlVersion: TypeAlias = Literal["1.0.0", "1.1.0"]
+
+def _loads(
+    s: str,
+    /,
+    *,
+    parse_float: Callable[[str], Any] = ...,
+    toml_version: TomlVersion = ...,
+) -> dict[str, Any]: ...
+
+def _dumps(
+    obj: Any,
+    /,
+    inline_tables: set[str] | None = None,
+    *,
+    pretty: bool = False,
+    toml_version: TomlVersion = ...,
+) -> str: ...

toml_rs/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561

toml_rs-0.3.0.dist-info/METADATA

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: toml-rs
+Version: 0.3.0
+Classifier: Typing :: Typed
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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 :: PyPy
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
+License-File: UNLICENSE
+Summary: A High-Performance TOML Parser for Python written in Rust
+Author-email: chirizxc <chirizxc@proton.me>
+Maintainer-email: chirizxc <chirizxc@proton.me>
+License-Expression: UNLICENSE
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Bug Tracker, https://github.com/lava-sh/toml-rs/issues
+Project-URL: Homepage, https://github.com/lava-sh/toml-rs
+Project-URL: Source, https://github.com/lava-sh/toml-rs
+
+<div align="center">
+
+# toml-rs
+
+*A High-Performance TOML v1.0.0 and v1.1.0 parser for Python written in Rust*
+
+[![PyPI License](https://img.shields.io/pypi/l/toml_rs.svg?style=flat-square)](https://pypi.org/project/toml_rs/)
+
+[![Monthly downloads](https://img.shields.io/pypi/dm/toml_rs.svg?style=flat-square)](https://pypi.org/project/toml_rs/)
+[![Github Repository size](https://img.shields.io/github/repo-size/lava-sh/toml-rs?style=flat-square)](https://github.com/lava-sh/toml-rs)
+
+[![Python version](https://img.shields.io/pypi/pyversions/toml_rs.svg?style=flat-square)](https://pypi.org/project/toml_rs/)
+[![Implementation](https://img.shields.io/pypi/implementation/toml_rs.svg?style=flat-square)](https://pypi.org/project/toml_rs/)
+
+</div>
+
+## Features
+
+* The fastest TOML parser in Python (see [benchmarks](https://github.com/lava-sh/toml-rs/tree/main/benchmark))
+
+* Drop-in compatibility with most [`tomllib`](https://docs.python.org/3/library/tomllib.html) use cases (see [below](#differences-with-tomllib))
+
+## Installation
+
+```bash
+# Using pip
+pip install toml-rs
+
+# Using uv
+uv pip install toml-rs
+```
+
+## Examples
+
+```python
+import tomllib
+from pprint import pprint
+
+import toml_rs
+
+toml = """\
+title = "TOML Example"
+
+[owner]
+name = "Tom Preston-Werner"
+dob = 1979-05-27T07:32:00-08:00
+
+[database]
+enabled = true
+ports = [ 8000, 8001, 8002 ]
+data = [ ["delta", "phi"], [3.14] ]
+temp_targets = { cpu = 79.5, case = 72.0 }
+
+[servers]
+[servers.alpha]
+ip = "10.0.0.1"
+role = "frontend"
+[servers.beta]
+ip = "10.0.0.2"
+role = "backend"
+"""
+
+tomllib_loads = tomllib.loads(toml)
+toml_rs_loads = toml_rs.loads(toml)
+toml_rs_dumps = toml_rs.dumps(toml_rs_loads)
+
+assert tomllib_loads == toml_rs_loads
+
+print("toml_rs.loads:")
+pprint(toml_rs_loads)
+print("toml_rs.dumps:")
+print(toml_rs_dumps)
+```
+
+## Differences with [`tomllib`](https://docs.python.org/3/library/tomllib.html)
+
+1. More understandable errors
+
+```python
+import tomllib
+
+t = """\
+x = 1
+y = 2
+v = 
+"""
+print(tomllib.loads(t))
+# tomllib.TOMLDecodeError: Invalid value (at line 3, column 5)
+```
+
+```python
+import toml_rs
+
+t = """\
+x = 1
+y = 2
+v = 
+"""
+print(toml_rs.loads(t))
+# toml_rs.TOMLDecodeError: TOML parse error at line 3, column 5
+#   |
+# 3 | v = 
+#   |     ^
+# string values must be quoted, expected literal string
+```
+
+2. Supports serialization (`toml_rs.dumps` and `toml_rs.dump`)
+
+```python
+from pathlib import Path
+
+import toml_rs
+
+data = {
+    "title": "TOML Example",
+    "owner": {"name": "Alice", "age": 30},
+}
+
+print(toml_rs.dumps(data))
+
+toml_rs.dump(data, Path("example.toml"))  
+# or `toml_rs.dump(data, "example.toml")`
+```
+

toml_rs-0.3.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+toml_rs/__init__.py,sha256=dRwvPSgcaZjVowudfW6q_UGwDG1f6WLjV99NePVGkW4,253
+toml_rs/_lib.py,sha256=xHMj-pdpEaeOBiBVFaE9kBxEh5W35TDwASi06pLmQPo,2602
+toml_rs/_toml_rs.cpython-314-aarch64-linux-gnu.so,sha256=vUuE8jtk-xCZlzTyI1sgemwYt4zr_5Xxpx8fiL8kUis,866384
+toml_rs/_toml_rs.pyi,sha256=slZGAC5NggSMGqA_tooNhdZDJaS_o8_MbqCebPWl22A,454
+toml_rs/py.typed,sha256=8ZJUsxZiuOy1oJeVhsTWQhTG_6pTVHVXk5hJL79ebTk,25
+toml_rs-0.3.0.dist-info/METADATA,sha256=th7K2yjkl7S6TAmtyZ1K8P35R6uN267WeleiZWdpEUw,3832
+toml_rs-0.3.0.dist-info/WHEEL,sha256=Fx-7UOgjfhtK3XXmysArRGq3lEQiAORUMl6jtPUmCMs,149
+toml_rs-0.3.0.dist-info/licenses/UNLICENSE,sha256=yiq99pWITHfqS0pbZMp7cy2dnbreTuvBwudsU-njvIM,1210
+toml_rs-0.3.0.dist-info/RECORD,,

toml_rs-0.3.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: maturin (1.11.5)
+Root-Is-Purelib: false
+Tag: cp314-cp314-manylinux_2_17_aarch64
+Tag: cp314-cp314-manylinux2014_aarch64

toml_rs-0.3.0.dist-info/licenses/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>