You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "amoghrajesh (via GitHub)" <gi...@apache.org> on 2026/08/03 08:54:06 UTC
[PR] Make serde errors for unsupported types a bit more actionable [airflow]
amoghrajesh opened a new pull request, #70974:
URL: https://github.com/apache/airflow/pull/70974
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->
<!--
Thank you for contributing!
Please provide above a brief description of the changes made in this pull request.
Write a good git commit message following this guide: https://chris.beams.io/posts/git-commit/
Please make sure that your code changes are covered with tests.
And in case of new features or big changes remember to adjust the documentation.
For user-facing UI changes, please attach before/after screenshots (or a short
screen recording) so reviewers can assess the visual impact.
Feel free to ping (in general) for the review if you do not see reaction for a few days
(72 Hours is the minimum reaction time you can expect from volunteers) - we sometimes miss notifications.
In case of an existing issue, reference it using one of the following:
* closes: #ISSUE
* related: #ISSUE
-->
---
##### Was generative AI tooling used to co-author this PR?
<!--
If generative AI tooling has been used in the process of authoring this PR, please
change below checkbox to `[X]` followed by the name of the tool, uncomment the "Generated-by".
-->
- [ ] Yes (please specify the tool below)
<!--
Generated-by: [Tool Name] following [the guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
-->
Previously these errors said only that a type could not be (de)serialized, giving no indication of what to do about it.
Error looked like
```
TypeError: cannot serialize object of type <class 'pandas.DataFrame'>
```
Example in https://github.com/apache/airflow/pull/70791
Name the two ways a Dag author can make their own class work
- a serialize/deserialize method pair
- or @dataclass/@attr.define)
and link to the docs page that already covers all the options in full, instead of leaving people to dig through source to find them.
---
* Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
* For fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
* When adding dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
* For significant user-facing changes create newsfragment: `{pr_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments). You can add this file in a follow-up commit after the PR is created so you know the PR number.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Make serde errors for unsupported types a bit more actionable [airflow]
Posted by "Lee-W (via GitHub)" <gi...@apache.org>.
Lee-W commented on code in PR #70974:
URL: https://github.com/apache/airflow/pull/70974#discussion_r3702650094
##########
task-sdk/src/airflow/sdk/serde/__init__.py:
##########
@@ -285,7 +285,11 @@ def serialize(o: object, depth: int = 0) -> U | None:
dct[DATA] = serialize(data, depth + 1)
return dct
- raise TypeError(f"cannot serialize object of type {cls}")
+ raise TypeError(
+ f"cannot serialize object of type {cls}. Give it a `serialize()` method (and a matching "
Review Comment:
```suggestion
f"Cannot serialize object of type {cls}. Give it a `serialize()` method (and a matching "
```
##########
task-sdk/tests/task_sdk/serde/test_serde.py:
##########
@@ -646,5 +648,7 @@ def test_error_when_serializing_callable_without_name(self):
with pytest.raises(
TypeError,
match="cannot serialize object of type <class 'tests.task_sdk.serde.test_serde.C'>",
- ):
+ ) as exc_info:
serialize(i)
+ assert "@dataclass or @attr.define" in str(exc_info.value)
Review Comment:
same here
##########
task-sdk/tests/task_sdk/serde/test_serde.py:
##########
@@ -523,8 +523,10 @@ def test_raise_undeserializable(self):
"__version__": 0,
}
)
- with pytest.raises(TypeError, match="No deserializer"):
+ with pytest.raises(TypeError, match="No deserializer") as exc_info:
deserialize(data)
+ assert "deserialize(data, version)" in str(exc_info.value)
Review Comment:
would be better if we check the whole sentence instead
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Make serde errors for unsupported types a bit more actionable [airflow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #70974:
URL: https://github.com/apache/airflow/pull/70974#issuecomment-5166124956
### Backport successfully created: v3-3-test
Note: As of [Merging PRs targeted for Airflow 3.X](https://github.com/apache/airflow/blob/main/dev/README_AIRFLOW3_DEV.md#merging-prs-targeted-for-airflow-3x)
the committer who merges the PR is responsible for backporting the PRs that are bug fixes (generally speaking) to the maintenance branches.
In matter of doubt please ask in [#release-management](https://apache-airflow.slack.com/archives/C03G9H97MM2) Slack channel.
<table>
<tr>
<th>Status</th>
<th>Branch</th>
<th>Result</th>
</tr>
<tr>
<td>✅</td>
<td>v3-3-test</td>
<td><a href="https://github.com/apache/airflow/pull/70982"><img src="https://img.shields.io/badge/PR-70982-blue" alt="PR Link"></a></td>
</tr>
</table>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Make serde errors for unsupported types a bit more actionable [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #70974:
URL: https://github.com/apache/airflow/pull/70974#discussion_r3702769008
##########
task-sdk/src/airflow/sdk/serde/__init__.py:
##########
@@ -285,7 +285,11 @@ def serialize(o: object, depth: int = 0) -> U | None:
dct[DATA] = serialize(data, depth + 1)
return dct
- raise TypeError(f"cannot serialize object of type {cls}")
+ raise TypeError(
+ f"cannot serialize object of type {cls}. Give it a `serialize()` method (and a matching "
+ "`deserialize(data, version)`), or decorate the class with @dataclass or @attr.define. "
Review Comment:
Updated both messages to say staticmethod, matching the docs example
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Make serde errors for unsupported types a bit more actionable [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #70974:
URL: https://github.com/apache/airflow/pull/70974#discussion_r3702766849
##########
task-sdk/tests/task_sdk/serde/test_serde.py:
##########
@@ -523,8 +523,10 @@ def test_raise_undeserializable(self):
"__version__": 0,
}
)
- with pytest.raises(TypeError, match="No deserializer"):
+ with pytest.raises(TypeError, match="No deserializer") as exc_info:
deserialize(data)
+ assert "deserialize(data, version)" in str(exc_info.value)
Review Comment:
Updated.
##########
task-sdk/tests/task_sdk/serde/test_serde.py:
##########
@@ -646,5 +648,7 @@ def test_error_when_serializing_callable_without_name(self):
with pytest.raises(
TypeError,
match="cannot serialize object of type <class 'tests.task_sdk.serde.test_serde.C'>",
- ):
+ ) as exc_info:
serialize(i)
+ assert "@dataclass or @attr.define" in str(exc_info.value)
Review Comment:
Sure, handled.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Make serde errors for unsupported types a bit more actionable [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #70974:
URL: https://github.com/apache/airflow/pull/70974#issuecomment-5172360807
nice!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Make serde errors for unsupported types a bit more actionable [airflow]
Posted by "kaxil (via GitHub)" <gi...@apache.org>.
kaxil commented on code in PR #70974:
URL: https://github.com/apache/airflow/pull/70974#discussion_r3702658200
##########
task-sdk/src/airflow/sdk/serde/__init__.py:
##########
@@ -285,7 +285,11 @@ def serialize(o: object, depth: int = 0) -> U | None:
dct[DATA] = serialize(data, depth + 1)
return dct
- raise TypeError(f"cannot serialize object of type {cls}")
+ raise TypeError(
+ f"cannot serialize object of type {cls}. Give it a `serialize()` method (and a matching "
+ "`deserialize(data, version)`), or decorate the class with @dataclass or @attr.define. "
Review Comment:
serde calls this unbound off the class (`getattr(cls, "deserialize")(deserialize(value), version)`), so a plain `def deserialize(self, data, version)` written from this message serializes fine and then dies on read with a confusing missing-argument error. The docs example uses `@staticmethod` and the message in `deserialize()` below says classmethod, both of which work. Maybe say staticmethod in both messages to match the docs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Make serde errors for unsupported types a bit more actionable [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #70974:
URL: https://github.com/apache/airflow/pull/70974#discussion_r3702775787
##########
task-sdk/src/airflow/sdk/serde/__init__.py:
##########
@@ -285,7 +285,11 @@ def serialize(o: object, depth: int = 0) -> U | None:
dct[DATA] = serialize(data, depth + 1)
return dct
- raise TypeError(f"cannot serialize object of type {cls}")
+ raise TypeError(
+ f"cannot serialize object of type {cls}. Give it a `serialize()` method (and a matching "
+ "`deserialize(data, version)`), or decorate the class with @dataclass or @attr.define. "
Review Comment:
[Make serde errors for unsupported types a bit more actionable](https://github.com/apache/airflow/pull/70974/commits/86d835f9b82a75905a145f1291ddfcf5e2f6c9f6)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Make serde errors for unsupported types a bit more actionable [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh merged PR #70974:
URL: https://github.com/apache/airflow/pull/70974
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Make serde errors for unsupported types a bit more actionable [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #70974:
URL: https://github.com/apache/airflow/pull/70974#discussion_r3702731860
##########
task-sdk/src/airflow/sdk/serde/__init__.py:
##########
@@ -285,7 +285,11 @@ def serialize(o: object, depth: int = 0) -> U | None:
dct[DATA] = serialize(data, depth + 1)
return dct
- raise TypeError(f"cannot serialize object of type {cls}")
+ raise TypeError(
+ f"cannot serialize object of type {cls}. Give it a `serialize()` method (and a matching "
Review Comment:
Cool makes sense.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org