Add type annotations for source_app/utils.py

[pierwill]

Status

Ready for review.

I've posed a few questions on specific types in the comments below.

Description of Changes

This is work towards #4399.

[redshiftzero]

looks good!

one other thought: in other parts of the server codebase we have the imports needed only for type checking in a if TYPE_CHECKING block so they're not imported at runtime - @kushaldas (or others interested) want to keep doing that or no strong thoughts? I'll approve but not merge so folks have a chance to weigh in.

[kushaldas]

looks good!

one other thought: in other parts of the server codebase we have the imports needed only for type checking in a if TYPE_CHECKING block so they're not imported at runtime - @kushaldas (or others interested) want to keep doing that or no strong thoughts? I'll approve but not merge so folks have a chance to weigh in.

I prefer things under if TYPE_CHECKING if possible, but this is okay for me.

[pierwill]

I'll take a look at how the conditional import is done elsewhere and add this in!

[eloquence]

@pierwill Looks like linter is still unhappy, would you like help resolving these linter issues?

[pierwill]

That would be great! I haven't had time to troubleshoot this lately...

[eloquence]

No worries, @kushaldas will poke at it a bit more tomorrow.

[kushaldas]

This fixes the issue for me.

diff --git a/securedrop/source_app/utils.py b/securedrop/source_app/utils.py
index 3e430a81f..6c72a6de9 100644
--- a/securedrop/source_app/utils.py
+++ b/securedrop/source_app/utils.py
@@ -10,10 +10,6 @@ from threading import Thread
 
 import typing
 
-if typing.TYPE_CHECKING:
-    from typing import Optional  # noqa: F401
-
-
 import i18n
 import re
 
@@ -21,6 +17,9 @@ from crypto_util import CryptoUtil, CryptoException
 from models import Source
 from sdconfig import SDConfig
 
+if typing.TYPE_CHECKING:
+    from typing import Optional  # noqa: F401
+
 
 def logged_in() -> bool:
     return 'logged_in' in session

[pierwill]

Squashed and linted!

[rmol]

👍 Thanks for all the work on this @pierwill.