Deprecate Patch.patch and add Patch.text and Patch.data #893
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
This is an attempt to finish up the work in PR #790 originally done by @erikvanzijst. Thanks to him for the initial work. Patch.patch assumes all content to be encoded in UTF-8 and forcefully replaces any non-decodeable sequences. This can lead to corruption for content that either does not conform to any specific encoding altogether, or uses an encoding that is incompatible with, or ambiguous to UTF-8. As discussed in #790, this change deprecates Patch.patch in favor of Patch.text and adds Patch.data, which returns the unmodified, raw bytes.
Contributor
Author
|
I'd argue this is not deprecating, it's purely replacing. Deprecating implies there is a warning and no API breakage (yet). |
|
You could keep |
Contributor
Author
|
@pypingou That's exactly what I already did. |
|
Oh, I see it now, sorry about that I had misread the diff initially :( |
7 tasks
netbsd-srcmastr
referenced
this pull request
in NetBSD/pkgsrc
May 1, 2019
0.28.1 (2019-04-19) ------------------------- - Now works with pycparser 2.18 and above `#846 <https://github.com/libgit2/pygit2/issues/846>`_ - Now ``Repository.write_archive(..)`` keeps the file mode `#616 <https://github.com/libgit2/pygit2/issues/616>`_ `#898 <https://github.com/libgit2/pygit2/pull/898>`_ - New ``Patch.data`` returns the raw contents of the patch as a byte string `#790 <https://github.com/libgit2/pygit2/pull/790>`_ `#893 <https://github.com/libgit2/pygit2/pull/893>`_ - New ``Patch.text`` returns the contents of the patch as a text string, deprecates `Patch.patch` `#790 <https://github.com/libgit2/pygit2/pull/790>`_ `#893 <https://github.com/libgit2/pygit2/pull/893>`_ Deprecations: - ``Patch.patch`` is deprecated, use ``Patch.text`` instead
netbsd-srcmastr
referenced
this pull request
in NetBSD/pkgsrc
May 19, 2019
0.28.1 (2019-04-19) ------------------------- - Now works with pycparser 2.18 and above `#846 <https://github.com/libgit2/pygit2/issues/846>`_ - Now ``Repository.write_archive(..)`` keeps the file mode `#616 <https://github.com/libgit2/pygit2/issues/616>`_ `#898 <https://github.com/libgit2/pygit2/pull/898>`_ - New ``Patch.data`` returns the raw contents of the patch as a byte string `#790 <https://github.com/libgit2/pygit2/pull/790>`_ `#893 <https://github.com/libgit2/pygit2/pull/893>`_ - New ``Patch.text`` returns the contents of the patch as a text string, deprecates `Patch.patch` `#790 <https://github.com/libgit2/pygit2/pull/790>`_ `#893 <https://github.com/libgit2/pygit2/pull/893>`_ Deprecations: - ``Patch.patch`` is deprecated, use ``Patch.text`` instead
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This is an attempt to finish up the work in PR #790 originally done by @erikvanzijst. Thanks to him for the initial work.
Patch.patchassumes all content to be encoded in UTF-8 and forcefully replaces any non-decodeable sequences. This can lead to corruption for content that either does not conform to any specific encoding altogether, or uses an encoding that is incompatible with, or ambiguous to UTF-8.As discussed in #790, this change deprecates
Patch.patchin favor ofPatch.textand addsPatch.data, which returns the unmodified, raw bytes.