Documented read_until function #356
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
…lity beyond just line terminators.
| @@ -649,19 +649,19 @@ def read_all(self): | |||
| """ | |||
| return self.read(self.in_waiting) | |||
|
|
|||
| def read_until(self, terminator=LF, size=None): | |||
| def read_until(self, expected=LF, size=None): | |||
There was a problem hiding this comment.
renaming the parameter may break some code, but it makes sense to align the name with the function from telnetlib
There was a problem hiding this comment.
Confirming that this broke some code. Does this project not use semantic versioning? This rolled out with version 3.5b0 if I follow the history correctly, yet it included this API breaking change. The changelog lumps this in with "doc updates" but that is not quite accurate in this case.
|
Thank you. |
|
Looks like I should have escaped the '\'; Just noticed on read the docs that it rendered as (‘n’ by default) instead of ('\n’ by default) Thanks for the awesome package! |
bgottula
added a commit
to seeing-things/point
that referenced
this pull request
Mar 3, 2021
The pySerial project made a change to the parameter name for the `read_until()` method in version 3.5. Since this project apparently does not follow semantic versioning (made an API-breaking change without incrementing the major version number) I have to restrict the versions of this package that are allowed. See also pyserial/pyserial#356 where the possibility of breaking code was even noticed by the reviewer but then decided to accept the pull request anyway. Why?? :(
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.
I end up writing my own flavor of read_until every time to line up with telnetlib. Didn't know it was apart of pyserial already! Documented the function. I also tweaked the parameter name to match telnetlib but it is not affecting anything if that is left as terminator.