Question: optionally suppress generation of `closed=True` for typed dictionaries

[jacopoabramo]

I'm generating a TypedDict class from a JSON schema and the latest release automatically adds closed=True to the subclass constructor. This makes our typing check fail as we rely on mypy which doesn't yet support PEP 728. Is there an option to disable such generation so to maintain the original implementation of a standard TypedDict?

[evvaaaa]

I think we just do

class SomeDocument: # type: ignore[call-arg]

here.

Still allows type hinting to work.

we should apply this in the override jinja.

[evvaaaa]

Since our issue with Any has been fixed and released I think we can get rid of the current jinja too

[jacopoabramo]

@evvaaaa

class SomeDocument: # type: ignore[call-arg]

unless I'm mistaken, adding a comment like this would still require to override the base jinja template currently provided by datamodel and add the ignore statement

[evvaaaa]

still require to override the base jinja template

This is true, but I meant that the jinja currently on main

https://github.com/bluesky/event-model/blob/main/src/event_model/generate/templates/root.jinja2#L1-L8

is no longer necessary because what it's addressing has been solved, might be wrong though.

I think my order of preference would be

1. Change it from generating close=True or closed=False in the first place. This might be already achievable with config options

https://github.com/bluesky/event-model/blob/ee1fcac96612031d13e7c624153464d54bbe1584/src/event_model/generate/create_documents.py#L114-L125

if not then jinja.

2. ignore statement through jinja.

[jacopoabramo]

Change it from generating close=True or closed=False in the first place. This might be already achievable with config options

The problem is that neither options are supported by type checkers so far; these parameters (extra_items or closed) should not be present at all at this time if we want to avoid the ignore all together. So either there's an option to suppress the generation of these parameters (which is the original question), or otherwise the only option is the ignore statement.

[github-actions]

🎉 Released in 0.53.0

The fix/feature from PR #2956 has been included in this release. See the release notes for details.

Thank you for your contribution!