ShareFile

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

Properties

• data(bytes | None) –

  Raw bytes of the file to share.

• mime_type(str | None) –

  MIME type of the file.

• name(str | None) –

  Optional name of the file.

• path(str | None) –

  Filesystem path to the file to share.

Methods

• from_bytes –

  Create ShareFile from raw bytes.

• from_path –

  Create ShareFile from a filesystem path.

Properties

data: bytes | None = None class-attribute instance-attribute

Raw bytes of the file to share.

mime_type: str | None = None class-attribute instance-attribute

MIME type of the file.

name: str | None = None class-attribute instance-attribute

Optional name of the file.

path: str | None = None class-attribute instance-attribute

Filesystem path to the file to share.

Methods

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

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_path(path: str, *, name: str | None = None) -> ShareFile staticmethod

Create ShareFile from a filesystem path.

Parameters:

• path (str) –

  Filesystem path to the file.

• name (str | None, default: None ) –

  Optional name of the file.

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

Properties

• data(bytes | None) –

  Raw bytes of the file to share.

• mime_type(str | None) –

  MIME type of the file.

• name(str | None) –

  Optional name of the file.

• path(str | None) –

  Filesystem path to the file to share.

Methods

• from_bytes –

  Create ShareFile from raw bytes.

• from_path –

  Create ShareFile from a filesystem path.

Properties

data: bytes | None = None class-attribute instance-attribute

Raw bytes of the file to share.

mime_type: str | None = None class-attribute instance-attribute

MIME type of the file.

name: str | None = None class-attribute instance-attribute

Optional name of the file.

path: str | None = None class-attribute instance-attribute

Filesystem path to the file to share.

Methods

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

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_path(path: str, *, name: str | None = None) -> ShareFile staticmethod

Create ShareFile from a filesystem path.

Parameters:

• path (str) –

  Filesystem path to the file.

• name (str | None, default: None ) –

  Optional name of the file.