Add type annotations to db/util.py and configured mypy #3280

skools-here · 2025-09-20T13:42:23Z

Description
This PR introduces type annotations to the augur\application\db\util.py file and adds mypy for static type checking.
This PR fixes #3274

Changes included:

Ran mypy locally on the project and fixed all type issues in this file and made mypy.ini so we can add more files in future for types checking.
Starting with smaller utility/helper files as suggested, focusing on the ORM/database access layer.

Notes for Reviewers

Signed commits

Yes, I signed my commits.

MoralCode

seems like an okay first pass (i still need to test it locally)

Overall notes:

any changes to the actual logic are likely going to slow this down a fair bit as the logic needs testing to make sure it behaves the same
also, try to avoid using Any as a type if you can at all avoid it - its not very helpful at enforcing typings since it accepts anything.

MoralCode · 2025-09-22T18:23:04Z

augur/application/db/util.py

-
-        # do the sleep here instead of instead of in the exception 
-        # so it doesn't sleep after the last failed time
        if attempts > 0:
-            #Do a 30% exponential backoff
+            # Do a 30% exponential backoff


this seems like a non-typing change that removed a helpful comment - was this removed on purpose?

MoralCode · 2025-09-22T18:24:06Z

augur/application/db/util.py

-
-def convert_orm_list_to_dict_list(result):
-    new_list = []
+def convert_orm_list_to_dict_list(result: List[Any]) -> List[Dict[str, Any]]:


it might be nice to not use Any as the type here - does the ORM have a base/parent class that all the ORM classes inherit from? maybe thats a better thing to use?

I’ll update convert_orm_list_to_dict_list to use the ORM base class, and refine config_dict + logger to use more specific types (Optional[logging.Logger], etc.) .

MoralCode · 2025-09-22T18:25:38Z

augur/application/db/util.py

-
-    data_type = config_dict["type"]
+def convert_type_of_value(
+    config_dict: Dict[str, Any], logger: Optional[Any] = None


does config_dict come from somewhere? could its type be specified more precisely than Any? same with the logger

MoralCode · 2025-09-22T18:26:23Z

augur/application/db/util.py

-    if data_type == "str" or data_type is None:
+    if data_type is None or data_type == "str":


why was the order of these changed? this could cause a crash if the data type is none because it is relying on the short curcuiting behavior of or

Yes i will fix this this .

MoralCode · 2025-09-22T18:27:32Z

augur/application/db/util.py

-        else:
-            config_dict["value"] = True
+        value = str(config_dict["value"]).lower()
+        config_dict["value"] = value != "false"


if value is exactly false (string), this will evaluate to true.

wait did i get this wrong?

the earlier function (Not type safe one) already had that anything not false is True behavior. So according to me this must work i am not sure though .

skools-here · 2025-09-22T19:33:19Z

Yes thanks for the review will be changing all the logic changes which may cause problem and will also try to reduce the use of any .

MoralCode · 2025-09-26T19:41:23Z

we should also probably add a CI job to check the types so its clear if something breaks on a pull request

MoralCode · 2025-09-29T14:20:57Z

pyproject.toml

    "pytest==6.2.5",
    "toml>=0.10.2",
    "ipdb==0.13.9",
+    "mypy>=1.8.0",


if you change this file, you also need to run uv sync and commit the changes to the uv.lock file. this will likely help some of the CI jobs pass

Signed-off-by: Sajal-Kulshreshtha <sajalkulshreshtha9@gmail.com>

MoralCode · 2025-10-15T19:40:10Z

@skools-here do you have any updates on this?

no worries if not - just wanted to check if you were still interested in merging this. If not, I can potentially find another maintainer can take over and make the necessary adjustments to get this merged

Part of me also wonders what would happen if mypy is run on this repo without any explicit typing added? 🤔

skools-here · 2025-10-15T19:45:51Z

@MoralCode After revisiting the , I realized this might be a bit more complex than I initially expected, especially around how mypy interacts with the existing code. I don’t think I’ll be able to give it the attention it needs right now, so feel free to reassign it or have someone else take it over.

MoralCode · 2025-10-27T19:15:45Z

Superseeded by #3315

skools-here force-pushed the fix-db-types branch 2 times, most recently from 8b20725 to c7734aa Compare September 20, 2025 13:51

MoralCode requested changes Sep 22, 2025

View reviewed changes

skools-here force-pushed the fix-db-types branch from 941b7e8 to 7314d01 Compare September 23, 2025 11:01

MoralCode reviewed Sep 29, 2025

View reviewed changes

skools-here force-pushed the fix-db-types branch from 8c883ec to 41eb3c9 Compare September 29, 2025 14:36

skools-here requested a review from sgoggins as a code owner October 3, 2025 08:23

skools-here added 6 commits October 3, 2025 13:54

added mypy and fixed one file types issues

11b90f2

Signed-off-by: Sajal-Kulshreshtha <sajalkulshreshtha9@gmail.com>

fixed one unnecessary change

1b46aaa

Signed-off-by: Sajal-Kulshreshtha <sajalkulshreshtha9@gmail.com>

reduced use of any and fixed some logical errors

355e5dd

Signed-off-by: Sajal-Kulshreshtha <sajalkulshreshtha9@gmail.com>

added CI Job for type checking

7691979

Signed-off-by: Sajal-Kulshreshtha <sajalkulshreshtha9@gmail.com>

Update dependencies and sync lockfile

5f480f4

Signed-off-by: Sajal-Kulshreshtha <sajalkulshreshtha9@gmail.com>

fixing circular dependency and mypy errors

e6126e5

Signed-off-by: Sajal-Kulshreshtha <sajalkulshreshtha9@gmail.com>

skools-here force-pushed the fix-db-types branch from 412b13f to e6126e5 Compare October 3, 2025 08:24

MoralCode mentioned this pull request Oct 15, 2025

Alternative mypy setup #3315

Merged

1 task

MoralCode closed this Oct 27, 2025

		if data_type == "str" or data_type is None:
		if data_type is None or data_type == "str":

Add type annotations to db/util.py and configured mypy #3280

Add type annotations to db/util.py and configured mypy #3280

Uh oh!

Conversation

skools-here commented Sep 20, 2025

Uh oh!

MoralCode left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

skools-here commented Sep 22, 2025

Uh oh!

MoralCode commented Sep 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MoralCode commented Oct 15, 2025

Uh oh!

skools-here commented Oct 15, 2025

Uh oh!

MoralCode commented Oct 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants