Add return type hints #1371
Add return type hints #1371
Conversation
A lot of manual inspection 😅 Only way we could maybe automate is if deploy-agent supported some non-containerized runtime that maybe we could run some existing analysis tool on. I have another PR in-progress for adding types to class members too. |
| @@ -455,7 +458,7 @@ def _update_deploy_alias(self, deploy_goal): | |||
| deploy_goal.envName)) | |||
|
|
|||
| @staticmethod | |||
| def plan_changed(old_response, new_response): | |||
| def plan_changed(old_response, new_response) -> Union[PingResponse, bool, DeployGoal]: | |||
There was a problem hiding this comment.
this might be a signal that we need to refactor the code to have a single return type. Btw, can we use PingResponse | bool | DeployGoal?
There was a problem hiding this comment.
Agreed to your first point. That syntax is only supported in python 3.10 and above. https://peps.python.org/pep-0604/
| @@ -59,7 +60,7 @@ def get_build_id(filename, env_name): | |||
| return False, None | |||
|
|
|||
| @staticmethod | |||
| def get_stale_builds(build_timestamps, num_builds_to_retain=2): | |||
| def get_stale_builds(build_timestamps, num_builds_to_retain=2) -> Generator: | |||
There was a problem hiding this comment.
This is a generator function since it calls the yield keyword. https://stackoverflow.com/questions/43658999/what-is-the-return-type-hint-of-a-generator-function
|
Will split this PR into smaller ones for easier and safer rollout |
No description provided.