Added optional separator argument to TcpIo constructor #209
Conversation
|
Have you run the pre-commit linters and checkers on this? |
abbiemery
left a comment
abbiemery
left a comment
There was a problem hiding this comment.
I've not checked it working with the tests yet but just some formatting things.
Co-authored-by: Abigail Emery <abigail.emery@diamond.ac.uk>
Co-authored-by: Abigail Emery <abigail.emery@diamond.ac.uk>
|
Sorry no I forgot to do the pre-checks, I have tested you changes though and it all seems to work thanks |
|
@abbiemery Are you OK to approve this so it can be merged and released? |
|
Power cycling CI |
|
@LeeHudsonDLS Apologies, some of the CI was not running before
I have now fixed it. |
callumforrester
left a comment
callumforrester
left a comment
There was a problem hiding this comment.
Looks good, only a couple of small items.
src/tickit/adapters/io/tcp_io.py
Outdated
| def __init__(self, host: str, port: int, separator: str = None) -> None: | ||
| self.host = host | ||
| self.port = port | ||
| self.separator = separator |
There was a problem hiding this comment.
Nit: I'm not sure the name separator is completely right, maybe terminator? Or just add a comment explaining what it does, it's not immediately obvious to me from the name (unlike host and port). Not bothered by that enough to block merge though.
There was a problem hiding this comment.
Thanks Callum, i'm not too sure about this name either, the reason I chose separator is because that's the name of the parameter in StreamReader.readUntil. I guess in this context it really is a terminator though. It probably makes sense to change it, i'll do that now
Co-authored-by: Callum Forrester <callum.forrester@diamond.ac.uk>
When communicating with a simulated device using an ascii protocol I found that the StreamReader.read() method returns inconsistent number of bytes. Even the documentation alludes to this inconsistency:
If n is positive, this function try to read
nbytes, and may returnless or equal bytes than requested, but at least one byte. If EOF was
received before any byte is read, this function returns empty byte
object.
As the majority of devices that communicate using an ascii based protocol rely on a termination character to determine the end of a message I have added this as an optional parameter in the tickit.adapters.io.TcpIo class.