Helper Functions

Helper functions are functions usually meant to be used in templates to perform some specific tasks. They are defined in the helpers.py file of the extension.

List of Helper Functions

calculate_priority(value, threshold)

Calculate the priority of a value based on a threshold.

PARAMETER	DESCRIPTION
value	The value to calculate the priority for TYPE: int
threshold	The threshold to compare the value to TYPE: int

RETURNS	DESCRIPTION
str	The priority of the value

Example

from ckanext.ap_main.helpers import calculate_priority

priority = calculate_priority(10, 100)
print(priority) # low

Source code in ckanext/ap_main/helpers.py

@helper
def calculate_priority(value: int, threshold: int) -> str:
    """Calculate the priority of a value based on a threshold.

    Args:
        value: The value to calculate the priority for
        threshold: The threshold to compare the value to

    Returns:
        The priority of the value

    Example:
        ```python
        from ckanext.ap_main.helpers import calculate_priority

        priority = calculate_priority(10, 100)
        print(priority) # low
        ```
    """
    percentage = value / threshold * 100

    if percentage < 25:
        return "low"
    elif percentage < 50:
        return "medium"
    elif percentage < 75:
        return "high"
    else:
        return "urgent"

generate_page_unique_class()

Build a unique css class for each page.

RETURNS	DESCRIPTION
str	A unique css class for the current page

Source code in ckanext/ap_main/helpers.py

@helper
def generate_page_unique_class() -> str:
    """Build a unique css class for each page.

    Returns:
        A unique css class for the current page
    """

    return tk.h.ap_munge_string((f"ap-{tk.request.endpoint}"))

get_config_sections()

Prepare a config section structure for render.

RETURNS	DESCRIPTION
list[SectionConfig]	A list of sections with their config items

Source code in ckanext/ap_main/helpers.py

@helper
def get_config_sections() -> list[SectionConfig]:
    """Prepare a config section structure for render.

    Returns:
        A list of sections with their config items
    """
    config_sections = {}

    for _, section in ap_utils.collect_sections_signal.send():
        config_sections.setdefault(
            section["name"], {"name": section["name"], "configs": []}
        )
        config_sections[section["name"]]["configs"].extend(section["configs"])

    sections = list(config_sections.values())
    sections.sort(key=lambda x: x["name"])

    return sections

get_toolbar_structure()

Prepare a toolbar structure for render.

An extension can register its own toolbar buttons by implementing the register_toolbar_button method in the IAdminPanel interface.

RETURNS	DESCRIPTION
list[ToolbarButton]	A list of toolbar button objects

Source code in ckanext/ap_main/helpers.py

@helper
def get_toolbar_structure() -> list[ToolbarButton]:
    """Prepare a toolbar structure for render.

    An extension can register its own toolbar buttons by implementing the
    `register_toolbar_button` method in the `IAdminPanel` interface.

    Returns:
        A list of toolbar button objects
    """
    configuration_subitems = [
        ToolbarButton(
            label=section["name"],
            subitems=[
                ToolbarButton(
                    label=config_item["name"], url=tk.url_for(config_item["blueprint"])
                )
                for config_item in section["configs"]
            ],
        )
        for section in get_config_sections()
    ]

    default_structure = [
        ToolbarButton(
            label=tk._("Content"),
            icon="fa fa-folder",
            url=tk.url_for("ap_content.list"),
        ),
        ToolbarButton(
            label=tk._("Configuration"),
            icon="fa fa-gear",
            url=tk.url_for("ap_config_list.index"),
            subitems=configuration_subitems,
        ),
        ToolbarButton(
            label=tk._("Users"),
            icon="fa fa-user-friends",
            url=tk.url_for("ap_user.list"),
            subitems=[
                ToolbarButton(
                    label=tk._("Add user"),
                    url=tk.url_for("ap_user.create"),
                    icon="fa fa-user-plus",
                )
            ],
        ),
        ToolbarButton(
            label=tk._("Reports"),
            icon="fa fa-chart-bar",
            subitems=[],
        ),
        ToolbarButton(
            icon="fa fa-gavel",
            url=tk.url_for("admin.index"),
            attributes={"title": tk._("Old admin")},
        ),
        ToolbarButton(
            label=tk.h.user_image((tk.current_user.name), size=20),
            url=tk.url_for("user.read", id=tk.current_user.name),
            attributes={"title": tk._("View profile")},
        ),
        ToolbarButton(
            icon="fa fa-tachometer",
            url=tk.url_for("dashboard.datasets"),
            attributes={"title": tk._("View dashboard")},
        ),
        ToolbarButton(
            icon="fa fa-cog",
            url=tk.url_for("user.edit", id=tk.current_user.name),
            attributes={"title": tk._("Profile settings")},
        ),
        ToolbarButton(
            icon="fa fa-sign-out",
            url=tk.url_for("user.logout"),
            attributes={"title": tk._("Log out")},
        ),
    ]

    for plugin in reversed(list(p.PluginImplementations(IAdminPanel))):
        default_structure = plugin.register_toolbar_button(default_structure)

    return default_structure

munge_string(value)

Munge a string using CKAN's munge_name function.

PARAMETER	DESCRIPTION
value	The string to munge TYPE: str

RETURNS	DESCRIPTION
str	The munged string

Source code in ckanext/ap_main/helpers.py

@helper
def munge_string(value: str) -> str:
    """Munge a string using CKAN's munge_name function.

    Args:
        value: The string to munge

    Returns:
        The munged string
    """
    return munge.munge_name(value)

show_toolbar_theme_switcher()

Check if the toolbar theme switcher should be displayed.

Source code in ckanext/ap_main/helpers.py

@helper
def show_toolbar_theme_switcher() -> bool:
    """Check if the toolbar theme switcher should be displayed."""
    return ap_config.show_toolbar_theme_switcher()

user_add_role_options()

Return a list of options for a user add form.

RETURNS	DESCRIPTION
list[dict[str, str | int]]	A list of options for a user add form

Source code in ckanext/ap_main/helpers.py

@helper
def user_add_role_options() -> list[dict[str, str | int]]:
    """Return a list of options for a user add form.

    Returns:
        A list of options for a user add form
    """
    return [
        {"value": "user", "text": "Regular user"},
        {"value": "sysadmin", "text": "Sysadmin"},
    ]