This repository was archived by the owner on Dec 21, 2024. It is now read-only.
fix(JsonFormatter): type the constructor #170
Merged
Conversation
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
erdnaxeli
commented
Feb 28, 2023
Comment on lines
109
to
123
| def __init__( | ||
| self, | ||
| *args: Any, | ||
| json_default: OptionalCallableOrStr = None, | ||
| json_encoder: OptionalCallableOrStr = None, | ||
| json_serialiser: OptionalCallableOrStr = json.dumps, | ||
| json_indent: Optional[Union[int, str]] = None, | ||
| json_ensure_ascii: bool = True, | ||
| prefix: str = "", | ||
| rename_fields: Optional[dict] = None, | ||
| static_fields: Optional[dict] = None, | ||
| reserved_attrs: Tuple[str, ...] = RESERVED_ATTRS, | ||
| timestamp: Union[bool, str] = False, | ||
| **kwargs: Any | ||
| ): |
There was a problem hiding this comment.
The important part is here.
Comment on lines
+145
to
+154
| self.json_default = self._str_to_fn(json_default) | ||
| self.json_encoder = self._str_to_fn(json_encoder) | ||
| self.json_serializer = self._str_to_fn(json_serialiser) | ||
| self.json_indent = json_indent | ||
| self.json_ensure_ascii = json_ensure_ascii | ||
| self.prefix = prefix | ||
| self.rename_fields = rename_fields or {} | ||
| self.static_fields = static_fields or {} | ||
| self.reserved_attrs = dict(zip(reserved_attrs, reserved_attrs)) | ||
| self.timestamp = kwargs.pop("timestamp", False) | ||
| self.timestamp = timestamp |
Comment on lines
+130
to
+131
| :param json_indent: indent parameter for json.dumps | ||
| :param json_ensure_ascii: ensure_ascii parameter for json.dumps |
There was a problem hiding this comment.
I removed the duplicated doc for json_indent and I moved json_ensure_ascii next to it.
Yoan-MA
approved these changes
Feb 28, 2023
madzak
reviewed
Feb 28, 2023
madzak
approved these changes
Feb 28, 2023
Heheh, but it’s worthwhile to catch bugs. But anyway, do you know when this will roll out into a new release? |
|
Hi, could you consider making a new release? Currently all our apps have a version constraint |
|
Hi @madzak could you publish a release with this change included? |
nhairs
pushed a commit
to nhairs/python-json-logger
that referenced
this pull request
Apr 1, 2024
madzak/python-json-logger#170 was included on the main branch of the upstream but never released, thus it was inadvertently released in `3.0.0`. This included the accidental renaming from US spelling to UK spelling of "serializer". This PR reverts that change. Co-authored-by: Julian Gilbey <jdg@debian.org>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
5 participants
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.
Now that the package include
py.typed, mypy actually checks the type. I am usingdisallow-untyped-calls, so it fails because the constructor ofJsonFormatteris untyped. This PR fixes it.I run
toxwhich runsblack, which fixed some formatting issues.