yaml-serializer 1.0.0__tar.gz

yaml_serializer-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

yaml_serializer-1.0.0/PKG-INFO

@@ -0,0 +1,357 @@
+Metadata-Version: 2.4
+Name: yaml-serializer
+Version: 1.0.0
+Summary: Secure YAML loader/dumper with !include support, change tracking, and round-trip preservation
+Author-email: Dmitry Chernikov <d.chernikov@tk-chel.ru>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/cherninkiy/protocollab
+Project-URL: Repository, https://github.com/cherninkiy/protocollab
+Project-URL: Source, https://github.com/cherninkiy/protocollab/tree/main/src/yaml_serializer
+Keywords: yaml,serializer,include,round-trip,security
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ruamel-yaml>=0.17.0
+Dynamic: license-file
+
+# yaml_serializer
+
+**A secure YAML loader/dumper with `!include` support, change tracking, and round‑trip preservation**  
+*Part of the [`protocollab`](https://github.com/cherninkiy/protocollab) framework.*
+
+`yaml_serializer` is a Python library built on top of `ruamel.yaml` that provides a safe, production‑ready way to load, modify, and save YAML files. It is the foundation of `protocollab`'s protocol definition handling, but can also be used independently in any Python project that needs robust YAML processing.
+
+---
+
+## ✨ Key Features
+
+- 🔒 **Security‑first loading** – protects against path traversal, billion laughs, and arbitrary code execution via YAML tags.  
+- 🔗 **`!include` tag** – split large YAML files into reusable components.  
+- 📝 **Round‑trip preservation** – comments, quotes, and formatting are kept intact when dumping.  
+- 🔄 **Change tracking** – automatic dirty marking and hash‑based change detection for efficient saving.  
+- 🧩 **Easy modification** – helper functions to modify YAML structures while maintaining parent links and dirty flags.  
+- 🔀 **Smart file renaming** – automatically updates `!include` paths when files are renamed.  
+- ✅ **High test coverage** (100%) – battle‑tested and ready for production use.
+
+---
+
+## 📦 Installation
+
+Install the standalone package:
+
+```bash
+pip install yaml-serializer
+```
+
+Install the whole framework when you also need the generators and CLI:
+
+```bash
+pip install protocollab
+```
+
+For development directly from this repository, either install the full monorepo from the repository root or install this package in editable mode:
+
+```bash
+pip install -e src/yaml_serializer
+```
+
+After installation, import it as:
+
+```python
+from yaml_serializer import SerializerSession
+```
+
+> **Note:** `yaml_serializer` requires Python 3.10 or later.
+
+---
+
+## 🚀 Quick Start
+
+```python
+from yaml_serializer import SerializerSession
+from yaml_serializer.modify import add_to_dict
+
+# Create a session (encapsulates all state — thread-safe and test-friendly)
+session = SerializerSession()
+
+# Load a YAML file (all !include references are resolved automatically)
+data = session.load("path/to/file.yaml")
+
+# Modify the structure (parent links and dirty flags are updated automatically)
+add_to_dict(data, "new_key", "new_value")
+
+# Save only changed files, preserving all comments and formatting
+session.save()
+```
+
+---
+
+## 📁 Module Structure
+
+```
+yaml_serializer/
+├── __init__.py           # Public API exports
+├── serializer.py         # SerializerSession, loading, saving, renaming
+├── safe_constructor.py   # Restricted YAML constructor and safety limits
+├── modify.py             # Helpers for mutating YAML trees with dirty tracking
+├── utils.py              # Path checks, hashing, include helpers, dirty propagation
+└── tests/                # Test suite for loading, includes, security, and sessions
+```
+
+---
+
+## 📚 Detailed Examples
+
+### Working with `!include`
+
+**person.yaml**
+```yaml
+name: Alice
+age: 30
+```
+
+**main.yaml**
+```yaml
+team:
+  lead: !include person.yaml
+```
+
+```python
+from yaml_serializer import SerializerSession
+
+session = SerializerSession()
+data = session.load("main.yaml")
+print(data["team"]["lead"]["name"])  # prints "Alice"
+```
+
+### Modifying nested structures
+
+```python
+from yaml_serializer import SerializerSession
+from yaml_serializer.modify import add_to_dict
+
+session = SerializerSession()
+data = session.load('protocol.yaml')
+
+# Add a new field to a nested type
+add_to_dict(data['types']['Message'], 'timestamp', 'u64')
+
+# Add a new type definition (will mark the file as dirty)
+add_to_dict(data['types'], 'NewType', {'field': 'value'})
+
+# Save only changed files
+session.save(only_if_changed=True)
+```
+
+### Secure loading with custom limits
+
+```python
+from yaml_serializer import SerializerSession
+
+config = {
+    'max_file_size': 5 * 1024 * 1024,   # 5 MB
+    'max_struct_depth': 20,               # max YAML nesting depth (default 50)
+    'max_include_depth': 20,              # max !include nesting depth (default 50)
+    'max_imports': 50                      # max number of included files (default 100)
+}
+
+# Config can be given at construction time (applies to every load call) …
+session = SerializerSession(config)
+data = session.load('protocol.yaml')
+
+# … or overridden per-load:
+data = session.load('protocol.yaml', config={'max_imports': 10})
+```
+
+### Renaming files with automatic `!include` updates
+
+```python
+from yaml_serializer import SerializerSession
+
+session = SerializerSession()
+session.load('main.yaml')
+
+# Rename an included file – all !include references are automatically updated
+session.rename('old_name.yaml', 'new_name.yaml')
+
+session.save()
+```
+
+### Multiple independent sessions
+
+```python
+from yaml_serializer import SerializerSession
+
+# Two sessions can load the same (or different) files without interfering:
+session_a = SerializerSession()
+session_b = SerializerSession()
+
+data_a = session_a.load('spec_v1.yaml')
+data_b = session_b.load('spec_v2.yaml')
+
+# Modifications to data_a are invisible to session_b and vice-versa.
+```
+
+---
+
+## 📖 API Reference
+
+### `SerializerSession` (primary API)
+
+```python
+from yaml_serializer import SerializerSession
+```
+
+Each instance is completely independent — thread-safe, reusable, and isolated from
+other sessions.
+
+#### `SerializerSession(config: Optional[dict] = None)`
+Create a session with optional default configuration.
+
+| Key | Default | Description |
+|-----|---------|-------------|
+| `max_file_size` | 10 MB | Maximum file size in bytes |
+| `max_struct_depth` | 50 | Maximum YAML nesting depth |
+| `max_include_depth` | 50 | Maximum `!include` chain depth |
+| `max_imports` | 100 | Maximum total included files |
+
+#### `session.load(path: str, config: Optional[dict] = None) -> CommentedMap`
+Load *path* and all `!include` references. *config* overrides per-call defaults.
+
+#### `session.save(only_if_changed: bool = True)`
+Write modified files back to disk.
+
+#### `session.rename(old_path: str, new_path: str)`
+Rename a file and update all `!include` references to it.
+
+#### `session.propagate_dirty(file_path: str)`
+Mark as dirty all files that `!include` *file_path*.
+
+#### `session.clear()`
+Reset all loaded state. Configuration defaults are preserved.
+
+---
+
+The public helper functions exported from `yaml_serializer` complement the
+session API and automatically update parent links and dirty flags.
+
+- `new_commented_map(initial: Optional[dict] = None, parent: Optional[Node] = None) -> CommentedMap`
+- `new_commented_seq(initial: Optional[list] = None, parent: Optional[Node] = None) -> CommentedSeq`
+- `add_to_dict(target: CommentedMap, key: str, value: Any)`
+- `update_in_dict(target: CommentedMap, key: str, value: Any)`
+- `remove_from_dict(target: CommentedMap, key: str)`
+- `add_to_list(target: CommentedSeq, value: Any)`
+- `remove_from_list(target: CommentedSeq, index: int)`
+- `get_node_hash(node: Union[CommentedMap, CommentedSeq]) -> str` – returns the node’s hash (recalculates if dirty).
+
+The lower-level internals in `safe_constructor.py` and most of `serializer.py`
+are implementation details of the current codebase. When using the library
+directly, prefer `SerializerSession` plus the re-exported helpers from
+`yaml_serializer`.
+
+---
+
+## 🛡️ Public API Stability
+
+The following functions from `yaml_serializer.utils` are part of the stable
+advanced-use API for `yaml_serializer 1.0.0` and are covered by
+backward-compatibility guarantees for the `yaml_serializer 1.x` line:
+
+- `canonical_repr`
+- `compute_hash`
+- `resolve_include_path`
+- `is_path_within_root`
+- `mark_node`
+- `mark_dirty`
+- `clear_dirty`
+- `update_file_attr`
+- `replace_included`
+- `mark_includes`
+
+These functions are exported via `yaml_serializer.utils.__all__` and marked with
+the `_stable_api` metadata decorator in the source.
+
+Helpers prefixed with `_` are internal implementation details and may change
+without notice.
+
+---
+
+## 🛡️ Security
+
+`yaml_serializer` was designed with security as a first‑class concern, addressing the shortcomings of many YAML libraries:
+
+- **Restricted YAML tags** – only the custom `!include` tag is allowed; all others (including dangerous Python‑specific tags) are rejected.
+- **File size limit** – prevents memory exhaustion attacks (configurable, default 10 MB).
+- **Nesting depth limit** – prevents stack overflow from deeply nested structures (default 50).
+- **Path traversal protection** – `!include` can only reference files inside the project root (or an explicitly allowed directory).
+- **Circular import detection** – prevents infinite recursion.
+- **Import count limit** – stops bomb‑style attacks with thousands of inclusions (default 100).
+
+These measures make `yaml_serializer` suitable for processing untrusted YAML files – a key advantage over many alternatives.
+
+---
+
+## 🧪 Testing & Coverage
+
+The module has an extensive test suite covering all critical paths.
+
+- **Test suite**: extensive coverage of critical paths  
+- **Code coverage**: 100% (yaml_serializer)  
+- **Structure**: thematic test modules + `conftest.py` (shared fixtures)
+
+To run tests locally from the package directory:
+
+```bash
+pytest tests/ --cov=yaml_serializer
+```
+
+For more detailed output:
+
+```bash
+pytest tests/ -v --cov=yaml_serializer --cov-report=term-missing
+```
+
+---
+
+## 🔧 Development Setup
+
+```bash
+# Clone the repository (if not already done)
+git clone https://github.com/cherninkiy/protocollab
+cd protocollab/src/yaml_serializer
+
+# Install the package in editable mode
+pip install -e .
+
+# Run tests
+pytest tests/
+```
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please read our [Contributing Guidelines](../../CONTRIBUTING.md) and [Code of Conduct](../../CODE_OF_CONDUCT.md) before submitting a pull request.
+
+If you discover a security vulnerability, **do not** open a public issue; instead, please follow the steps outlined in our [Security Policy](../../SECURITY.md).
+
+---
+
+## 📄 License
+
+`yaml_serializer` is released under the **Apache License 2.0**. A local copy is
+available in [LICENSE](LICENSE), and the repository root also contains the
+canonical project license text in [../../LICENSE](../../LICENSE).
+
+---
+
+## 🙏 Acknowledgements
+
+Built on the shoulders of [ruamel.yaml](https://yaml.readthedocs.io/), [pydantic](https://docs.pydantic.dev/), and the Python community.