send_only

send_text(text, *, channel_id=None, client=None)

Send a text message to the default client and channel (if not specified).

Source code in src/slack_helpers/send_only.py

def send_text(
    text: str,
    *,
    channel_id: str | None = None,
    client: WebClient | None = None,
):
    """
    Send a text message to the default client and channel (if not specified).
    """
    if client is None:
        client = default_client
    if client is None:
        warn_once()
        return None
    if channel_id is None:
        channel_id = default_channel_id
        assert channel_id is not None

    return client.chat_postMessage(channel=channel_id, text=text)

send_text_as_file(*, filename, content, title, ensure_preview=False, initial_comment=None, channel_id=None, client=None)

Send a text as a file to the default client and channel (if not specified).

Slack is stupid and having special characters in the file makes it think it's a binary file. If ensure_preview is True, then we append """"dear-viewer"""" at the beginning of the file so Slack thinks it's a python file and will preview it.

Note

ensure_preview is a hacky workaround and may not work in the future.

Issues

ensure_preview only works with text-ish files (txt, html, etc.) and not with other files (pdf, png, svg). You can set the filename to be like "file.html" for svg files with the ensure_preview flag.

Parameters:

Name	Type	Description	Default
filename	str		required
content	str		required
title	str		required
ensure_preview	bool	If True, append """"dear-viewer"""" at the beginning of the file to ensure that Slack will preview it.	False
initial_comment	str | None		None
channel_id	str | None		None
client	WebClient | None		None

Source code in src/slack_helpers/send_only.py

def send_text_as_file(
    *,
    filename: str,
    content: str,
    title: str,
    ensure_preview: bool = False,
    initial_comment: str | None = None,
    channel_id: str | None = None,
    client: WebClient | None = None,
):
    """
    Send a text as a file to the default client and channel (if not specified).

    Slack is stupid and having special characters in the file makes it think it's a binary file.
    If ensure_preview is True, then we append `\"\"\"\"dear-viewer\"\"\"\"` at the beginning of the file so Slack thinks
    it's a python file and will preview it.

    Note:
        `ensure_preview` is a hacky workaround and may not work in the future.

    Issues:
        `ensure_preview` only works with text-ish files (txt, html, etc.) and not with other files (pdf, png, svg).
        You can set the `filename` to be like "file.html" for svg files with the `ensure_preview` flag.

    Args:
        filename:
        content:
        title:
        ensure_preview: If True, append `\"\"\"\"dear-viewer\"\"\"\"` at the beginning of the file to ensure that
                        Slack will preview it.
        initial_comment:
        channel_id:
        client:
    """  # noqa: D301
    if client is None:
        client = default_client
    if client is None:
        warn_once()
        return None
    if channel_id is None:
        channel_id = default_channel_id
        assert channel_id is not None

    if ensure_preview:
        content = '""""dear-viewer""""\n' + content

    return client.files_upload_v2(
        filename=filename,
        content=content,
        title=title,
        channel=channel_id,
        initial_comment=initial_comment,
    )

send_divider(*, channel_id=None, client=None)

Send a divider block to the default client and channel (if not specified).

Source code in src/slack_helpers/send_only.py

def send_divider(
    *,
    channel_id: str | None = None,
    client: WebClient | None = None,
):
    """
    Send a divider block to the default client and channel (if not specified).
    """
    if client is None:
        client = default_client
    if client is None:
        warn_once()
        return None
    if channel_id is None:
        channel_id = default_channel_id
        assert channel_id is not None

    return client.chat_postMessage(
        channel=channel_id,
        text="Divider",
        blocks=[
            {"type": "divider"},
        ],
    )

send_file(*, filename, file, title, snippet_type=None, initial_comment=None, channel_id=None, client=None)

Send a file to the default client and channel (if not specified).

Source code in src/slack_helpers/send_only.py

def send_file(
    *,
    filename: str,
    file: str | bytes | IOBase,
    title: str,
    snippet_type: str | None = None,
    initial_comment: str | None = None,
    channel_id: str | None = None,
    client: WebClient | None = None,
):
    """
    Send a file to the default client and channel (if not specified).
    """
    if client is None:
        client = default_client
    if client is None:
        warn_once()
        return None
    if channel_id is None:
        channel_id = default_channel_id
        assert channel_id is not None

    return client.files_upload_v2(
        filename=filename,
        file=file,
        title=title,
        channel=channel_id,
        snippet_type=snippet_type,
        initial_comment=initial_comment,
    )

send_matplotlib_fig(filename, fig, title, initial_comment=None, channel_id=None, client=None)

Send a matplotlib figure as a PDF file to the default client and channel (if not specified).

Source code in src/slack_helpers/send_only.py

def send_matplotlib_fig(
    filename: str,
    fig: Figure,
    title: str,
    initial_comment: str | None = None,
    channel_id: str | None = None,
    client: WebClient | None = None,
):
    """
    Send a matplotlib figure as a PDF file to the default client and channel (if not specified).
    """
    if client is None:
        client = default_client
    if client is None:
        warn_once()
        return None
    if channel_id is None:
        channel_id = default_channel_id
        assert channel_id is not None

    buf = BytesIO()
    fig.savefig(buf, format="pdf")
    buf.seek(0)
    return send_file(
        filename=filename,
        file=buf,
        title=title,
        initial_comment=initial_comment,
        channel_id=channel_id,
        client=client,
    )

send_pil_image(filename, image, title, initial_comment=None, channel_id=None, client=None)

Send a PIL image as a PNG file to the default client and channel (if not specified).

Source code in src/slack_helpers/send_only.py

def send_pil_image(
    filename: str,
    image: Image.Image,
    title: str,
    initial_comment: str | None = None,
    channel_id: str | None = None,
    client: WebClient | None = None,
):
    """
    Send a PIL image as a PNG file to the default client and channel (if not specified).
    """
    if client is None:
        client = default_client
    if client is None:
        warn_once()
        return None
    if channel_id is None:
        channel_id = default_channel_id
        assert channel_id is not None

    buf = BytesIO()
    image.save(buf, format="png")
    buf.seek(0)
    return send_file(
        filename=filename,
        file=buf,
        title=title,
        initial_comment=initial_comment,
        channel_id=channel_id,
        client=client,
    )

send_svg_as_pdf(filename, svg_file, title, initial_comment=None, channel_id=None, client=None)

Send an SVG file as a PDF file.

Slack does not support previewing SVG files, so we convert it to PDF.

Issues

The cairosvg library does not have good support for fonts, and if you export_svg from rich.console then it will have font alignment issues, even if you install the Fira Code font on your system.

Source code in src/slack_helpers/send_only.py

def send_svg_as_pdf(
    filename: str,
    svg_file: str | bytes | IOBase,
    title: str,
    initial_comment: str | None = None,
    channel_id: str | None = None,
    client: WebClient | None = None,
):
    """
    Send an SVG file as a PDF file.

    Slack does not support previewing SVG files, so we convert it to PDF.

    Issues:
        The cairosvg library does not have good support for fonts, and if you `export_svg` from `rich.console`
        then it will have font alignment issues, even if you install the Fira Code font on your system.
    """
    if client is None:
        client = default_client
    if client is None:
        warn_once()
        return None
    if channel_id is None:
        channel_id = default_channel_id
        assert channel_id is not None

    pdf_buf = BytesIO()

    if isinstance(svg_file, str | bytes):
        cairosvg.svg2pdf(bytestring=svg_file, write_to=pdf_buf)
    elif isinstance(svg_file, IOBase):
        cairosvg.svg2pdf(file_obj=svg_file, write_to=pdf_buf)
    else:
        raise TypeError(f"Unsupported type {type(svg_file)}")

    pdf_buf.seek(0)

    return client.files_upload_v2(
        filename=filename,
        file=pdf_buf,
        title=title,
        channel=channel_id,
        initial_comment=initial_comment,
    )