Module trappedbot.mxutil

Matrix utilities for trappedbot

"""Matrix utilities for trappedbot"""

import enum
import re


class InvalidMxidError(ValueError):
    """An invalid Matrix ID (mxid)"""

    def __init__(self, mxid):
        self.mxid = mxid

    def __str__(self):
        return f"Invalid mxid '{self.mxid}'"


class Mxid(object):
    def __init__(self, user: str, homeserver: str):
        self.user = user
        self.homeserver = homeserver

    @property
    def mxid(self):
        return f"@{self.user}:{self.homeserver}"

    @classmethod
    def fromstr(cls, mxid: str) -> "Mxid":
        m = re.match(r"\@([a-zA-Z0-9-_]+)\:([a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+)$", mxid)
        if not m:
            raise InvalidMxidError(mxid)
        username = m.group(1)
        homeserver = m.group(2)
        if not username or not homeserver:
            raise InvalidMxidError(mxid)
        return Mxid(username, homeserver)


class MessageFormat(enum.Enum):
    """Format for sending messages

    NATURAL:    Default
    FORMATTED:  Pre-formatted as org.matrix.custom.html
    MARKDOWN:   Command output is markdown, so convert to HTML before sending to Matrix
    CODE:       Send command output in fixed-width <pre><code> block
    """

    NATURAL = enum.auto()
    FORMATTED = enum.auto()
    MARKDOWN = enum.auto()
    CODE = enum.auto()

Classes

class InvalidMxidError (mxid)

An invalid Matrix ID (mxid)

Expand source code

class InvalidMxidError(ValueError):
    """An invalid Matrix ID (mxid)"""

    def __init__(self, mxid):
        self.mxid = mxid

    def __str__(self):
        return f"Invalid mxid '{self.mxid}'"

Ancestors

• builtins.ValueError
• builtins.Exception
• builtins.BaseException

class MessageFormat (value, names=None, *, module=None, qualname=None, type=None, start=1)

Format for sending messages

NATURAL: Default FORMATTED: Pre-formatted as org.matrix.custom.html MARKDOWN: Command output is markdown, so convert to HTML before sending to Matrix CODE: Send command output in fixed-width

 block

Expand source code

class MessageFormat(enum.Enum):
    """Format for sending messages

    NATURAL:    Default
    FORMATTED:  Pre-formatted as org.matrix.custom.html
    MARKDOWN:   Command output is markdown, so convert to HTML before sending to Matrix
    CODE:       Send command output in fixed-width <pre><code> block
    """

    NATURAL = enum.auto()
    FORMATTED = enum.auto()
    MARKDOWN = enum.auto()
    CODE = enum.auto()

Ancestors

• enum.Enum

Class variables

var CODE

var FORMATTED

var MARKDOWN

var NATURAL

class Mxid (user: str, homeserver: str)

Expand source code

class Mxid(object):
    def __init__(self, user: str, homeserver: str):
        self.user = user
        self.homeserver = homeserver

    @property
    def mxid(self):
        return f"@{self.user}:{self.homeserver}"

    @classmethod
    def fromstr(cls, mxid: str) -> "Mxid":
        m = re.match(r"\@([a-zA-Z0-9-_]+)\:([a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+)$", mxid)
        if not m:
            raise InvalidMxidError(mxid)
        username = m.group(1)
        homeserver = m.group(2)
        if not username or not homeserver:
            raise InvalidMxidError(mxid)
        return Mxid(username, homeserver)

Static methods

def fromstr(mxid: str) ‑> Mxid

Expand source code

@classmethod
def fromstr(cls, mxid: str) -> "Mxid":
    m = re.match(r"\@([a-zA-Z0-9-_]+)\:([a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+)$", mxid)
    if not m:
        raise InvalidMxidError(mxid)
    username = m.group(1)
    homeserver = m.group(2)
    if not username or not homeserver:
        raise InvalidMxidError(mxid)
    return Mxid(username, homeserver)

Instance variables

var mxid

Expand source code

@property
def mxid(self):
    return f"@{self.user}:{self.homeserver}"