ryaml 0.5.0__cp310-cp310-macosx_11_0_arm64.whl

ryaml/__init__.py

@@ -0,0 +1 @@
+from ._ryaml import InvalidYamlError, load, load_all, loads, loads_all, dump, dumps

ryaml/_ryaml.pyi

@@ -0,0 +1,13 @@
+# pyright: strict
+from typing import Any, AnyStr, IO
+
+class InvalidYamlError(ValueError): ...
+
+def load(fp: IO[AnyStr]) -> Any: ...
+def load_all(fp: IO[AnyStr]) -> list[Any]: ...
+
+def loads(s: str) -> Any: ...
+def loads_all(s: str) -> list[Any]: ...
+
+def dump(fp: IO[AnyStr], obj: Any) -> None: ...
+def dumps(obj: Any) -> str: ...

ryaml-0.5.0.dist-info/METADATA

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: ryaml
+Version: 0.5.0
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Rust
+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: Development Status :: 3 - Alpha
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Typing :: Typed
+License-File: LICENSE
+Summary: A simple yaml serializer and deserializer using Rust.
+Keywords: yaml,parsing
+Author-email: Emma Harper Smith <emma@emmatyping.dev>
+License: MIT
+Requires-Python: >=3.10, <4
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: homepage, https://github.com/emmatyping/ryaml
+Project-URL: repository, https://github.com/emmatyping/ryaml
+
+ryaml
+=====
+
+### *Quickly and safely parse yaml*
+
+### What is ryaml?
+
+ryaml is a Python library that wraps a Rust yaml parser, [serde-yaml](https://github.com/dtolnay/serde-yaml), to quickly and safely parse and dump yaml to and from Python objects.
+
+It is *not* compatible with PyYAML, and it has a similar design to the `json` module. Furthermore PyYAML implements version 1.1 of the yaml spec whereas ryaml implements version 1.2 of the spec.
+
+Notable differences between version 1.1 and 1.2 are
+
+- YAML 1.2 dropped support for several features unquoted `Yes`,
+  `No`, `On`, `Off`
+- YAML 1.2 no longer accepts strings that start with a `0` and solely
+  consist of number characters as octal, you need to specify such strings with
+  `0o[0-7]+` (zero + lower-case o for octal + one or more octal characters).
+- YAML 1.2 no longer supports `sexagesimals
+  <https://en.wikipedia.org/wiki/Sexagesimal>`_, so the string scalar
+  `12:34:56` doesn't need quoting.
+- `\/` escape for JSON compatibility
+- correct parsing of floating point scalars with exponentials
+
+The hope is this will be used as a safe and fast yaml parser in lieu of PyYAML.
+
+## Installation
+
+We ship binary wheels for Windows, Linux, and macOS, so as long as you are using Python 3.10+,
+you can run:
+
+```
+$ python -m pip install ryaml
+```
+
+Otherwise, you will need to build from source. To do so, first install Rust 1.41 stable.
+
+Then you should be able to just
+
+```shell
+$ git clone https://github.com/emmatyping/ryaml
+$ cd ryaml
+$ python -m pip install .
+```
+
+Or if you want to build a wheel:
+
+```shell
+$ git clone https://github.com/emmatyping/ryaml
+$ cd ryaml
+$ python -m pip install maturin
+$ maturin build --release --no-sdist
+# OR if you want an abi3 wheel (compatible with Python 3.10+)
+$ maturin build --release --no-sdist --cargo-extra-args="--features=abi3"
+```
+
+And a wheel will be created in `target/wheels` which you can install.
+
+## Usage
+
+The API of `ryaml` is very similar to that of `json` in the standard library:
+
+You can use `ryaml.loads` to read from a `str`:
+
+```python
+import ryaml
+obj = ryaml.loads('key: [10, "hi"]')
+assert isinstance(obj, dict) # True
+assert obj['key'][1] == "hi" # True
+```
+
+And `ryaml.dumps` to dump an object into a yaml file:
+
+```python
+import ryaml
+s = ryaml.dumps({ 'key' : None })
+print(s)
+# prints:
+# ---
+# key: ~
+```
+
+There are also `ryaml.load` and `ryaml.load_all` to read yaml document(s) from files:
+
+```python
+import ryaml
+obj = {'a': [{'b': 1}]}
+with open('test.yaml', 'w') as w:
+    ryaml.dump(w, obj)
+with open('test.yaml', 'r') as r:
+    assert ryaml.load(r) == obj
+with open('multidoc.yaml', 'w') as multi:
+    multi.write('''
+---
+a:
+  key:
+...
+---
+b:
+  key:
+    ''')
+with open('multidoc.yaml', 'r') as multi:
+    docs = ryaml.load_all(multi)
+assert len(docs) == 2
+assert docs[0]['a']['key'] is None
+```
+
+`ryaml.load_all` will, as seen above, load multiple documents from a single file.
+
+
+## Thanks
+
+This project is standing on the shoulders of giants, and would not be possible without:
+
+[pyo3](https://pyo3.rs/)
+
+[serde-yaml](https://github.com/dtolnay/serde-yaml)
+
+[yaml-rust](https://github.com/chyh1990/yaml-rust)
+
+[pyo3-file](https://github.com/omerbenamram/pyo3-file)
+
+[pythonize](https://github.com/davidhewitt/pythonize)
+

ryaml-0.5.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+ryaml/_ryaml.cpython-310-darwin.so,sha256=ZFGDTd4A3icpqBE2D1P1CfnlRh2RRH0IXDhuCM7KtQA,892048
+ryaml/__init__.py,sha256=Fop8SKMTpEwcVrFlf17BzSzplE_nOQsMcJHPMNw4enM,84
+ryaml/_ryaml.pyi,sha256=uhhaBiCq-6Let3BpSOcgJ0COqc-oulbHQ01MAQaxYhM,331
+ryaml/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ryaml-0.5.0.dist-info/RECORD,,
+ryaml-0.5.0.dist-info/WHEEL,sha256=Sp6ArW1hHb0TD2pIatr9ldysDxi0aO68XlZfkI55pLw,133
+ryaml-0.5.0.dist-info/METADATA,sha256=At4zO-SbpxzeISRQkAq_Bg5u6EAoIAqbkXKuCd7PF14,4249
+ryaml-0.5.0.dist-info/licenses/LICENSE,sha256=52M823F7Jiop4_cMBCNgKDnFRK2oTnahO_3vGYAzX3Y,1051

ryaml-0.5.0.dist-info/WHEEL

@@ -0,0 +1,6 @@
+Wheel-Version: 1.0
+Generator: maturin (1.10.2)
+Root-Is-Purelib: false
+Tag: cp310-cp310-macosx_11_0_arm64
+Generator: delocate 0.13.0
+

ryaml-0.5.0.dist-info/licenses/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021 Ethan Smith
+
+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.