sambacc: complete type annotations #47
Conversation
sambacc/container_dns.py
Outdated
| self.ref = ref | ||
| self.items = items | ||
| self.items = items or [] |
There was a problem hiding this comment.
Consider having (align with other member-initialization in this PR):
self.ref: str = ref
self.items: list[HostInfo] = items or []
| @@ -85,7 +85,7 @@ def _get_events(self): | |||
| and ((event.mask & _inotify.flags.CLOSE_WRITE) != 0) | |||
| ] | |||
|
|
|||
| def _wait(self): | |||
| def _wait(self) -> typing.Iterator[None]: | |||
There was a problem hiding this comment.
Why no just have a single wait function? What is the advantage of using next(typing.Iterator[None]) ?
There was a problem hiding this comment.
At the time I must have felt implementing the function in terms of an iterator was easier or clearer. This PR only adds the proper type annotation to the function, it doesn't change the runtime behavior. Let's leave that for another time.
|
Wow. Somehow I managed to forget about this PR. I will need to revisit this soon! |
Signed-off-by: John Mulligan <[email protected]>
Signed-off-by: John Mulligan <[email protected]>
Signed-off-by: John Mulligan <[email protected]>
Signed-off-by: John Mulligan <[email protected]>
Signed-off-by: John Mulligan <[email protected]>
Signed-off-by: John Mulligan <[email protected]>
Signed-off-by: John Mulligan <[email protected]>
Signed-off-by: John Mulligan <[email protected]>
Signed-off-by: John Mulligan <[email protected]>
Signed-off-by: John Mulligan <[email protected]>
Signed-off-by: John Mulligan <[email protected]>
Signed-off-by: John Mulligan <[email protected]>
This includes a small change to the signature of the watch function to only accept a print_func callable and never none. This required a small update to the test code. The real code always passed a function and the ability to pass none never really could have worked right anyway. Signed-off-by: John Mulligan <[email protected]>
The sambacc dir is basically a library and we want to ensure high quality and good documentation so configure mypy to require type annotations on functions defined in sambacc. The sambacc.commands on the other hand are mean to be only run as part of our CLI tools so we'll be a bit less strict there. Signed-off-by: John Mulligan <[email protected]>
phlogistonjohn
force-pushed
the
jjm-even-more-typing
branch
from
586dd18
to
6aec8fd
Compare
| def smbd_foreground() -> SambaCommand: | ||
| return smbd[ | ||
| "--foreground", _daemon_stdout_opt("smbd"), "--no-process-group" | ||
| ] |
There was a problem hiding this comment.
IMHO, now that we have explicit return type, those lines look a bit enigmatic. I would consider (in a separate PR) to have more explicit code (also in other places below):
def smbd_foreground() -> SambaCommand:
return SambaCommand("/usr/sbin/smbd",
[ "--foreground", _daemon_stdout_opt("smbd"), "--no-process-group" ])
There was a problem hiding this comment.
I'll think about it. On the other hand, the square-braces after a SambaCommand object gives you a new SambaCommand object with additional arguments was there from the beginning as a convenient, don't need to repeat yourself, construct.
The sambacc dir is basically a library and we want to ensure high quality and good documentation so configure mypy to require
type annotations on functions defined in sambacc. Update code in sambacc to add type annotations to any functions lacking them.
The sambacc.commands on the other hand are mean to be only run as part of our CLI tools so we'll be a bit less strict there.