Skip to content

Commit

Permalink
ref(fields): Use drf-spec types over native python types for serializ…
Browse files Browse the repository at this point in the history
…er fields (#59491)

mypy complained in a recent PR when doing something like
`@extend_schema_field(str)`, so I'm switching over the existing ones to
use drf-spec types

---------

Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
  • Loading branch information
schew2381 and getsantry[bot] committed Nov 7, 2023
1 parent 1f7a5c3 commit 0545f79
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 4 deletions.
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,6 @@ module = [
"sentry.api.serializers.rest_framework.doc_integration",
"sentry.api.serializers.rest_framework.mentions",
"sentry.api.serializers.rest_framework.notification_action",
"sentry.api.serializers.rest_framework.project",
"sentry.api.serializers.rest_framework.release",
"sentry.api.serializers.rest_framework.rule",
"sentry.api.serializers.rest_framework.sentry_app_request",
Expand Down
3 changes: 2 additions & 1 deletion src/sentry/api/fields/actor.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

from typing import TYPE_CHECKING

from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import extend_schema_field
from rest_framework import serializers

Expand All @@ -14,7 +15,7 @@
from sentry.services.hybrid_cloud.user import RpcUser


@extend_schema_field(str)
@extend_schema_field(field=OpenApiTypes.STR)
class ActorField(serializers.Field):
def __init__(self, *args, **kwds):
self.as_actor = kwds.pop("as_actor", False)
Expand Down
3 changes: 2 additions & 1 deletion src/sentry/api/serializers/rest_framework/project.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import extend_schema_field
from rest_framework import serializers

Expand All @@ -6,7 +7,7 @@
ValidationError = serializers.ValidationError


@extend_schema_field(str)
@extend_schema_field(field=OpenApiTypes.STR)
class ProjectField(serializers.Field):
def __init__(self, scope="project:write"):
self.scope = scope
Expand Down
3 changes: 2 additions & 1 deletion src/sentry/api/serializers/rest_framework/rule.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import extend_schema_field
from rest_framework import serializers

Expand All @@ -11,7 +12,7 @@
ValidationError = serializers.ValidationError


@extend_schema_field(dict)
@extend_schema_field(field=OpenApiTypes.OBJECT)
class RuleNodeField(serializers.Field):
def __init__(self, type):
super().__init__()
Expand Down

0 comments on commit 0545f79

Please sign in to comment.