ref: add typing stubs for petname (#50665)

<!-- Describe your PR here. -->

fixtures/stubs-for-mypy/petname/__init__.pyi

@@ -0,0 +1,4 @@
+def adverb(letters: int = ...) -> str: ...
+def adjective(letters: int = ...) -> str: ...
+def name(letters: int = ...) -> str: ...
+def generate(words: int = ..., separator: str = ..., letters: int = ...) -> str: ...

fixtures/stubs-for-mypy/petname/english.pyi

@@ -0,0 +1,3 @@
+adjectives: list[str]
+adverbs: list[str]
+names: list[str]

pyproject.toml

@@ -114,7 +114,6 @@ module = [
     "onelogin.saml2.constants.*",
     "onelogin.saml2.idp_metadata_parser.*",
     "openapi_core.*",
-    "petname.*",
     "phabricator.*",
     "phonenumbers.*",
     "progressbar.*",

src/sentry/api/endpoints/user_authenticator_enroll.py

@@ -68,7 +68,7 @@ class U2fRestSerializer(serializers.Serializer):
         allow_blank=True,
         max_length=60,
         trim_whitespace=False,
-        default=lambda: petname.Generate(2, " ", letters=10).title(),
+        default=lambda: petname.generate(2, " ", letters=10).title(),
     )
     challenge = serializers.CharField(required=True, trim_whitespace=False)
     response = serializers.CharField(required=True, trim_whitespace=False)

src/sentry/models/apiapplication.py

@@ -21,7 +21,7 @@ from sentry.types.region import find_all_region_names
 
 
 def generate_name():
-    return petname.Generate(2, " ", letters=10).title()
+    return petname.generate(2, " ", letters=10).title()
 
 
 def generate_token():

src/sentry/models/projectkey.py

@@ -150,7 +150,7 @@ class ProjectKey(Model):
         if not self.secret_key:
             self.secret_key = ProjectKey.generate_api_key()
         if not self.label:
-            self.label = petname.Generate(2, " ", letters=10).title()
+            self.label = petname.generate(2, " ", letters=10).title()
         super().save(*args, **kwargs)
 
     def get_dsn(self, domain=None, secure=True, public=False):

src/sentry/testutils/factories.py

@@ -262,7 +262,7 @@ class Factories:
     @exempt_from_silo_limits()
     def create_organization(name=None, owner=None, **kwargs):
         if not name:
-            name = petname.Generate(2, " ", letters=10).title()
+            name = petname.generate(2, " ", letters=10).title()
 
         org = Organization.objects.create(name=name, **kwargs)
 
@@ -341,7 +341,7 @@ class Factories:
     @exempt_from_silo_limits()
     def create_team(organization, **kwargs):
         if not kwargs.get("name"):
-            kwargs["name"] = petname.Generate(2, " ", letters=10).title()
+            kwargs["name"] = petname.generate(2, " ", letters=10).title()
         if not kwargs.get("slug"):
             kwargs["slug"] = slugify(str(kwargs["name"]))
         members = kwargs.pop("members", None)
@@ -355,7 +355,7 @@ class Factories:
     @staticmethod
     @exempt_from_silo_limits()
     def create_environment(project, **kwargs):
-        name = kwargs.get("name", petname.Generate(3, " ", letters=10)[:64])
+        name = kwargs.get("name", petname.generate(3, " ", letters=10)[:64])
 
         organization = kwargs.get("organization")
         organization_id = organization.id if organization else project.organization_id
@@ -368,7 +368,7 @@ class Factories:
     @exempt_from_silo_limits()
     def create_project(organization=None, teams=None, fire_project_created=False, **kwargs):
         if not kwargs.get("name"):
-            kwargs["name"] = petname.Generate(2, " ", letters=10).title()
+            kwargs["name"] = petname.generate(2, " ", letters=10).title()
         if not kwargs.get("slug"):
             kwargs["slug"] = slugify(str(kwargs["name"]))
         if not organization and teams:
@@ -612,7 +612,7 @@ class Factories:
         repo, _ = Repository.objects.get_or_create(
             organization_id=project.organization_id,
             name=name
-            or "{}-{}".format(petname.Generate(2, "", letters=10), random.randint(1000, 9999)),
+            or "{}-{}".format(petname.generate(2, "", letters=10), random.randint(1000, 9999)),
             provider=provider,
             integration_id=integration_id,
             url=url,
@@ -909,7 +909,7 @@ class Factories:
     def _sentry_app_kwargs(**kwargs):
         _kwargs = {
             "user": kwargs.get("user", Factories.create_user()),
-            "name": kwargs.get("name", petname.Generate(2, " ", letters=10).title()),
+            "name": kwargs.get("name", petname.generate(2, " ", letters=10).title()),
             "organization_id": kwargs.get(
                 "organization_id", kwargs.pop("organization", Factories.create_organization()).id
             ),
@@ -1084,7 +1084,7 @@ class Factories:
     @staticmethod
     def _doc_integration_kwargs(**kwargs):
         _kwargs = {
-            "name": kwargs.get("name", petname.Generate(2, " ", letters=10).title()),
+            "name": kwargs.get("name", petname.generate(2, " ", letters=10).title()),
             "author": kwargs.get("author", "me"),
             "description": kwargs.get("description", "hi im a description"),
             "url": kwargs.get("url", "https://sentry.io"),
@@ -1205,7 +1205,7 @@ class Factories:
         alert_rule=None,
     ):
         if not title:
-            title = petname.Generate(2, " ", letters=10).title()
+            title = petname.generate(2, " ", letters=10).title()
         if alert_rule is None:
             alert_rule = Factories.create_alert_rule(
                 organization, projects, query=query, time_window=1
@@ -1262,7 +1262,7 @@ class Factories:
         comparison_delta=None,
     ):
         if not name:
-            name = petname.Generate(2, " ", letters=10).title()
+            name = petname.generate(2, " ", letters=10).title()
 
         if query_type is None:
             query_type = query_datasets_to_type[dataset]
@@ -1297,7 +1297,7 @@ class Factories:
     @exempt_from_silo_limits()
     def create_alert_rule_trigger(alert_rule, label=None, alert_threshold=100):
         if not label:
-            label = petname.Generate(2, " ", letters=10).title()
+            label = petname.generate(2, " ", letters=10).title()
 
         return create_alert_rule_trigger(alert_rule, label, alert_threshold)