chore: convert json scenarios to toml format

[samypr100]

Closes #177 , #18

• toml files where automatically generated the from the json files using a basic script
  • Used the filename as the folder name and the scenario name as the filename
• Prettier on the generated ones for consistency

[samypr100]

Here's the basic script I used, so we can regen if needed. For prettier I used the prettier-plugin-toml as a separate follow up command.

json_scenarios_to_toml.py

import json
import re
from pathlib import Path

import toml

scenarios_path = Path(__file__).parent / "scenarios"

for path in scenarios_path.glob("*.json"):
    with path.open("r") as f:
        json_scenarios = json.load(f)

    for json_scenario in json_scenarios:
        # Use the name key as the filename
        file_path = (
            path.parent
            / re.sub(r"[\s-]+", "_", path.stem.lower())
            / f"{json_scenario['name']}.toml"
        )
        file_path.parent.mkdir(parents=True, exist_ok=True)

        toml_data = {
            "name": json_scenario["name"],
            "description": json_scenario["description"],
            "root": json_scenario["root"],
            "packages": json_scenario["packages"],
            "expected": json_scenario["expected"],
        }

        if "resolver_options" in json_scenario:
            toml_data |= {"resolver_options": json_scenario["resolver_options"] }

        if "environment" in json_scenario:
            toml_data |= {"environment": json_scenario["environment"] }

        with file_path.open("w", encoding="utf-8") as toml_file:
            toml.dump(toml_data, toml_file)
            print(f"Created: {file_path}")

[notatallshaw]

These are so much nicer to read.

[zanieb]

Can we use nesting for package versions? Is that easier to read?

[samypr100]

The pre-existing fork/*.toml seem to also use this syntax, we can attempt to change it across though.

e.g. fork/filter-sibling-dependencies.toml

[packages.a.versions."4.3.0"]
[packages.a.versions."4.4.0"]
[packages.b.versions."1.0.0"]
requires = ["d==1.0.0"]
[packages.c.versions."1.0.0"]
requires = ["d==2.0.0"]
[packages.d.versions."1.0.0"]
[packages.d.versions."2.0.0"]

[zanieb]

Exciting! Thanks!

[konstin]

Separately from this PR, do we want to add prettier to this repo?

[zanieb]

I think @BurntSushi and @konstin will need to own deciding what's necessary to get this merged — I don't have strong feelings about the scenario format right now and they've been writing most of the recent scenarios.

[samypr100]

I think @BurntSushi and @konstin will need to own deciding what's necessary to get this merged — I don't have strong feelings about the scenario format right now and they've been writing most of the recent scenarios.

👍 Should I rebase? Done

[konstin]

I like this and want to merge it

[BurntSushi]

Oh yes please! I found using TOML to write scenarios border-line pleasant.

[zanieb]

As discovered by @charliermarsh, it looks like this conversion dropped some information

e.g.

packse/scenarios/requires-python.json

Lines 230 to 232 in 2a670ba

	"resolver_options": {
	"python": "3.11"
	},

is not present in the toml version

[notatallshaw]

This probably would have been a great use case to do a round trip on the formats to prove no information loss, hindsight is 20-20 and all that.

[samypr100]

Apologies, not sure how I missed those. I opened #226 to port those missing entries.