Respect repr on fields when logging a dataclass #592
Merged
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
Kludex
approved these changes
Nov 13, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #592 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 133 133
Lines 10448 10452 +4
Branches 1430 1431 +1
=========================================
+ Hits 10448 10452 +4 ☔ View full report in Codecov by Sentry. |
alexmojaki
reviewed
Nov 13, 2024
tests/test_json_args.py
Outdated
| @dataclass | ||
| class MyReprDataclass: | ||
| in_repr: int | ||
| not_in_repr: int = field(repr=False) |
There was a problem hiding this comment.
this should be a complex object that would appear in the json schema.
then ensure it doesn't appear in the json schema.
There was a problem hiding this comment.
good catch, it does misbehave :(
There was a problem hiding this comment.
Fixed, I think. And I check there was nowhere else we use the dataclasses.fields function, so I think it should be good now.
Deploying logfire-docs with
|
| Latest commit: |
8a5019f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://9245c40d.logfire-docs.pages.dev |
| Branch Preview URL: | https://respect-repr-when-logging-da.logfire-docs.pages.dev |
alexmojaki
approved these changes
Nov 13, 2024
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.
Requested by @samuelcolvin.
I think it maybe makes sense to have a way for users to control this behavior more explicitly/independently of other use cases (e.g., via a magic
__pydantic_logfire_dump__method?). But this seems reasonable to me for now. Not sure if we need to be concerned about it being a breaking change, or need to provide a way to opt into it or something.field(repr=False)should not be serialized/shown #521