Type annotations for plain-flags

Author: davegaeddert

plain-flags/plain/flags/admin.py

@@ -8,7 +8,9 @@
     AdminViewset,
     register_viewset,
 )
+from plain.models import QuerySet
 from plain.models.forms import ModelForm
+from plain.preflight import PreflightResult
 
 from .models import Flag, FlagResult
 
@@ -17,13 +19,13 @@ class UnusedFlagsCard(Card):
     title = "Unused Flags"
 
     @cached_property
-    def flag_errors(self):
+    def flag_errors(self) -> list[PreflightResult]:
         return Flag.preflight()
 
-    def get_number(self):
+    def get_number(self) -> int:
         return len(self.flag_errors)
 
-    def get_text(self):
+    def get_text(self) -> str:
         return "\n".join(str(e.fix) for e in self.flag_errors)
 
 
@@ -63,7 +65,7 @@ class ListView(AdminModelListView):
         nav_section = "Feature flags"
         nav_icon = "flag"
 
-        def get_initial_queryset(self):
+        def get_initial_queryset(self) -> QuerySet:
             return self.model.query.all().select_related("flag")
 
     class DetailView(AdminModelDetailView):

plain-flags/plain/flags/bridge.py

@@ -1,10 +1,12 @@
+from types import ModuleType
+
 from plain.runtime import settings
 
 from . import exceptions
 from .flags import Flag
 
 
-def get_flags_module():
+def get_flags_module() -> ModuleType:
     flags_module = settings.FLAGS_MODULE
 
     try:

plain-flags/plain/flags/flags.py

@@ -95,7 +95,7 @@ def retrieve_or_compute_value(self) -> Any:
 
                 span.set_attribute(
                     FEATURE_FLAG_RESULT_REASON,
-                    FeatureFlagResultReasonValues.DYNAMIC.value,
+                    FeatureFlagResultReasonValues.TARGETING_MATCH.value,
                 )
                 span.set_attribute(FEATURE_FLAG_RESULT_VALUE, str(value))
 
@@ -142,13 +142,13 @@ def __bool__(self) -> bool:
         """
         return bool(self.value)
 
-    def __contains__(self, item) -> bool:
+    def __contains__(self, item: Any) -> bool:
         """
         Allow for use in `in` expressions.
         """
         return item in self.value
 
-    def __eq__(self, other) -> bool:
+    def __eq__(self, other: object) -> bool:
         """
         Allow for use in `==` expressions.
         """

plain-flags/plain/flags/models.py

@@ -10,7 +10,7 @@
 from .exceptions import FlagImportError
 
 
-def validate_flag_name(value):
+def validate_flag_name(value: str) -> None:
     if not re.match(r"^[a-zA-Z_][a-zA-Z0-9_]*$", value):
         raise ValidationError(f"{value} is not a valid Python identifier name")
 
@@ -30,7 +30,7 @@ class Meta:
             ),
         ]
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.key
 
 
@@ -57,11 +57,11 @@ class Meta:
             ),
         ]
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.name
 
     @classmethod
-    def preflight(cls):
+    def preflight(cls) -> list[PreflightResult]:
         """
         Check for flags that are in the database, but no longer defined in code.
 

scripts/type-validate

@@ -23,6 +23,7 @@ FULLY_TYPED_DIRS = [
     "plain-elements/plain/elements",
     "plain-email/plain/email",
     "plain-esbuild/plain/esbuild",
+    "plain-flags/plain/flags",
     "plain-sessions/plain/sessions",
 ]