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: 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]¶
- get_file_source_path(uri)[source]¶
Parse uri into a FileSource object and a path relative to its base.
- plugins_to_dict(for_serialization: bool = False, user_context: Optional[galaxy.files.FileSourceDictifiable] = None) List[Dict[str, Any]] [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
- class galaxy.files.FileSourceDictifiable[source]¶
Bases:
galaxy.util.dictifiable.Dictifiable
- dict_collection_visible_keys = ('email', 'username', 'ftp_dir', 'preferences', 'is_admin')¶
- class galaxy.files.ProvidesUserFileSourcesUserContext(trans)[source]¶
Bases:
galaxy.files.FileSourceDictifiable
Implement a FileSourcesUserContext from a Galaxy ProvidesUserContext (e.g. trans).
- property email¶
- property username¶
- property ftp_dir¶
- property preferences¶
- property is_admin¶
Whether this user is an administrator.
- property user_vault¶
User vault namespace
- property app_vault¶
App vault namespace