Examples are required to be strings

[lengau]

Right now each example is required to be a string, even if the type isn't necessarily a string.

Given this input:

    build_on: list[str] | str = pydantic.Field(
        min_length=1,
        examples=[
            "amd64",
            ["arm64", "riscv64"]
        ]
    )

I would expect it to work properly. However, instead I get this exception:

Exception occurred:
File "/home/lengau/Work/Code/craft-application/.venv/lib/python3.12/site-packages/yaml/reader.py", line 178, in update_raw
data = self.stream.read(size)
^^^^^^^^^^^^^^^^
AttributeError: 'list' object has no attribute 'read'
The full traceback has been saved in /tmp/sphinx-err-ua2zgx1a.log, if you want to report the issue to the developers.

[jahn-junior]

@lengau Does #17 resolve this issue too? It adds example to the string literal before parsing with PyYAML, so I think it should be fine now.

[lengau]

I can check, but I don't think so - I think we'll need to dump it as YAML.

[lengau]

@jahn-junior it looks like it does as long as the schema can be properly serialized. I tested it on https://github.com/canonical/craft-application/pull/736/files with:

    build_for: SingleEntryList[str] | str = pydantic.Field(
        examples=[
            "amd64",
            ["arm64", "riscv64"],
            {"key": [1, "value"]}
        ]
    )

It also succeeded with craft_platform.DebianArchitecture.AMD64 as an example, but not with craft_platforms.DebianArchitecture (as Pydantic complained that the EnumType is not serializable, which is correct).

Leaving this open just so we can add valid success and failure tests (and decide whether we want to wrap that SerializationError).

The short error message was:

reading sources... [ 73%] reference/models/platforms
Exception occurred:
File "/home/lengau/Work/Code/craft-application/.venv/lib/python3.12/site-packages/pydantic/_internal/_generate_schema.py", line 266, in _extract_json_schema_info_from_field_info
'examples': to_jsonable_python(info.examples),
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
pydantic_core._pydantic_core.PydanticSerializationError: Unable to serialize unknown type: <class 'enum.EnumType'>
The full traceback has been saved in /tmp/sphinx-err-q2mocsy6.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
Sphinx exited with exit code: 2

Log attached:

sphinx-err-q2mocsy6.log