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.config package

Universe configuration builder.

galaxy.config.LOGGING_CONFIG_DEFAULT = {'disable_existing_loggers': False, 'filters': {'stack': {'()': 'galaxy.web_stack.application_stack_log_filter'}}, 'formatters': {'stack': {'()': 'galaxy.web_stack.application_stack_log_formatter'}}, 'handlers': {'console': {'class': 'logging.StreamHandler', 'formatter': 'stack', 'level': 'DEBUG', 'stream': 'ext://sys.stderr', 'filters': ['stack']}}, 'loggers': {'paste.httpserver.ThreadPool': {'level': 'WARN', 'qualname': 'paste.httpserver.ThreadPool'}, 'routes.middleware': {'level': 'WARN', 'qualname': 'routes.middleware'}, 'amqp': {'level': 'INFO', 'qualname': 'amqp'}, 'dogpile': {'level': 'WARN', 'qualname': 'dogpile'}}, 'root': {'handlers': ['console'], 'level': 'DEBUG'}, 'version': 1}

Default value for logging configuration, passed to logging.config.dictConfig()

galaxy.config.find_root(kwargs)

class galaxy.config.BaseAppConfiguration(**kwargs)

Bases: object

deprecated_dirs = None

__init__(**kwargs)

resolve_path(path)

Resolve a path relative to Galaxy’s root.

class galaxy.config.CommonConfigurationMixin

Bases: object

Shared configuration settings code for Galaxy and ToolShed.

admin_users

is_admin_user(user)

Determine if the provided user is listed in admin_users.

sentry_dsn_public

Sentry URL with private key removed for use in client side scripts, sentry server will need to be configured to accept events

get_bool(key, default)

get(key, default=None)

class galaxy.config.GalaxyAppConfiguration(**kwargs)

Bases: galaxy.config.BaseAppConfiguration, galaxy.config.CommonConfigurationMixin

deprecated_options = ('database_file', 'track_jobs_in_database')

default_config_file_name = 'galaxy.yml'

deprecated_dirs = {'config_dir': 'config', 'data_dir': 'database'}

__init__(**kwargs)

parse_config_file_options(kwargs)

Backwards compatibility for config files moved to the config/ dir.

reload_sanitize_whitelist(explicit=True)

ensure_tempdir()

check()

galaxy.config.Configuration

alias of galaxy.config.GalaxyAppConfiguration

galaxy.config.reload_config_options(current_config)

Reload modified reloadable config options.

galaxy.config.get_database_engine_options(kwargs, model_prefix='')

Allow options for the SQLAlchemy database engine to be passed by using the prefix “database_engine_option”.

galaxy.config.get_database_url(config)

galaxy.config.init_models_from_config(config, map_install_models=False, object_store=None, trace_logger=None)

galaxy.config.configure_logging(config)

Allow some basic logging configuration to be read from ini file.

This should be able to consume either a galaxy.config.Configuration object or a simple dictionary of configuration variables.

class galaxy.config.ConfiguresGalaxyMixin

Bases: object

Shared code for configuring Galaxy-like app objects.

wait_for_toolbox_reload(old_toolbox)

reindex_tool_search()

tool_dependency_dir

Submodules

galaxy.config.config_manage module

class galaxy.config.config_manage.App(config_paths, default_port, expected_app_factories, destination, schema_path, uwsgi_module)

Bases: tuple

app_name

config_paths

Alias for field number 0

default_port

Alias for field number 1

destination

Alias for field number 3

expected_app_factories

Alias for field number 2

sample_destination

schema

schema_path

Alias for field number 4

uwsgi_module

Alias for field number 5

class galaxy.config.config_manage.OptionValue(name, value, option)

Bases: tuple

name

Alias for field number 0

option

Alias for field number 2

value

Alias for field number 1

galaxy.config.config_manage.main(argv=None)

Entry point for conversion process.

class galaxy.config.config_manage.PrefixFilter(name, prefix)

Bases: object

__init__(name, prefix)

class galaxy.config.config_manage.GzipFilter(name)

Bases: object

__init__(name)

galaxy.config.schema module

class galaxy.config.schema.Schema(mapping)

Bases: object

__init__(mapping)

get_app_option(name)

class galaxy.config.schema.AppSchema(schema_path, app_name)

Bases: galaxy.config.schema.Schema

__init__(schema_path, app_name)

defaults

paths_to_resolve

reloadable_options

validate_path_resolution_graph()

This method is for tests only: we SHOULD validate the schema’s path resolution graph as part of automated testing; but we should NOT validate it at runtime.

galaxy.config.script module

galaxy.config.script.main(argv=None)