Fix generated config additional_properties typing for pyright strict - #5497
Open
saisharan0103 wants to merge 1 commit into
Conversation
…l_properties typing for stricter type checks Closes open-telemetry#5268
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Generated configuration dataclasses currently annotate
additional_propertiesasClassVar[dict[str, Any]], while_additional_propertiescreates and assignsself.additional_propertiesper instance after dataclass initialization._ComponentConfigmodels that runtime contract as an instance attribute, so pyright strict mode rejects the generated config classes as structurally incompatible with the protocol even though standard mode permits the mismatch.This changes the datamodel-codegen template to emit
additional_propertiesas an instance dataclass field usingfield(default_factory=dict)with the more precisedict[str, dict[str, Any] | None]value type. The generated model imports are updated to usefieldinstead ofClassVar, and the checked-inmodels.pyis updated to match the template.The stale
_ComponentConfigdocstring note about the intentional mismatch is removed. Local test fixture dataclasses now use the same instance-field typing, with a regression assertion that generated models exposeadditional_propertiesas a dataclass instance field with independent default dictionaries.Fixes #5268
ruff check opentelemetry-configuration/codegen/dataclass.jinja2 opentelemetry-configuration/src/opentelemetry/configuration/_common.py opentelemetry-configuration/src/opentelemetry/configuration/models.py opentelemetry-configuration/tests/test_common.py pyproject.tomlreports no new findings on the changed files.Ran
pytest -xlocally with no new failures.