omextra 0.0.0.dev472__py3-none-any.whl → 0.0.0.dev492__py3-none-any.whl

omextra/formats/goyaml/LICENSE

@@ -0,0 +1,16 @@
+MIT License
+
+Copyright (c) 2019 Masaaki Goshima
+
+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.

omextra/formats/goyaml/__init__.py

@@ -0,0 +1,29 @@
+"""
+A *manual*, near-direct, 'lite'-compatible translation of go-yaml (see LICENSE file):
+
+  https://github.com/goccy/go-yaml/tree/25e5d9094248e480434ca87d9119e3d9ce7ac1d7
+
+The primary reasons for.. doing this.. are as follows:
+
+ - Most importantly for '@omlish-lite' usage - yaml parsing is, whether we like it or not, here to stay for things like
+   docker-compose - and reading these files in amalgamated scripts like omdev.ci and omdev.pyproject is a hard
+   requirement for them.
+
+   Currently they require a system dependency on pyyaml, which violates amalg/lite isolation, and nearly defeats the
+   whole point of it. An alternative is relying on some system utility (as they already rely om some very basic shell
+   utilities), but there is no remotely standard or common yaml-to-json utility.
+
+   An obvious alternative would be shamefully implement the '10% of yaml that covers 95% of usecases' with a garbage
+   pile of regexes, but this codebase itself already uses anchors in its compose.yml, at which point (given the
+   potential failure modes of automated infra machinery) that's extremely not acceptable.
+
+ - Additionally, as giant yaml files are so pervasive these days, it's useful to be able to programmatically parse and
+   manipulate them with full, perfect preservation of all stylistic choices, whitespace, comments, etc. This is already
+   partially done here by wrapping pyyaml nodes, but it's not complete and very fragile.
+
+It should remain symmetry with the go-yaml codebase to allow for backporting of updates. Specifically:
+ - The layout of the code in the source files, down to the order of their contents, is nearly identical
+ - Its code is 'go-flavored' - for example it returns 'YamlErrorOr' rather than raises exceptions
+
+It's not yet ready for production use - see the TODO file.
+"""