[woutdenolf]

PR summary

• Display task tags in the ewokstasks directive
  • tags are introduced in Task: tags class argument (arbitrary strings), included in task discovery ewokscore#515 (needs it released first)
• Filtering on tags is in filter tasks on tags #57

AI Disclosure

• AI tool claude used for all

🤖 Generated with Claude Code

[loichuder]

I'd like to be able to review the filtering separately. Could you please separate the display and the filtering in two MR?

Also, it seems there is another change about deprecating example lists that is not mentioned in the MR description. Could you explain what is this about?

[woutdenolf]

deprecating example lists

Indeed but it is the opposite: examples are lists (always have been) and now non-lists give a warning. Changelog describes it. PR description does not indeed.

[loichuder]

Weird that Pydantic allows to use non-lists as examples. I think we should not allow it (i.e. no deprecation but a straight error)

[woutdenolf]

Pydantic doesn't even complain when converting the model to a JSON schema

import json
from pydantic import BaseModel, Field


class User(BaseModel):
    name: str = Field(examples="someone")


print(json.dumps(User.model_json_schema(), indent=2))

{
  "properties": {
    "name": {
      "examples": "someone",
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "title": "User",
  "type": "object"
}

To compare

import json
from pydantic import BaseModel, Field


class User(BaseModel):
    name: str = Field(examples=["someone"])


print(json.dumps(User.model_json_schema(), indent=2))

{
  "properties": {
    "name": {
      "examples": [
        "someone"
      ],
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "title": "User",
  "type": "object"
}

Only this would raise an error

from jsonschema import Draft202012Validator
from pydantic import BaseModel, Field


class User(BaseModel):
    name: str = Field(examples="someone")


schema = User.model_json_schema()
Draft202012Validator.check_schema(schema)

Traceback (most recent call last):
  File "test.py", line 11, in <module>
    Draft202012Validator.check_schema(schema)
  File "python3.12/site-packages/jsonschema/validators.py", line 316, in check_schema
    raise exceptions.SchemaError.create_from(error)
jsonschema.exceptions.SchemaError: 'someone' is not of type 'array'

Failed validating 'type' in metaschema['allOf'][1]['properties']['properties']['additionalProperties']['$dynamicRef']['allOf'][4]['properties']['examples']:
    {'type': 'array', 'items': True}

On schema['properties']['name']['examples']:
    'someone'

See pydantic/pydantic#5135

[woutdenolf]

• Split as requested:
  • this PR now only displays task tags
  • filtering is in filter tasks on tags #57 (on top of this one)
• The examples change is now in its own PR: deprecate non-list examples #58
  • pydantic's Field(examples=...) expects a list of examples, but pydantic does not check it
  • tomwer passes a single dict (examples={"cpu_mem_fraction": 0.24, ...}) for platform_resources in its multicor/multipag models
  • TaskDescription validation failed on it, so discovery of all tomwer tasks failed when building the ewoksdoc task cache
  • ewokssphinx now wraps such a value in a list and emits a FutureWarning; it will become an error in a future release
  • tomwer is fixed separately

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[loichuder]

Just pushed a commit to tweak the doc. All good otherwise 👍