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.ConfiguredFileSources(file_sources_config: galaxy.files.ConfiguredFileSourcesConfig, 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: galaxy.files.ConfiguredFileSourcesConfig, conf_file=None, conf_dict=None, load_stock_plugins=False)[source]
static from_app_config(config)[source]
static from_dict(as_dict)[source]
get_file_source(id_prefix, scheme)[source]
get_file_source_path(uri)[source]

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

get_schemes()[source]
looks_like_uri(path_or_uri)[source]
plugins_to_dict(for_serialization=False, user_context=None)[source]
to_dict(for_serialization=False, user_context=None)[source]
validate_uri_root(uri, user_context)[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]
static from_app_config(config)[source]
static from_dict(as_dict)[source]
to_dict()[source]
class galaxy.files.DictFileSourcesUserContext(**kwd)[source]

Bases: galaxy.files.FileSourceDictifiable

__init__(**kwd)[source]
app_vault
email
ftp_dir
group_names
is_admin
preferences
role_names
user_vault
username
class galaxy.files.FileSourceDictifiable[source]

Bases: galaxy.util.dictifiable.Dictifiable

dict_collection_visible_keys = ('email', 'username', 'ftp_dir', 'preferences', 'is_admin')
group_names
role_names
to_dict(view='collection', value_mapper=None)[source]
class galaxy.files.FileSourcePath(file_source, path)

Bases: tuple

file_source

Alias for field number 0

path

Alias for field number 1

class galaxy.files.ProvidesUserFileSourcesUserContext(trans)[source]

Bases: galaxy.files.FileSourceDictifiable

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

__init__(trans)[source]
app_vault

App vault namespace

email
ftp_dir
group_names

The set of group names to which this user belongs.

is_admin

Whether this user is an administrator.

preferences
role_names

The set of role names of this user.

user_vault

User vault namespace

username