-
Notifications
You must be signed in to change notification settings - Fork 266
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
metadata API: serialization is missing a final newline #2393
Comments
Hi @jku, what is the conclusion on this, we want to do this change? If yes, I would like to make it. |
I'm worried this will break things downstream (at least all kinds of test suites in applications, maybe even actual application code)... so maybe not worth fixing unless someone is willing to do a lot of analysis/testing in the applications. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Our JSON serialization is basically
json.dumps(metadata_obj.to_dict(), ...).encode("utf-8")
json.dumps() return value does not end in a newline. This means any files written with this content will not end in a newline: this makes the produced files not valid posix text files.
For
Metadata.to_file()
this seems like a minor bug (andMetadata.to_bytes()
should have the same output for consistency), so in practiceJSONSerializer.serialize()
probably should add the final newline.My only concern about this is that it is an unexpected change in the serialization output... IF we change this, we should definitely consider this an API change for users who produce metadata.
The text was updated successfully, but these errors were encountered: