make Platform class serializable for workunit-logger #21792
Conversation
This file contains 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
As described in pantsbuild#21773, having the Helm backend lint with the workunit-logger results in json serialization errors. Giving `Platform` a string representation resolves this (and anywhere else we may want to "print" it. Example workunit: ``` {"name": "pants.backend.helm.util_rules.tool.download_external_helm_plugin", "span_id": "bdaa19a5cd1ef797", "level": "DEBUG", "parent_id": "c8c137a5b78f02ea", "start_secs": 1734722271, "start_nanos": 296631921, "duration_secs": 0, "duration_nanos": 51846519, "description": "Download external Helm plugin", "metadata": {"name": "unittest", "version": "0.3.3", "platform": "linux_x86_64"}} ``` NOTE: I think this is a totally safe one line change, but admit it is to a rather core class.
cburroughs
commented
Dec 20, 2024
| @@ -39,7 +39,9 @@ def current_platform( | |||
| if env_tgt.val.has_field(DockerPlatformField): | |||
| return Platform(env_tgt.val[DockerPlatformField].normalized_value) | |||
| if env_tgt.val.has_field(RemotePlatformField): | |||
| return Platform(env_tgt.val[RemotePlatformField].value) | |||
| remote_platform = env_tgt.val[RemotePlatformField].value | |||
There was a problem hiding this comment.
I am very confused:
- Why mypy was satisfied with this before since I think
Enumbehaves the same way. - Why it neede dso much extra help with the
remote_platformvar callout instead of just a check on.value.
This is to resolve:
Partition #2 - python-default, ['CPython==3.11.*']:
src/python/pants/engine/internals/platform_rules.py: note: In function "current_platform":
src/python/pants/engine/internals/platform_rules.py:42:29: error: Argument 1 to "Platform" has incompatible type "str | None"; expected "str" [arg-type]
return Platform(env_tgt.val[RemotePlatformField].value)
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There was a problem hiding this comment.
I don't understand it either, but I have seen mypy get confused about this sort of thing elsewhere at times.
benjyw
approved these changes
Dec 20, 2024
|
(Removing 2.24.x as I woke up this morning remembering that |
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.
As described in #21773, having the Helm backend lint with the workunit-logger results in json serialization errors. Giving
Platforma string representation resolves this (and anywhere else we may want to "print" it.Example workunit:
NOTE: I think this is a totally safe ~one line change, but admit it is to a rather core class.
fixes #21773