Warning

This document is for an old release of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

galaxy.web.framework.helpers package

Galaxy web framework helpers

The functions in this module should be considered part of the API used by visualizations in their mako files through the $h object, see GalaxyWebTransaction in galaxy/webapps/base/webapp.py

galaxy.web.framework.helpers.time_ago(x)

Convert a datetime to a string.

galaxy.web.framework.helpers.iff(a, b, c)

Ternary shortcut

galaxy.web.framework.helpers.truncate(content, length=100, suffix='...')

Smart string truncation

galaxy.web.framework.helpers.css(*args)

Take a list of stylesheet names (no extension) and return appropriate string of link tags.

Cache-bust with time that server started running on

galaxy.web.framework.helpers.dist_css(*args)

Transition function ‘css’ helper – this is the modern way where all bundled artifacts are in the unified ‘dist’.

galaxy.web.framework.helpers.js_helper(prefix, *args)

Take a prefix and list of javascript names and return appropriate string of script tags.

Cache-bust with time that server started running on

galaxy.web.framework.helpers.dist_js(*args)

Take a prefix and list of javascript names and return appropriate string of script tags.

galaxy.web.framework.helpers.to_unicode(a_string)

Convert a string to unicode in utf-8 format; if string is already unicode, does nothing because string’s encoding cannot be determined by introspection.

galaxy.web.framework.helpers.is_true(val)

Returns true if input is a boolean and true or is a string and looks like a true value.

galaxy.web.framework.helpers.to_js_bool(val)

Prints javascript boolean for passed value. TODO: isn’t there a standard python JSON parser we should be using instead of all these manual conversions?

galaxy.web.framework.helpers.js_nullable(val)

Prints javascript null instead of python None TODO: isn’t there a standard python JSON parser we should be using instead of all these manual conversions?

Submodules

galaxy.web.framework.helpers.grids module

class galaxy.web.framework.helpers.grids.GridColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Bases: object

__init__(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Create a grid column.

get_value(trans, grid, item)

get_link(trans, grid, item)

filter(trans, user, query, column_filter)

Modify query to reflect the column filter.

get_accepted_filters()

Returns a list of accepted filters for this column.

sort(trans, query, ascending, column_name=None)

Sort query using this column.

class galaxy.web.framework.helpers.grids.ReverseSortColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Bases: GridColumn

Column that reverses sorting; this is useful when the natural sort is descending.

sort(trans, query, ascending, column_name=None)

Sort query using this column.

class galaxy.web.framework.helpers.grids.TextColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Bases: GridColumn

Generic column that employs freetext and, hence, supports freetext, case-independent filtering.

filter(trans, user, query, column_filter)

Modify query to filter using free text, case independence.

get_filter(trans, user, column_filter)

Returns a SQLAlchemy criterion derived from column_filter.

get_single_filter(user, a_filter)

Returns a SQLAlchemy criterion derived for a single filter. Single filter is the most basic filter–usually a string–and cannot be a list.

sort(trans, query, ascending, column_name=None)

Sort column using case-insensitive alphabetical sorting.

class galaxy.web.framework.helpers.grids.DateTimeColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Bases: TextColumn

sort(trans, query, ascending, column_name=None)

Sort query using this column.

class galaxy.web.framework.helpers.grids.BooleanColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Bases: TextColumn

sort(trans, query, ascending, column_name=None)

Sort query using this column.

get_single_filter(user, a_filter)

Returns a SQLAlchemy criterion derived for a single filter. Single filter is the most basic filter–usually a string–and cannot be a list.

class galaxy.web.framework.helpers.grids.IntegerColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Bases: TextColumn

Integer column that employs freetext, but checks that the text is an integer, so support filtering on integer values.

IMPORTANT NOTE: grids that use this column type should not include the column in the cols_to_filter list of MulticolFilterColumn ( i.e., searching on this column type should not be performed in the grid’s standard search - it won’t throw exceptions, but it also will not find what you’re looking for ). Grids that search on this column should use ‘filterable=”advanced”’ so that searching is only performed in the advanced search component, restricting the search to the specific column.

This is useful for searching on object ids or other integer columns. See the JobIdColumn column in the SpecifiedDateListGrid class in the jobs controller of the reports webapp for an example.

get_single_filter(user, a_filter)

Returns a SQLAlchemy criterion derived for a single filter. Single filter is the most basic filter–usually a string–and cannot be a list.

sort(trans, query, ascending, column_name=None)

Sort query using this column.

class galaxy.web.framework.helpers.grids.CommunityRatingColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Bases: GridColumn, UsesItemRatings

Column that displays community ratings for an item.

get_value(trans, grid, item)

sort(trans, query, ascending, column_name=None)

Sort query using this column.

class galaxy.web.framework.helpers.grids.OwnerAnnotationColumn(col_name, key, model_class=None, model_annotation_association_class=None, filterable=None)

Bases: TextColumn, UsesAnnotations

Column that displays and filters item owner’s annotations.

__init__(col_name, key, model_class=None, model_annotation_association_class=None, filterable=None)

Create a grid column.

get_value(trans, grid, item)

Returns first 150 characters of annotation.

get_single_filter(user, a_filter)

Filter by annotation and annotation owner.

class galaxy.web.framework.helpers.grids.CommunityTagsColumn(col_name, key, model_class=None, model_tag_association_class=None, filterable=None, grid_name=None)

Bases: TextColumn

Column that supports community tags.

__init__(col_name, key, model_class=None, model_tag_association_class=None, filterable=None, grid_name=None)

Create a grid column.

get_value(trans, grid, item)

filter(trans, user, query, column_filter)

Modify query to filter model_class by tag. Multiple filters are ANDed.

get_filter(trans, user, column_filter)

Returns a SQLAlchemy criterion derived from column_filter.

class galaxy.web.framework.helpers.grids.IndividualTagsColumn(col_name, key, model_class=None, model_tag_association_class=None, filterable=None, grid_name=None)

Bases: CommunityTagsColumn

Column that supports individual tags.

get_value(trans, grid, item)

get_filter(trans, user, column_filter)

Returns a SQLAlchemy criterion derived from column_filter.

class galaxy.web.framework.helpers.grids.MulticolFilterColumn(col_name, cols_to_filter, key, visible, filterable='default')

Bases: TextColumn

Column that performs multicolumn filtering.

__init__(col_name, cols_to_filter, key, visible, filterable='default')

Create a grid column.

filter(trans, user, query, column_filter)

Modify query to filter model_class by tag. Multiple filters are ANDed.

class galaxy.web.framework.helpers.grids.OwnerColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Bases: TextColumn

Column that lists item’s owner.

get_value(trans, grid, item)

sort(trans, query, ascending, column_name=None)

Sort column using case-insensitive alphabetical sorting on item’s username.

class galaxy.web.framework.helpers.grids.PublicURLColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Bases: TextColumn

Column displays item’s public URL based on username and slug.

get_link(trans, grid, item)

class galaxy.web.framework.helpers.grids.DeletedColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Bases: GridColumn

Column that tracks and filters for items with deleted attribute.

get_accepted_filters()

Returns a list of accepted filters for this column.

filter(trans, user, query, column_filter)

Modify query to filter self.model_class by state.

class galaxy.web.framework.helpers.grids.PurgedColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Bases: GridColumn

Column that tracks and filters for items with purged attribute.

get_accepted_filters()

Returns a list of accepted filters for this column.

filter(trans, user, query, column_filter)

Modify query to filter self.model_class by state.

class galaxy.web.framework.helpers.grids.StateColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None, delayed=False)

Bases: GridColumn

Column that tracks and filters for items with state attribute.

IMPORTANT NOTE: self.model_class must have a states Bunch or dict if this column type is used in the grid.

get_value(trans, grid, item)

filter(trans, user, query, column_filter)

Modify query to filter self.model_class by state.

get_accepted_filters()

Returns a list of accepted filters for this column.

class galaxy.web.framework.helpers.grids.SharingStatusColumn(*args, **kwargs)

Bases: GridColumn

Grid column to indicate sharing status.

__init__(*args, **kwargs)

Create a grid column.

get_value(trans, grid, item)

filter(trans, user, query, column_filter)

Modify query to filter histories by sharing status.

get_accepted_filters()

Returns a list of accepted filters for this column.

class galaxy.web.framework.helpers.grids.GridOperation(label, key=None, condition=None, allow_multiple=True, allow_popup=True, target=None, url_args=None, async_compatible=False, confirm=None, global_operation=None)

Bases: object

__init__(label, key=None, condition=None, allow_multiple=True, allow_popup=True, target=None, url_args=None, async_compatible=False, confirm=None, global_operation=None)

get_url_args(item)

allowed(item)

class galaxy.web.framework.helpers.grids.DisplayByUsernameAndSlugGridOperation(label, key=None, condition=None, allow_multiple=True, allow_popup=True, target=None, url_args=None, async_compatible=False, confirm=None, global_operation=None)

Bases: GridOperation

Operation to display an item by username and slug.

get_url_args(item)

class galaxy.web.framework.helpers.grids.GridAction(label=None, url_args=None, target=None)

Bases: object

__init__(label=None, url_args=None, target=None)

class galaxy.web.framework.helpers.grids.GridColumnFilter(label, args=None)

Bases: object

__init__(label, args=None)

get_url_args()

class galaxy.web.framework.helpers.grids.Grid

Bases: object

Specifies the content and format of a grid (data table).

title = ''

model_class: Optional[type] = None

show_item_checkboxes = False

use_hide_message = True

global_actions: List[GridAction] = []

columns: List[GridColumn] = []

operations: List[GridOperation] = []

standard_filters: List[GridColumnFilter] = []

default_filter: Dict[str, str] = {}

default_sort_key: Optional[str] = None

use_paging = False

num_rows_per_page = 25

num_page_links = 10

cur_filter_pref_name = '.filter'

cur_sort_key_pref_name = '.sort_key'

legend = None

info_text: Optional[str] = None

__init__()

get_ids(**kwargs)

handle_operation(trans, operation, ids, **kwargs)

get_current_item(trans, **kwargs)

build_initial_query(trans, **kwargs)

apply_query_filter(trans, query, **kwargs)

galaxy.web.framework.helpers.tags module

Code derived from WebHelpers: https://bitbucket.org/bbangert/webhelpers

Licensed under the MIT license: https://bitbucket.org/bbangert/webhelpers/src/tip/LICENSE

galaxy.web.framework.helpers.tags.format_attrs(**attrs)

Format HTML attributes into a string of ‘ key=”value”’ pairs which can be inserted into an HTML tag.

The attributes are sorted alphabetically. If any value is None, the entire attribute is suppressed.

Usage: >>> format_attrs(p=2, q=3) == u’ p=”2” q=”3”’ True >>> format_attrs(p=2, q=None) == u’ p=”2”’ True >>> format_attrs(p=None) == u’’ True

galaxy.web.framework.helpers.tags.javascript_link(*urls, **attrs)

Return script include tags for the specified javascript URLs.

urls should be the exact URLs desired. A previous version of this helper added magic prefixes; this is no longer the case.

Specify the keyword argument defer=True to enable the script defer attribute.

Examples:

>>> print(javascript_link('/javascripts/prototype.js', '/other-javascripts/util.js'))
<script src="/javascripts/prototype.js" type="text/javascript"></script>
<script src="/other-javascripts/util.js" type="text/javascript"></script>

>>> print(javascript_link('/app.js', '/test/test.1.js'))
<script src="/app.js" type="text/javascript"></script>
<script src="/test/test.1.js" type="text/javascript"></script>

galaxy.web.framework.helpers.tags.stylesheet_link(*urls, **attrs)

Return CSS link tags for the specified stylesheet URLs.

urls should be the exact URLs desired. A previous version of this helper added magic prefixes; this is no longer the case.

Examples:

>>> print(stylesheet_link('/stylesheets/style.css'))
<link href="/stylesheets/style.css" media="screen" rel="stylesheet" type="text/css" />

>>> print(stylesheet_link('/stylesheets/dir/file.css', media='all'))
<link href="/stylesheets/dir/file.css" media="all" rel="stylesheet" type="text/css" />