Skip to main content

ShareFile

Represents a file to share, either from disk or in-memory bytes.

Properties

  • data - Raw bytes of the file to share.
  • mime_type - MIME type of the file.
  • name - Optional name of the file.
  • path - Filesystem path to the file to share.

Methods

  • from_bytes - Create ShareFile from raw bytes.
  • from_path - Create ShareFile from a filesystem path.

Properties​

dataclass-attributeinstance-attribute​

data: bytes | None = None

Raw bytes of the file to share.

mime_typeclass-attributeinstance-attribute​

mime_type: str | None = None

MIME type of the file.

nameclass-attributeinstance-attribute​

name: str | None = None

Optional name of the file.

pathclass-attributeinstance-attribute​

path: str | None = None

Filesystem path to the file to share.

Methods​

from_bytesstaticmethod​

from_bytes(
    data: bytes,
    mime_type: str | None = None,
    name: str | None = None,
) -> ShareFile

Create ShareFile from raw bytes.

Parameters:

  • data (bytes) - Raw bytes of the file.
  • mime_type (str | None, default: None) - Optional MIME type of the file.
  • name (str | None, default: None) - Optional name of the file.

from_pathstaticmethod​

from_path(
    path: str, name: str | None = None
) -> ShareFile

Create ShareFile from a filesystem path.

Parameters:

  • path (str) - Filesystem path to the file.
  • name (str | None, default: None) - Optional name of the file.