Utilities

wagtail_live.utils.get_setting_or_raise(setting, setting_str)

Retrieves and returns the value of a setting if present in user's settings, else raises an ImproperlyConfigured error.

Parameters:

Name	Type	Description	Default
setting	str	The name of the setting to find in user's settings.	required
setting_str	str	A verbose name for the setting when reporting errors.	required

Returns:

Type	Description
str	The value of the setting if defined in user's settings.

Exceptions:

Type	Description
ImproperlyConfigured	If the setting isn't defined.

Source code in wagtail_live/utils.py

def get_setting_or_raise(setting, setting_str):
    """
    Retrieves and returns the value of a setting if present in user's settings,
    else raises an `ImproperlyConfigured` error.

    Args:
        setting (str):
            The name of the setting to find in user's settings.
        setting_str (str):
            A verbose name for the setting when reporting errors.

    Returns:
        str: The value of the setting if defined in user's settings.

    Raises:
        ImproperlyConfigured: If the setting isn't defined.
    """

    value = getattr(settings, setting, "")
    if not value:
        err_msg = f"You haven't specified a {setting_str} in your settings."
        raise ImproperlyConfigured(err_msg)
    return value

wagtail_live.utils.get_live_page_model()

Retrieves the live page model specified in user's settings.

Returns:

Type	Description
LivePageMixin	The live page model specified.

Exceptions:

Type	Description
ImproperlyConfigured	if no live page model is specified or the one specified doesn't inherit from wagtail_live.models.LivePageMixin.
ImportError	if the live page model class couldn't be loaded.

Source code in wagtail_live/utils.py

def get_live_page_model():
    """
    Retrieves the live page model specified in user's settings.

    Returns:
        LivePageMixin:
            The live page model specified.

    Raises:
        ImproperlyConfigured: if no live page model is specified or
            the one specified doesn't inherit from `wagtail_live.models.LivePageMixin`.
        ImportError: if the live page model class couldn't be loaded.
    """

    from wagtail_live.models import LivePageMixin

    live_model_class = get_setting_or_raise(
        setting="WAGTAIL_LIVE_PAGE_MODEL", setting_str="live page model"
    )

    model = import_string(live_model_class)

    if not issubclass(model, LivePageMixin):
        raise ImproperlyConfigured(
            f"The live page model {live_model_class} doesn't inherit from "
            "wagtail_live.models.LivePageMixin."
        )

    return model

wagtail_live.utils.get_live_receiver()

Retrieves the live receiver specified in user's settings.

Returns:

Type	Description
BaseMessageReceiver	The live receiver specified if found else None.

Exceptions:

Type	Description
ImproperlyConfigured	if the receiver specified doesn't inherit from wagtail_live.receivers.BaseMessageReceiver.
ImportError	if the receiver class couldn't be loaded.

Source code in wagtail_live/utils.py

def get_live_receiver():
    """
    Retrieves the live receiver specified in user's settings.

    Returns:
        BaseMessageReceiver: The live receiver specified if found else `None`.

    Raises:
        ImproperlyConfigured: if the receiver specified doesn't inherit from
            `wagtail_live.receivers.BaseMessageReceiver`.
        ImportError: if the receiver class couldn't be loaded.
    """

    from wagtail_live.receivers.base import BaseMessageReceiver

    live_receiver_class = getattr(settings, "WAGTAIL_LIVE_RECEIVER", "")
    if not live_receiver_class:
        # Assume live interface is used, in which case no additional setup is needed.
        return

    receiver = import_string(live_receiver_class)

    if not issubclass(receiver, BaseMessageReceiver):
        raise ImproperlyConfigured(
            f"The receiver {live_receiver_class} doesn't inherit from "
            "wagtail_live.receivers.BaseMessageReceiver."
        )
    return receiver

wagtail_live.utils.get_live_publisher()

Retrieves the live publisher specified in user's settings.

Returns:

Type	Description
Publisher	The live publisher specified.

Exceptions:

Type	Description
ImproperlyConfigured	if no publisher class is specified in settings.
ImportError	if the publisher class couldn't be loaded.

Source code in wagtail_live/utils.py

def get_live_publisher():
    """
    Retrieves the live publisher specified in user's settings.

    Returns:
        Publisher: The live publisher specified.

    Raises:
        ImproperlyConfigured: if no publisher class is specified in settings.
        ImportError: if the publisher class couldn't be loaded.
    """

    live_publisher_class = get_setting_or_raise(
        setting="WAGTAIL_LIVE_PUBLISHER", setting_str="live publisher"
    )
    return import_string(live_publisher_class)

wagtail_live.utils.get_polling_timeout()

Retrieves the duration of the polling timeout for the long polling technique.

The user can set this parameter in his settings by doing so:

WAGTAIL_LIVE_POLLING_TIMEOUT = (duration in seconds)

The default value is 60 seconds.

Returns:

Type	Description
int	The duration of the polling timeout if defined else 60.

Source code in wagtail_live/utils.py

def get_polling_timeout():
    """
    Retrieves the duration of the polling timeout for the long polling technique.

    The user can set this parameter in his settings by doing so:
    ```python
    WAGTAIL_LIVE_POLLING_TIMEOUT = (duration in seconds)
    ```

    The default value is 60 seconds.

    Returns:
        int: The duration of the polling timeout if defined else 60.
    """

    return getattr(settings, "WAGTAIL_LIVE_POLLING_TIMEOUT", 60)

wagtail_live.utils.get_polling_interval()

Retrieves the duration of the polling interval for the interval polling technique.

The user can set this parameter in his settings by doing so:

WAGTAIL_LIVE_POLLING_INTERVAL = (duration in ms)

The default value is 3000 milliseconds.

Returns:

Type	Description
int	the duration of the polling interval if defined else 3000.

Source code in wagtail_live/utils.py

def get_polling_interval():
    """
    Retrieves the duration of the polling interval for the interval polling technique.

    The user can set this parameter in his settings by doing so:
    ```python
    WAGTAIL_LIVE_POLLING_INTERVAL = (duration in ms)
    ```
    The default value is 3000 milliseconds.

    Returns:
        int: the duration of the polling interval if defined else 3000.
    """

    return getattr(settings, "WAGTAIL_LIVE_POLLING_INTERVAL", 3000)

wagtail_live.utils.is_embed(text)

Checks if a text is a link to embed.

Parameters:

Name	Type	Description	Default
text	str	Text to check	required

Returns:

Type	Description
bool	True if text corresponds to an embed link. False else.

Source code in wagtail_live/utils.py

@lru_cache(maxsize=None)
def is_embed(text):
    """
    Checks if a text is a link to embed.

    Args:
        text (str): Text to check

    Returns:
        bool:
        - `True` if text corresponds to an embed link.
        - `False` else.
    """

    for provider in all_providers:
        for url_pattern in provider.get("urls", []):
            if bool(re.match(url_pattern, text)):
                return True

    return False