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.files.sources package¶
- class galaxy.files.sources.FilesSource[source]¶
Bases:
object
- abstract get_scheme() str [source]¶
Return a prefix for the root (e.g. the gxfiles in gxfiles://prefix/path).
- abstract user_has_access(user_context) bool [source]¶
Return a boolean indicating if the user can access the FileSource.
- abstract list(source_path='/', recursive=False, user_context=None)[source]¶
Return dictionary of ‘Directory’s and ‘File’s.
- abstract realize_to(source_path, native_path, user_context=None)[source]¶
Realize source path (relative to uri root) to local file system path.
- class galaxy.files.sources.BaseFilesSource[source]¶
Bases:
galaxy.files.sources.FilesSource
- user_has_access(user_context) bool [source]¶
Return a boolean indicating if the user can access the FileSource.
- to_dict(for_serialization=False, user_context=None)[source]¶
Return a dictified representation of this FileSource instance.
If
user_context
is supplied, properties should be written so user context doesn’t need to be present after the plugin is re-hydrated.
- list(path='/', recursive=False, user_context=None)[source]¶
Return dictionary of ‘Directory’s and ‘File’s.
Submodules¶
galaxy.files.sources.anvil module¶
galaxy.files.sources.basespace module¶
galaxy.files.sources.dropbox module¶
galaxy.files.sources.ftp module¶
galaxy.files.sources.galaxy module¶
Static Galaxy file sources - ftp and libraries.
- class galaxy.files.sources.galaxy.UserFtpFilesSource(label='FTP Directory', doc="Galaxy User's FTP Directory", root='${user.ftp_dir}', **kwd)[source]¶
- class galaxy.files.sources.galaxy.LibraryImportFilesSource(label='Library Import Directory', doc="Galaxy's library import directory", root='${config.library_import_dir}', **kwd)[source]¶
- class galaxy.files.sources.galaxy.UserLibraryImportFilesSource(label='Library User Import Directory', doc="Galaxy's user library import directory", root='${config.user_library_import_dir}/${user.email}', **kwd)[source]¶