From 740e7f961169e73a592aa1c6fc7eb5dfdbef3439 Mon Sep 17 00:00:00 2001
From: anthony sottile <anthony.sottile@sentry.io>
Date: Mon, 22 Jul 2024 15:41:04 -0400
Subject: [PATCH] ref: unify the signature of Interface.to_string

---
 src/sentry/interfaces/base.py                 | 2 +-
 src/sentry/interfaces/exception.py            | 4 ++--
 src/sentry/interfaces/message.py              | 2 +-
 src/sentry/interfaces/security.py             | 2 +-
 src/sentry/interfaces/stacktrace.py           | 4 ++--
 src/sentry/interfaces/template.py             | 2 +-
 tests/sentry_plugins/victorops/test_plugin.py | 2 +-
 7 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/src/sentry/interfaces/base.py b/src/sentry/interfaces/base.py
index a580872f05ada1..1c5eeb43423371 100644
--- a/src/sentry/interfaces/base.py
+++ b/src/sentry/interfaces/base.py
@@ -155,7 +155,7 @@ def get_score(self) -> int:
     def iter_tags(self):
         return iter(())
 
-    def to_string(self, event, is_public=False, **kwargs):
+    def to_string(self, event) -> str:
         return ""
 
     def to_email_html(self, event, **kwargs):
diff --git a/src/sentry/interfaces/exception.py b/src/sentry/interfaces/exception.py
index 6e9a4dc035b515..0ba8666e75f95d 100644
--- a/src/sentry/interfaces/exception.py
+++ b/src/sentry/interfaces/exception.py
@@ -454,7 +454,7 @@ def get_api_meta(self, meta, is_public=False, platform=None):
 
         return {"values": result}
 
-    def to_string(self, event, is_public=False, **kwargs):
+    def to_string(self, event) -> str:
         if not self.values:
             return ""
 
@@ -471,7 +471,7 @@ def to_string(self, event, is_public=False, **kwargs):
                     )
                     + "\n\n"
                 )
-        return ("".join(output)).strip()
+        return "".join(output).strip()
 
     def get_stacktrace(self, *args, **kwargs):
         exc = self.values[-1]
diff --git a/src/sentry/interfaces/message.py b/src/sentry/interfaces/message.py
index 8fd69bf3269803..2a838149eb620e 100644
--- a/src/sentry/interfaces/message.py
+++ b/src/sentry/interfaces/message.py
@@ -47,5 +47,5 @@ def to_json(self):
             {"message": self.message, "formatted": self.formatted, "params": self.params or None}
         )
 
-    def to_string(self, event, is_public=False, **kwargs):
+    def to_string(self, event) -> str:
         return self.formatted or self.message
diff --git a/src/sentry/interfaces/security.py b/src/sentry/interfaces/security.py
index ec086d68ff285e..92f7b24bcdbfb3 100644
--- a/src/sentry/interfaces/security.py
+++ b/src/sentry/interfaces/security.py
@@ -172,7 +172,7 @@ def to_python(cls, data, **kwargs):
         data.setdefault("effective_directive", None)
         return super().to_python(data, **kwargs)
 
-    def to_string(self, is_public=False, **kwargs):
+    def to_string(self, event) -> str:
         return orjson.dumps(
             {"csp-report": self.get_api_context()},
             option=orjson.OPT_UTC_Z | orjson.OPT_NON_STR_KEYS,
diff --git a/src/sentry/interfaces/stacktrace.py b/src/sentry/interfaces/stacktrace.py
index caa047f3636824..83f14310b7196c 100644
--- a/src/sentry/interfaces/stacktrace.py
+++ b/src/sentry/interfaces/stacktrace.py
@@ -325,7 +325,7 @@ def is_unhashable_function(self):
         # queries and JSON data)
         return self.function.startswith(("lambda$", "[Anonymous"))
 
-    def to_string(self, event):
+    def to_string(self, event) -> str:
         if event.platform is not None:
             choices = [event.platform]
         else:
@@ -525,7 +525,7 @@ def to_json(self):
             }
         )
 
-    def to_string(self, event, is_public=False, **kwargs):
+    def to_string(self, event) -> str:
         return self.get_stacktrace(event, system_frames=False, max_frames=10)
 
     def get_stacktrace(
diff --git a/src/sentry/interfaces/template.py b/src/sentry/interfaces/template.py
index 3ae0f1a30cbd8f..ab2a5ca6a36680 100644
--- a/src/sentry/interfaces/template.py
+++ b/src/sentry/interfaces/template.py
@@ -45,7 +45,7 @@ def to_python(cls, data, **kwargs):
 
         return super().to_python(data, **kwargs)
 
-    def to_string(self, event, is_public=False, **kwargs):
+    def to_string(self, event) -> str:
         context = get_context(
             lineno=self.lineno,
             context_line=self.context_line,
diff --git a/tests/sentry_plugins/victorops/test_plugin.py b/tests/sentry_plugins/victorops/test_plugin.py
index 028cf37026590f..f03ef5f5e0a580 100644
--- a/tests/sentry_plugins/victorops/test_plugin.py
+++ b/tests/sentry_plugins/victorops/test_plugin.py
@@ -16,7 +16,7 @@
 
 
 class UnicodeTestInterface(Interface):
-    def to_string(self, event):
+    def to_string(self, event) -> str:
         return self.body
 
     def get_title(self):