Module liquer.web

Web related functions for LiQuer

This module provides functions for generating links to queries and keys.

Expand source code 
"""Web related functions for LiQuer

This module provides functions for generating links to queries and keys.
"""
from liquer.template import expand_simple


def query_link(query, path_only=False):
    """Convert query to a full url.
    If path_only is true, it will be only the path part of the url (i.e. no protocol, server or port).
    """
    if path_only:
        return f"/liquer/q/{query}"
    else:
        return f"http://127.0.0.1:5000/liquer/q/{query}"


def key_link(key, path_only=False, as_query=False):
    """Convert store key to a full url to the content.
    If path_only is true, it will be only the path part of the url (i.e. no protocol, server or port).
    """
    if as_query:
        if path_only:
            return f"/liquer/q/{key_query(key)}"
        else:
            return f"http://127.0.0.1:5000/liquer/q/{key_query(key)}"
    else:
        if path_only:
            return f"/liquer/api/store/data/{key}"
        else:
            return f"http://127.0.0.1:5000/liquer/api/store/data/{key}"


def key_query(key):
    """Converts a store key to a query by adding a dr command."""
    return f"-R/{key}/-/dr"


def unnamed_query(query):
    """Return query without a file name"""
    import liquer.parser as p

    return p.parse(query).without_filename().encode()


def key_query_parameters(key=None, query=None):
    """Defines a set of variables for a specified key and/or query:

    - KEY: The key itself,
    - QUERY: query itself or a key converted to a query using key_query
    - URL: full url link to a query result (using liquer/q api)
    - URL_PATH: path part of the url to a query result
    - UNNAMED_QUERY: query without the filename
    - UNNAMED_FULL_URL: like QUERY_LINK but without the filename 
    - UNNAMED_URL: like QUERY_PATH but without the filename

    In most cases for tool registration the UNNAMED_URL is used followed by desired filename,
    e.g. $$UNNAMED_URL$/describe/description.html.

    """
    if key is None:
        if query is None:
            raise Exception("Neither key nor query specified")
        else:
            return dict(
                QUERY=query,
                FULL_URL=query_link(query),
                URL=query_link(query, path_only=True),
                UNNAMED_QUERY=unnamed_query(query),
                UNNAMED_FULL_URL=query_link(unnamed_query(query)),
                UNNAMED_URL=query_link(unnamed_query(query), path_only=True),
            )
    else:
        return dict(
            KEY=key,
            QUERY=query or key_query(key),
            FULL_URL=key_link(key),
            URL=key_link(key, path_only=True),
            UNNAMED_QUERY=unnamed_query(query or key_query(key)),
            UNNAMED_FULL_URL=key_link(key, as_query=True),
            UNNAMED_URL=key_link(key, path_only=True, as_query=True),
        )

Functions

Convert store key to a full url to the content. If path_only is true, it will be only the path part of the url (i.e. no protocol, server or port).

Expand source code 
def key_link(key, path_only=False, as_query=False):
    """Convert store key to a full url to the content.
    If path_only is true, it will be only the path part of the url (i.e. no protocol, server or port).
    """
    if as_query:
        if path_only:
            return f"/liquer/q/{key_query(key)}"
        else:
            return f"http://127.0.0.1:5000/liquer/q/{key_query(key)}"
    else:
        if path_only:
            return f"/liquer/api/store/data/{key}"
        else:
            return f"http://127.0.0.1:5000/liquer/api/store/data/{key}"
def key_query(key)

Converts a store key to a query by adding a dr command.

Expand source code 
def key_query(key):
    """Converts a store key to a query by adding a dr command."""
    return f"-R/{key}/-/dr"
def key_query_parameters(key=None, query=None)

Defines a set of variables for a specified key and/or query:

  • KEY: The key itself,
  • QUERY: query itself or a key converted to a query using key_query
  • URL: full url link to a query result (using liquer/q api)
  • URL_PATH: path part of the url to a query result
  • UNNAMED_QUERY: query without the filename
  • UNNAMED_FULL_URL: like QUERY_LINK but without the filename
  • UNNAMED_URL: like QUERY_PATH but without the filename

In most cases for tool registration the UNNAMED_URL is used followed by desired filename, e.g. $$UNNAMED_URL$/describe/description.html.

Expand source code 
def key_query_parameters(key=None, query=None):
    """Defines a set of variables for a specified key and/or query:

    - KEY: The key itself,
    - QUERY: query itself or a key converted to a query using key_query
    - URL: full url link to a query result (using liquer/q api)
    - URL_PATH: path part of the url to a query result
    - UNNAMED_QUERY: query without the filename
    - UNNAMED_FULL_URL: like QUERY_LINK but without the filename 
    - UNNAMED_URL: like QUERY_PATH but without the filename

    In most cases for tool registration the UNNAMED_URL is used followed by desired filename,
    e.g. $$UNNAMED_URL$/describe/description.html.

    """
    if key is None:
        if query is None:
            raise Exception("Neither key nor query specified")
        else:
            return dict(
                QUERY=query,
                FULL_URL=query_link(query),
                URL=query_link(query, path_only=True),
                UNNAMED_QUERY=unnamed_query(query),
                UNNAMED_FULL_URL=query_link(unnamed_query(query)),
                UNNAMED_URL=query_link(unnamed_query(query), path_only=True),
            )
    else:
        return dict(
            KEY=key,
            QUERY=query or key_query(key),
            FULL_URL=key_link(key),
            URL=key_link(key, path_only=True),
            UNNAMED_QUERY=unnamed_query(query or key_query(key)),
            UNNAMED_FULL_URL=key_link(key, as_query=True),
            UNNAMED_URL=key_link(key, path_only=True, as_query=True),
        )

Convert query to a full url. If path_only is true, it will be only the path part of the url (i.e. no protocol, server or port).

Expand source code 
def query_link(query, path_only=False):
    """Convert query to a full url.
    If path_only is true, it will be only the path part of the url (i.e. no protocol, server or port).
    """
    if path_only:
        return f"/liquer/q/{query}"
    else:
        return f"http://127.0.0.1:5000/liquer/q/{query}"
def unnamed_query(query)

Return query without a file name

Expand source code 
def unnamed_query(query):
    """Return query without a file name"""
    import liquer.parser as p

    return p.parse(query).without_filename().encode()