Multi-line string issue

[JeanChristopheMorinPerso]

What happened?

conda-recipe-manager can't seem to be able to parse this recipe:

about:
  description: 'ContourPy is a Python library for calculating contours of 2D quadrilateral

    grids.  It is written in C++11 and wrapped using pybind11.

    '
  dev_url: https://github.com/contourpy/contourpy
  doc_url: https://contourpy.readthedocs.io
  home: https://github.com/contourpy/contourpy
  license: BSD-3-Clause
  license_family: BSD
  license_file: LICENSE
  summary: Python library for calculating contours of 2D quadrilateral grids.

To Reproduce

with open('recipe.yaml', 'r') as fh:
    conda_recipe_manager.parser.recipe_reader.RecipeReader(fh.read())

Additional Details (please complete the following information):

• Conda Recipe Manager version: 0.10.4

[schuylermartin45]

I'm almost certain we have a workaround for this somewhere. I distinctly remember handling multi-line strings like this for some reason in the past. I think it was related to parsing rendered recipes from conda-build, and conda-build regularly spits-out these kinds of multi-line strings.

So I think either this is a regression not caught by the tests or maybe there's a parser flag you can pass to fix this.

[schuylermartin45]

Okay, I'm not crazy: #220

[JeanChristopheMorinPerso]

Okay, I'm not crazy: #220

@schuylermartin45 Is is it supposed to work and I'm doing something wrong or is it broken/not working?

[schuylermartin45]

@schuylermartin45 Is is it supposed to work and I'm doing something wrong or is it broken/not working?

I should have been more clear and maybe kept the rubber-ducking out of the GitHub thread.

I was able to recreate this locally and looking closer, the existing RecipeReaderFlags are not relevant. I've confirmed that removing the extra blank lines fixes the issue. The changes and tests added when #220 was fixed did not account for this edge case.

I don't have a timeline on when this may get fixed or released, but I may have time to poke around soon. Thanks!

[JeanChristopheMorinPerso]

Ok, thanks. It's alright. We are not blocked by this. I can workaround by pre-processing the recipe with this:

def fix_yaml_recipe(recipe: str) -> str:
    """
    Fix YAML recipe to workaround https://github.com/conda/conda-recipe-manager/issues/541.

    :param recipe: The YAML recipe to fix.
    :returns: The fixed YAML recipe.
    """

    class LiteralDumper(yaml.Dumper):
        def increase_indent(self, flow: bool = False, indentless: bool = False) -> None:
            """Increase indent for lists"""
            return super().increase_indent(flow, False)

    def literal_str_representer(dumper: yaml.Dumper, data: str) -> yaml.ScalarNode:
        if "\n" in data:
            return dumper.represent_scalar("tag:yaml.org,2002:str", data, style="|")
        return dumper.represent_scalar("tag:yaml.org,2002:str", data)

    LiteralDumper.add_representer(str, literal_str_representer)

    return yaml.dump(
        yaml.safe_load(recipe),
        Dumper=LiteralDumper,
        default_flow_style=False,
        sort_keys=False,
        allow_unicode=True,
    )