changed yaml loaders
This commit is contained in:
1 parent
cbbc099384
commit
298a233a5f
6 files changed
+83
-30
No files matched your search
+1
-1
@@ -4,7 +4,7 @@ import setuptools # type: ignore
|
|||||||
setuptools.setup(
|
setuptools.setup(
|
||||||
python_requires=">=3.9",
|
python_requires=">=3.9",
|
||||||
install_requires=[
|
install_requires=[
|
||||||
"ruamel.yaml==0.17.17",
|
"PyYAML==6.0",
|
||||||
"fastapi==0.70.0",
|
"fastapi==0.70.0",
|
||||||
"pydantic==1.8.2",
|
"pydantic==1.8.2",
|
||||||
"uvicorn[standard]==0.15.0",
|
"uvicorn[standard]==0.15.0",
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
|
import yaml
|
||||||
import io
|
import io
|
||||||
from typing import Any, TextIO, Union
|
from typing import Any, TextIO, Union
|
||||||
|
|
||||||
from src.yaml_serializer.base_yaml import yaml
|
from src.yaml_serializer.loader import YamlSafeLoader
|
||||||
|
from src.yaml_serializer.dumper import YamlSafeDumper
|
||||||
|
|
||||||
|
|
||||||
def dump_yaml(obj: Any) -> str:
|
def dump_yaml(obj: Any) -> str:
|
||||||
@@ -14,7 +16,14 @@ def dump_yaml(obj: Any) -> str:
|
|||||||
str
|
str
|
||||||
"""
|
"""
|
||||||
stream = io.StringIO()
|
stream = io.StringIO()
|
||||||
yaml.dump(obj, stream)
|
yaml.dump(
|
||||||
|
obj,
|
||||||
|
stream,
|
||||||
|
default_flow_style=False,
|
||||||
|
allow_unicode=True,
|
||||||
|
sort_keys=False,
|
||||||
|
Dumper=YamlSafeDumper,
|
||||||
|
)
|
||||||
stream.seek(0)
|
stream.seek(0)
|
||||||
return stream.read()
|
return stream.read()
|
||||||
|
|
||||||
@@ -28,4 +37,4 @@ def load_yaml(yaml_stream: TextIO) -> Union[dict, list]:
|
|||||||
Returns:
|
Returns:
|
||||||
List[dict, list]
|
List[dict, list]
|
||||||
"""
|
"""
|
||||||
return yaml.load(yaml_stream)
|
return yaml.load(yaml_stream, Loader=YamlSafeLoader)
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
from ruamel.yaml import YAML
|
|
||||||
|
|
||||||
from src.yaml_serializer.types import (
|
|
||||||
IncludedYaml,
|
|
||||||
IncludedYamlDir,
|
|
||||||
SecretValue,
|
|
||||||
)
|
|
||||||
|
|
||||||
yaml = YAML()
|
|
||||||
yaml.register_class(IncludedYaml)
|
|
||||||
yaml.register_class(SecretValue)
|
|
||||||
yaml.register_class(IncludedYamlDir)
|
|
||||||
yaml.constructor.add_constructor("!include", IncludedYaml.from_yaml)
|
|
||||||
yaml.constructor.add_constructor("!secret", SecretValue.from_yaml)
|
|
||||||
yaml.constructor.add_constructor("!env_var", IncludedYamlDir.from_yaml)
|
|
||||||
yaml.constructor.add_constructor("!include_dir_list", IncludedYamlDir.from_yaml)
|
|
||||||
yaml.constructor.add_constructor("!include_dir_merge_list", IncludedYamlDir.from_yaml)
|
|
||||||
yaml.constructor.add_constructor("!include_dir_named", IncludedYamlDir.from_yaml)
|
|
||||||
yaml.constructor.add_constructor("!include_dir_merge_named", IncludedYamlDir.from_yaml)
|
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
import yaml
|
||||||
|
|
||||||
|
from src.yaml_serializer.types import (
|
||||||
|
IncludedYaml,
|
||||||
|
IncludedYamlDir,
|
||||||
|
SecretValue,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class YamlSafeDumper(yaml.SafeDumper):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
YamlSafeDumper.add_representer(IncludedYaml, IncludedYaml.to_yaml)
|
||||||
|
YamlSafeDumper.add_representer(SecretValue, SecretValue.to_yaml)
|
||||||
|
YamlSafeDumper.add_representer(IncludedYamlDir, IncludedYamlDir.to_yaml)
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
import yaml
|
||||||
|
|
||||||
|
from src.yaml_serializer.types import (
|
||||||
|
IncludedYaml,
|
||||||
|
IncludedYamlDir,
|
||||||
|
SecretValue,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class YamlSafeLoader(yaml.SafeLoader):
|
||||||
|
pass
|
||||||
|
# def compose_node(self, parent: yaml.nodes.Node, index: int) -> yaml.nodes.Node: # type: ignore[override]
|
||||||
|
# """Annotate a node with the first line it was seen."""
|
||||||
|
# last_line: int = self.line
|
||||||
|
# node: yaml.nodes.Node = super().compose_node(parent, index) # type: ignore[assignment]
|
||||||
|
# node.__line__ = last_line + 1 # type: ignore[attr-defined]
|
||||||
|
# return node
|
||||||
|
|
||||||
|
|
||||||
|
YamlSafeLoader.add_constructor("!include", IncludedYaml.from_yaml)
|
||||||
|
YamlSafeLoader.add_constructor("!secret", SecretValue.from_yaml)
|
||||||
|
YamlSafeLoader.add_constructor("!env_var", IncludedYamlDir.from_yaml)
|
||||||
|
YamlSafeLoader.add_constructor("!include_dir_list", IncludedYamlDir.from_yaml)
|
||||||
|
YamlSafeLoader.add_constructor("!include_dir_merge_list", IncludedYamlDir.from_yaml)
|
||||||
|
YamlSafeLoader.add_constructor("!include_dir_named", IncludedYamlDir.from_yaml)
|
||||||
|
YamlSafeLoader.add_constructor("!include_dir_merge_named", IncludedYamlDir.from_yaml)
|
||||||
@@ -19,21 +19,29 @@ class dumping_yamls_tests(TestCase):
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
self.assertEqual(yaml, "automations: !include automations.yaml\n")
|
self.assertEqual(yaml, "automations: !include 'automations.yaml'\n")
|
||||||
|
|
||||||
def test_dumping_secrets(self):
|
def test_dumping_secrets(self):
|
||||||
yaml = dump_yaml({"google_password": SecretValue("gpass", "supersec")})
|
yaml = dump_yaml({"google_password": SecretValue("gpass", "supersec")})
|
||||||
self.assertEqual(yaml, "google_password: !secret gpass\n")
|
self.assertEqual(yaml, "google_password: !secret 'gpass'\n")
|
||||||
|
|
||||||
def test_dumping_stub(self):
|
def test_dumping_stub(self):
|
||||||
yaml = dump_yaml({"sensor": IncludedYamlDir("include_dir_list", "sensors/*yaml")})
|
yaml = dump_yaml({"sensor": IncludedYamlDir("include_dir_list", "sensors/*yaml")})
|
||||||
self.assertEqual(yaml, "sensor: !include_dir_list sensors/*yaml\n")
|
self.assertEqual(yaml, "sensor: !include_dir_list 'sensors/*yaml'\n")
|
||||||
|
|
||||||
def test_load_stub(self):
|
def test_load_stub(self):
|
||||||
yaml_obj = load_yaml(
|
yaml_obj = load_yaml(
|
||||||
io.StringIO(
|
io.StringIO(
|
||||||
"""
|
"""
|
||||||
name: cool
|
name: cool
|
||||||
|
date: "10:00"
|
||||||
|
bools:
|
||||||
|
- "yes"
|
||||||
|
- "no"
|
||||||
|
- true
|
||||||
|
- false
|
||||||
|
bobIsNull:
|
||||||
|
bobIsNull2: null
|
||||||
google_password: !secret gpass
|
google_password: !secret gpass
|
||||||
sensor: !include_dir_list sensors/*yaml
|
sensor: !include_dir_list sensors/*yaml
|
||||||
automations: !include automations.yaml
|
automations: !include automations.yaml
|
||||||
@@ -44,6 +52,10 @@ class dumping_yamls_tests(TestCase):
|
|||||||
dict(yaml_obj),
|
dict(yaml_obj),
|
||||||
{
|
{
|
||||||
"name": "cool",
|
"name": "cool",
|
||||||
|
"date": "10:00",
|
||||||
|
"bools": ["yes", "no", True, False],
|
||||||
|
"bobIsNull": None,
|
||||||
|
"bobIsNull2": None,
|
||||||
"google_password": SecretValue("gpass", "n/a"),
|
"google_password": SecretValue("gpass", "n/a"),
|
||||||
"sensor": IncludedYamlDir("include_dir_list", "sensors/*yaml"),
|
"sensor": IncludedYamlDir("include_dir_list", "sensors/*yaml"),
|
||||||
"automations": IncludedYaml("automations.yaml"),
|
"automations": IncludedYaml("automations.yaml"),
|
||||||
@@ -51,8 +63,17 @@ class dumping_yamls_tests(TestCase):
|
|||||||
)
|
)
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
dump_yaml(yaml_obj),
|
dump_yaml(yaml_obj),
|
||||||
"name: cool\n"
|
"""name: cool
|
||||||
"google_password: !secret gpass\n"
|
date: '10:00'
|
||||||
"sensor: !include_dir_list sensors/*yaml\n"
|
bools:
|
||||||
f"automations: !include automations.yaml\n",
|
- 'yes'
|
||||||
|
- 'no'
|
||||||
|
- true
|
||||||
|
- false
|
||||||
|
bobIsNull: null
|
||||||
|
bobIsNull2: null
|
||||||
|
google_password: !secret 'gpass'
|
||||||
|
sensor: !include_dir_list 'sensors/*yaml'
|
||||||
|
automations: !include 'automations.yaml'
|
||||||
|
""",
|
||||||
)
|
)
|
||||||
Reference in new issue
Block a user