Adding Mypy type annotations to domain folder files

[sajalasati]

This issue will track the type annotation process of all the core/domain/*.py (and their test files). To get started, ask to be assigned to any unclaimed task. Tasks are claimed by adding the username of the claimer to the end of the task, e.g. @example.

Note: Main code file and its test file must be type-annotated together.

The general procedure to add type annotations is as follows:

1. Start with the main code file first.
2. Remove the file to be annotated from the mypy denylist (i.e. from NOT_FULLY_COVERED_FILES in scripts/run_mypy_checks.py). Run the mypy checks on the code file using python -m scripts.run_mypy_checks --files <path/to/file> to understand all the errors mypy is reporting for this file.
3. Go over them one by one, and fix them by following the detailed instructions as mentioned in our wiki.
4. PAY ATTENTION to our guidelines for using type ignores in the codebase.
5. For testing the changes after annotating all the files, run python -m scripts.run_mypy_checks, which runs the type checks on the entire codebase, and ensure that no errors are being reported.
6. If errors occur in other files due to you change make sure to also fix those other files.

Good examples of already annotated files in the codebase:

1. Check out the core/storage folder.
2. Ref PR for domain file type annotation: Fix part of #14033: Type annotate activity_domain file #14034

If you face problems in understanding a particular case while adding annotations, please go over the tips mentioned in the wiki once, and let us know if you are still stuck!

Tasks/files:

• core/domain/action_registry.py@sahiljoster32
• core/domain/activity_services.py@sahiljoster32
• core/domain/auth_services.py @IamhappyXD
• core/domain/blog_services.py @IamhappyXD
• core/domain/calculation_registry.py@sahiljoster32
• core/domain/classifier_services.py
• core/domain/classroom_services.py @SD-13
• core/domain/collection_services.py
• core/domain/config_services.py@sahiljoster32
• core/domain/cron_services.py @SD-13
• core/domain/customization_args_util.py
• core/domain/draft_upgrade_services.py
• core/domain/email_manager.py
• core/domain/email_services.py @jordyparker
• core/domain/email_subscription_services.py@sahiljoster32
• core/domain/event_services.py
• core/domain/exp_fetchers.py
• core/domain/exp_services.py
• core/domain/expression_parser.py
• core/domain/feedback_services.py
• core/domain/fs_services.py @sahiljoster32
• core/domain/html_cleaner.py @SD-13
• core/domain/html_validation_service.py
• core/domain/image_services.py @gopivaibhav
• core/domain/image_validation_services.py @hsadia538
• core/domain/improvements_services.py
• core/domain/interaction_registry.py
• core/domain/learner_goals_services.py
• core/domain/learner_playlist_services.py
• core/domain/learner_progress_services.py
• core/domain/moderator_services.py
• core/domain/object_registry.py
• core/domain/opportunity_services.py
• core/domain/platform_feature_services.py
• core/domain/platform_parameter_list.py @Darsuu
• core/domain/platform_parameter_list_test.py @Darsuu
• core/domain/platform_parameter_registry.py @Darsuu
• core/domain/playthrough_issue_registry.py @Darsuu
• core/domain/question_fetchers.py @winnie368c
• core/domain/question_services.py
• core/domain/rating_services.py @IamhappyXD
• core/domain/recommendations_services.py
• core/domain/rights_manager.py
• core/domain/role_services.py @gopivaibhav
• core/domain/rte_component_registry.py @hsadia538
• core/domain/rules_registry.py @hsadia538
• core/domain/search_services.py
• core/domain/skill_fetchers.py
• core/domain/skill_services.py
• core/domain/stats_services.py
• core/domain/story_fetchers.py
• core/domain/story_services.py
• core/domain/subscription_services.py
• core/domain/subtopic_page_services.py @ashish-patwal
• core/domain/suggestion_registry.py
• core/domain/suggestion_services.py
• core/domain/summary_services.py
• core/domain/takeout_service.py @jordyparker
• core/domain/taskqueue_services.py @jordyparker
• core/domain/topic_fetchers.py @SD-13
• core/domain/topic_services.py @SD-13
• core/domain/translatable_object_registry.py @ashish-patwal
• core/domain/translation_fetchers.py @sahiljoster32
• core/domain/translation_services.py @sahiljoster32
• core/domain/user_query_services.py @SD-13
• core/domain/user_services.py @SD-13
• core/domain/visualization_registry.py' @SD-13
• core/domain/voiceover_services.py @SD-13
• core/domain/wipeout_service.py @SD-13
• core/domain/change_domain.py @div-yam
• core/domain/collection_domain.py @sahiljoster32
• core/domain/exp_domain.py @Yavnikaa
• core/domain/fs_domain.py @PranshuSrivastava
• core/domain/param_domain.py @asmit2952 (attempted in Mypy annotation 3 files #14302)
• core/domain/platform_parameter_domain.py @asmit2952 (attempted in Mypy annotation 3 files #14302)
• core/domain/question_domain.py @asmit2952 (attempted in Mypy annotation 3 files #14302)
• core/domain/skill_domain.py @dhruvshrivastava
• core/domain/state_domain.py @dhruvshrivastava
• core/domain/stats_domain.py @winnie368c
• core/domain/story_domain.py @Sangkyun-Kim15
• core/domain/subtopic_page_domain.py @ashish-patwal
• core/domain/user_domain.py@sahiljoster32
• core/domain/user_query_domain.py @ashish-patwal

[kingjuno]

@sajalasati Assign me the following
core/domain/auth_domain.py
core/domain/blog_domain.py
core/domain/caching_domain.py

[sajalasati]

@sajalasati Assign me the following core/domain/auth_domain.py core/domain/blog_domain.py core/domain/caching_domain.py

@kingjuno I've assigned you now!

[vashuteotia123]

@sajalasati Can I get any three files assigned to me?

[sajalasati]

@sajalasati Can I get any three files assigned to me?

Done, assigned you the next 3 in order.

[aniketh-varma]

Hi @sajalasati, I would like to work on this. Please assign me a file.

[sajalasati]

Hi @sajalasati, I would like to work on this. Please assign me a file.

Done!

[vashuteotia123]

@sajalasati Can you just tell me what will be the annotation for this?

[ShivamJhaa]

Hey @sajalasati Can you please assign me
core/domain/config_domain.py
core/domain/exp_domain.py
Thanks

[sajalasati]

@sajalasati Can you just tell me what will be the annotation for this?

@vashuteotia123 We could use List[Dict[str,Union(int,List[str])]] for this case.

Just a note for future, it would be helpful if you can provide a link to the code (file) where you have doubts, and possibly your guessed annotation too, so that we can help you understand what (and why) that annotation should be. I hope this helps :)

[sajalasati]

Hey @sajalasati Can you please assign me core/domain/config_domain.py core/domain/exp_domain.py Thanks

@ShivamJhaa Done!

[vashuteotia123]

@sajalasati Can you just tell me what will be the annotation for this?

@vashuteotia123 We could use List[Dict[str,Union(int,List[str])]] for this case.

Just a note for future, it would be helpful if you can provide a link to the code (file) where you have doubts, and possibly your guessed annotation too, so that we can help you understand what (and why) that annotation should be. I hope this helps :)

@sajalasati I did somewhat the same, I didn't know about Union, will understand the working of it and implement it.
Thanks.

[sajalasati]

@sajalasati Can you just tell me what will be the annotation for this?

@vashuteotia123 We could use List[Dict[str,Union(int,List[str])]] for this case.
Just a note for future, it would be helpful if you can provide a link to the code (file) where you have doubts, and possibly your guessed annotation too, so that we can help you understand what (and why) that annotation should be. I hope this helps :)

@sajalasati I did somewhat the same, I didn't know about Union, will understand the working of it and implement it. Thanks.

@vashuteotia123 No issues, just check for it in the codebase, you'll find plenty of examples.

[ShivamJhaa]

Hey @sajalasati Can you help me in determining the type annotation of these two

in core/domain/config_domain.py.
Thanks

[lheureuxe13]

Hi @sajalasati, please assign me 3 where needed. Thanks

[ShivamJhaa]

@vojtechjelinek @sajalasati What will be the annotation for this?

Thanks

[megamayoy]

@sajalasati I wanna contribute during the Hacktoberfest. Will you please assign me 2 files?

[vojtechjelinek]

Hey @sajalasati Can you help me in determining the type annotation of these two in core/domain/config_domain.py. Thanks

These shouldn't need any typing.

[vojtechjelinek]

@megamayoy @lheureuxe13 Done!

[sahiljoster32]

Hi @hsadia538 ,
Sorry to say but this issue from now is not available for new contributors. Because the files mentioned in this issue is going to be covered under the GSoC project Make backend code typed.

But still, you can find other beginner-friendly issues by searching the good first issue label in the issues tab or you can click here for beginner-friendly issues

[swethasekhar]

Hi Team ,
I get the below errors for stats_services.py file
The error is
Value of type variable "SELF_BASE_MODEL" of "update_timestamps_multi" of "BaseModel" cannot be "Optional[PlaythroughModel]" [type-var]

Value of type variable "SELF_BASE_MODEL" of "put_multi" of "BaseModel" cannot be "Optional[PlaythroughModel]" [type-var]

Thanks for your help !

[aasiffaizal]

@swethasekhar
You might need to overload the function in PlaythroughModel for those functions and specify the types of parameter and return type (if applicable).
You can refer to the code base here we have used it.

[Darsuu]

@vojtechjelinek could you unassign me from my files? Thank you

[vojtechjelinek]

@Darsuu Sorry, this issue is no longer available for new contributors. Please check issues with "Good first issue" label.

[sahiljoster32]

@seanlip @aasiffaizal -- I think we can close this issue as we have covered all the files of the code/domain directory, Thanks.

@kevintab95 -- One question why Improvement label is added ?, I think all files of code/domain are covered.

[kevintab95]

Considering this is an infra / maintenance related issue, I thought it was relevant to tag as "improvement" (as opposed to a "bug".)

[seanlip]

@sahiljoster32 Sounds good, closing it. Thanks!