aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/sentry_sdk/attachments.py
diff options
context:
space:
mode:
Diffstat (limited to '.venv/lib/python3.12/site-packages/sentry_sdk/attachments.py')
-rw-r--r--.venv/lib/python3.12/site-packages/sentry_sdk/attachments.py75
1 files changed, 75 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/sentry_sdk/attachments.py b/.venv/lib/python3.12/site-packages/sentry_sdk/attachments.py
new file mode 100644
index 00000000..e5404f86
--- /dev/null
+++ b/.venv/lib/python3.12/site-packages/sentry_sdk/attachments.py
@@ -0,0 +1,75 @@
+import os
+import mimetypes
+
+from sentry_sdk.envelope import Item, PayloadRef
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+ from typing import Optional, Union, Callable
+
+
+class Attachment:
+ """Additional files/data to send along with an event.
+
+ This class stores attachments that can be sent along with an event. Attachments are files or other data, e.g.
+ config or log files, that are relevant to an event. Attachments are set on the ``Scope``, and are sent along with
+ all non-transaction events (or all events including transactions if ``add_to_transactions`` is ``True``) that are
+ captured within the ``Scope``.
+
+ To add an attachment to a ``Scope``, use :py:meth:`sentry_sdk.Scope.add_attachment`. The parameters for
+ ``add_attachment`` are the same as the parameters for this class's constructor.
+
+ :param bytes: Raw bytes of the attachment, or a function that returns the raw bytes. Must be provided unless
+ ``path`` is provided.
+ :param filename: The filename of the attachment. Must be provided unless ``path`` is provided.
+ :param path: Path to a file to attach. Must be provided unless ``bytes`` is provided.
+ :param content_type: The content type of the attachment. If not provided, it will be guessed from the ``filename``
+ parameter, if available, or the ``path`` parameter if ``filename`` is ``None``.
+ :param add_to_transactions: Whether to add this attachment to transactions. Defaults to ``False``.
+ """
+
+ def __init__(
+ self,
+ bytes=None, # type: Union[None, bytes, Callable[[], bytes]]
+ filename=None, # type: Optional[str]
+ path=None, # type: Optional[str]
+ content_type=None, # type: Optional[str]
+ add_to_transactions=False, # type: bool
+ ):
+ # type: (...) -> None
+ if bytes is None and path is None:
+ raise TypeError("path or raw bytes required for attachment")
+ if filename is None and path is not None:
+ filename = os.path.basename(path)
+ if filename is None:
+ raise TypeError("filename is required for attachment")
+ if content_type is None:
+ content_type = mimetypes.guess_type(filename)[0]
+ self.bytes = bytes
+ self.filename = filename
+ self.path = path
+ self.content_type = content_type
+ self.add_to_transactions = add_to_transactions
+
+ def to_envelope_item(self):
+ # type: () -> Item
+ """Returns an envelope item for this attachment."""
+ payload = None # type: Union[None, PayloadRef, bytes]
+ if self.bytes is not None:
+ if callable(self.bytes):
+ payload = self.bytes()
+ else:
+ payload = self.bytes
+ else:
+ payload = PayloadRef(path=self.path)
+ return Item(
+ payload=payload,
+ type="attachment",
+ content_type=self.content_type,
+ filename=self.filename,
+ )
+
+ def __repr__(self):
+ # type: () -> str
+ return "<Attachment %r>" % (self.filename,)