Import yaml representers from own class

Author: CodeGat

scripts/spack_manifest/injection/modules.py

@@ -10,19 +10,9 @@
     Projections,
     Specs
 )
+from scripts.spack_manifest.injection.yaml_representer import YamlExplicitFlowStyleSequence, yaml_explicit_flow_style_sequence_representer
 
-# For sequence definitions, we keep it in the flow-style format (i.e., [a, b, c]) rather than block style
-# as it is more compact for reserved definitions.
-class YamlExplicitFlowStyleSequence(list[str]):
-    pass
-
-def yaml_explicit_flow_style_sequence_representer(dumper, data):
-    """
-    Custom representer for YAML to ensure that some sequences are represented in flow style.
-    This is necessary for sequences that are used as definitions in spack manifests.
-    """
-    return dumper.represent_sequence("tag:yaml.org,2002:seq", data, flow_style=True)
-
+# We represent reserved definitions as in flow-style sequences (eg. `[a]` rather than `- a`), so it is more compact.
 yaml.add_representer(YamlExplicitFlowStyleSequence, yaml_explicit_flow_style_sequence_representer)
 
 ##################
@@ -108,7 +98,6 @@ def inject_projections(
     # To start with, add the projections that are already defined in the manifest
     new_projections: dict[str, str] = dict(defined_projections_dict)
 
-    # if root_spec not in defined_projections:
     new_projections.update(
         generate_projection_for_root_spec_or_raise(manifest, root_spec, defined_projections_dict.get(root_spec))
     )

scripts/spack_manifest/injection/prerelease.py

@@ -11,41 +11,23 @@
     Projections,
     Specs
 )
+from scripts.spack_manifest.injection.yaml_representer import (
+    YamlExplicitFlowStyleSequence,
+    YamlExplicitQuotedString,
+    yaml_explicit_flow_style_sequence_representer,
+    yaml_explicit_quoted_string_representer
+)
 
 
-# PyYaml by default dumps unquoted strings if they look unambiguous, and quoted strings otherwise.
-# PyYaml dumps '{name}/prX-Y' as a quoted str as it has '{' at the front and causes ambiguity
-# But 'ROOT_SPEC/.dependencies/prX-Y/VERSION-{hash:7}' is dumped as an unquoted str as it is unambiguous
-# So we need to wrap projections in a custom class that forces PyYaml to dump them as quoted strings.
-class YamlExplicitQuotedString(str):
-    pass
-
-def yaml_explicit_quoted_string_representer(dumper, data):
-    """
-    Custom representer for YAML to ensure that some strings are quoted explicitly.
-    This is necessary for strings that are used as projections in spack manifests.
-    """
-    return dumper.represent_scalar("tag:yaml.org,2002:str", data, style="'")
-
-# For sequence definitions, we keep it in the flow-style format (i.e., [a, b, c]) rather than block style
-# as it is more compact for reserved definitions.
-class YamlExplicitFlowStyleSequence(list[str]):
-    pass
-
-def yaml_explicit_flow_style_sequence_representer(dumper, data):
-    """
-    Custom representer for YAML to ensure that some sequences are represented in flow style.
-    This is necessary for sequences that are used as definitions in spack manifests.
-    """
-    return dumper.represent_sequence("tag:yaml.org,2002:seq", data, flow_style=True)
-
-
+# The yaml representer sometimes dumps ambiguous strings in the case of projections like `{name}/...` as unquoted strings,
+# which is not handled by spack very well.
 yaml.add_representer(YamlExplicitQuotedString, yaml_explicit_quoted_string_representer)
+
+# We represent reserved definitions as in flow-style sequences (eg. `[a]` rather than `- a`), so it is more compact.
 yaml.add_representer(YamlExplicitFlowStyleSequence, yaml_explicit_flow_style_sequence_representer)
 
 ### Actual methods begin here ###
 
-
 def inject_prerelease_information(
     manifest_path: str,
     version: str,

scripts/spack_manifest/injection/yaml_representer.py

@@ -0,0 +1,26 @@
+# For sequences of reserved definitions, we keep it in the flow-style format (i.e., [a, b, c]) rather than block style
+# as it is more compact for reserved definitions.
+class YamlExplicitFlowStyleSequence(list[str]):
+    pass
+
+def yaml_explicit_flow_style_sequence_representer(dumper, data):
+    """
+    Custom representer for YAML to ensure that some sequences are represented in flow style.
+    This is necessary for sequences that are used as definitions in spack manifests.
+    """
+    return dumper.represent_sequence("tag:yaml.org,2002:seq", data, flow_style=True)
+
+
+# PyYaml by default dumps unquoted strings if they look unambiguous, and quoted strings otherwise.
+# PyYaml dumps '{name}/prX-Y' as a quoted str as it has '{' at the front and causes ambiguity
+# But 'ROOT_SPEC/.dependencies/prX-Y/VERSION-{hash:7}' is dumped as an unquoted str as it is unambiguous
+# So we need to wrap projections in a custom class that forces PyYaml to dump them as quoted strings.
+class YamlExplicitQuotedString(str):
+    pass
+
+def yaml_explicit_quoted_string_representer(dumper, data):
+    """
+    Custom representer for YAML to ensure that some strings are quoted explicitly.
+    This is necessary for strings that are used as projections in spack manifests.
+    """
+    return dumper.represent_scalar("tag:yaml.org,2002:str", data, style="'")