Warning

This document is for an in-development version 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.files package

class galaxy.files.FileSourcePath(file_source, path)

Bases: tuple

property file_source

Alias for field number 0

property path

Alias for field number 1

class galaxy.files.ConfiguredFileSources(file_sources_config, conf_file=None, conf_dict=None, load_stock_plugins=False)[source]

Bases: object

Load plugins and resolve Galaxy URIs to FileSource objects.

__init__(file_sources_config, conf_file=None, conf_dict=None, load_stock_plugins=False)[source]

Initialize self. See help(type(self)) for accurate signature.

get_file_source_path(uri)[source]

Parse uri into a FileSource object and a path relative to its base.

validate_uri_root(uri, user_context)[source]
get_file_source(id_prefix, scheme)[source]
looks_like_uri(path_or_uri)[source]
get_schemes()[source]
plugins_to_dict(for_serialization=False, user_context=None)[source]
to_dict(for_serialization=False, user_context=None)[source]
static from_app_config(config)[source]
static from_dict(as_dict)[source]
class galaxy.files.ConfiguredFileSourcesConfig(symlink_allowlist=None, library_import_dir=None, user_library_import_dir=None, ftp_upload_dir=None, ftp_upload_purge=True)[source]

Bases: object

__init__(symlink_allowlist=None, library_import_dir=None, user_library_import_dir=None, ftp_upload_dir=None, ftp_upload_purge=True)[source]

Initialize self. See help(type(self)) for accurate signature.

static from_app_config(config)[source]
to_dict()[source]
static from_dict(as_dict)[source]
class galaxy.files.ProvidesUserFileSourcesUserContext(trans)[source]

Bases: object

Implement a FileSourcesUserContext from a Galaxy ProvidesUserContext (e.g. trans).

__init__(trans)[source]

Initialize self. See help(type(self)) for accurate signature.

property email
property username
property ftp_dir
property preferences
property role_names

The set of role names of this user.

property group_names

The set of group names to which this user belongs.

property is_admin

Whether this user is an administrator.

class galaxy.files.DictFileSourcesUserContext(**kwd)[source]

Bases: object

__init__(**kwd)[source]

Initialize self. See help(type(self)) for accurate signature.

property email
property username
property ftp_dir
property preferences
property role_names
property group_names
property is_admin