add typing for functions in bps and common tasks #678
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
ShujiaoHee
commented
Jul 3, 2024
bim2sim/tasks/bps/enrich_material.py
Outdated
| @@ -180,7 +183,7 @@ def get_material_template(cls, material_name: str, resumed_names: list, | |||
| material_name) | |||
| return resumed[selected_material] | |||
|
|
|||
| def enrich_layer_set(self, invalid_element, resumed, templates): | |||
| def enrich_layer_set(self, invalid_element: Any, resumed: dict, templates: dict): | |||
There was a problem hiding this comment.
I think we will get different types if we run the different cases, so I just set it to "Any".
ShujiaoHee
commented
Jul 3, 2024
There was a problem hiding this comment.
When I checked typing on this file, there were multiple errors in other lines.
ShujiaoHee
commented
Jul 3, 2024
bim2sim/tasks/bps/plot_results.py
Outdated
| @@ -38,7 +40,7 @@ class PlotBEPSResults(ITask): | |||
| reads = ('df_finals', 'sim_results_path', 'ifc_files', 'elements') | |||
| final = True | |||
|
|
|||
| def run(self, df_finals, sim_results_path, ifc_files, elements): | |||
| def run(self, df_finals: dict, sim_results_path: Path, ifc_files: list, elements: dict): | |||
There was a problem hiding this comment.
I got the "NoneType" for the parameters "df_finals" and "sim_results_path" when I debug, but according to the Args above, I just added the dict and Path.
This reverts commit 9a63ddd.
This reverts commit 326b10e.
…to 653-typing-for-all-functions
# Conflicts: # bim2sim/tasks/bps/disaggr_creation.py # bim2sim/tasks/bps/enrich_material.py # bim2sim/tasks/bps/resolve_type_mismatch.py # bim2sim/tasks/bps/sb_2b_generation.py # bim2sim/tasks/bps/sb_correction.py # bim2sim/tasks/bps/verify.py # bim2sim/tasks/common/create_elements.py # bim2sim/tasks/common/serialize_elements.py
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 added basic type annotations to all functions where typing was missing, but I didn't delve deeply into the structure. So for most functions I didn't provide detailed type information, like the example
List[Type[ProductBased]], but I will try to see if there are some improvements. I hope to recieve feedback and suggestions, and would be glad to do the futher improvement. :)