Add type hints to sygnal/utils.py
#276
Conversation
| @@ -65,7 +71,7 @@ def glob_to_regex(glob): | |||
| return re.compile(r"\A" + res + r"\Z", re.IGNORECASE) | |||
|
|
|||
|
|
|||
| def _reject_invalid_json(val): | |||
| def _reject_invalid_json(val: Any) -> None: | |||
There was a problem hiding this comment.
Could also use NoReturn here, but I don't think there's any practical benefit to doing so.
sygnal/utils.py
Outdated
| return f"[{self.extra['request_id']}] {msg}", kwargs | ||
|
|
||
|
|
||
| def glob_to_regex(glob): | ||
| def glob_to_regex(glob: str) -> Union[Pattern, Pattern[str]]: |
There was a problem hiding this comment.
I don't understand the return type here---why can't we just say it returns a Pattern[str] in all cases?
There was a problem hiding this comment.
I nicked this from somewhere and now I can't remember where, but I think you are correct we can use the narrower case. I will change this.
|
|
||
| async def twisted_sleep(delay, twisted_reactor): | ||
|
|
||
| async def twisted_sleep(delay: float, twisted_reactor: "SygnalReactor") -> None: |
There was a problem hiding this comment.
This is fine as it is, but I wanted to mention a couple of alternatives here. One be to write twisted_reactor: IReactorTime and only import IReactorTime; a second would be to move SygnalReactor into a new file, say sygnal/types.py.
There was a problem hiding this comment.
Great, I appreciate knowing alternative solutions, it really helps to have more tools in my arsenal.
As the title states.