API Reference#

Client#

class mystbin.Client(*, token: str | None = None, session: ClientSession | None = None)[source]#
await close() → None[source]#

This function is a coroutine.

Closes the internal HTTP session and this client.

await create_paste(*, filename: str, content: str, file: None = None, files: None = None, password: str | None = None, expires: datetime.datetime | None = None) → Paste[source]#
await create_paste(*, filename: None = None, content: None = None, file: File, files: None = None, password: str | None = None, expires: datetime.datetime | None = None) → Paste
await create_paste(*, filename: None = None, content: None = None, file: None = None, files: Sequence[File], password: str | None = None, expires: datetime.datetime | None = None) → Paste

This function is a coroutine.

Create a single file paste on mystb.in.

Parameters

  • filename (Optional[str]) – The filename to create.

  • content (Optional[str]) – The content of the file you are creating.

  • file (Optional[File]) – The pre-created file you wish to upload.

  • files (Optional[List[File]]) – The pre-creates list of files you wish to upload.

  • password (Optional[str]) – The password of the paste, if any.

  • expires (Optional[datetime.datetime]) – When the paste expires, if any.

Raises

ValueError – A bad combinarion of singular and plural pastes were passed.

Returns

The paste that was created.

Return type

mystbin.Paste

..note::

Passing combinations of both singular and plural files is not supports and will raise an exception. Internally the order of precesence is files > file > filename and content.

await delete_paste(paste_id: str, /) → None[source]#

This function is a coroutine.

Delete a paste.

Parameters

paste_id (str) – The paste to delete.

await delete_pastes(paste_ids: list[str], /) → None[source]#

This function is a coroutine.

Delete multiple pastes.

Parameters

paste_ids (List[str]) – The pastes to delete.

await get_paste(paste_id: str, *, password: str | None = None, raw: Literal[False]) → Paste[source]#
await get_paste(paste_id: str, *, password: str | None = None, raw: Literal[True]) → list[str]

This function is a coroutine.

Fetch a paste.

Parameters

  • paste_id (str) – The paste id to fetch.

  • password (Optional[str]) – The password of the paste, if any.

  • raw (bool) – Whether to return the raw file(s) content or a Paste instance. Defaults to False.

Returns

The paste data returned.

Return type

Union[Paste, List[str]]

await get_user_pastes(*, limit: int = 100) → list[mystbin.paste.Paste][source]#

This function is a coroutine.

Get all pastes belonging to the current authenticated user.

Parameters

limit (int) – The amount of pastes to fetch. Defaults to 100.

Returns

The pastes that were fetched.

Return type

List[Paste]

Paste#

class mystbin.Paste(*, id: str, created_at: str, files: list[mystbin.paste.File], notice: str | None)[source]#

File#

class mystbin.File(*, filename: str, content: str, attachment_url: str | None = None)[source]#