"""
Contains possible interaction dealing with Galaxy configuration.
"""
from typing import TYPE_CHECKING
from bioblend.galaxy.client import Client
if TYPE_CHECKING:
from bioblend.galaxy import GalaxyInstance
[docs]
class ConfigClient(Client):
module = "configuration"
def __init__(self, galaxy_instance: "GalaxyInstance") -> None:
super().__init__(galaxy_instance)
[docs]
def get_config(self) -> dict:
"""
Get a list of attributes about the Galaxy instance. More attributes will
be present if the user is an admin.
:rtype: list
:return: A list of attributes.
For example::
{'allow_library_path_paste': False,
'allow_user_creation': True,
'allow_user_dataset_purge': True,
'allow_user_deletion': False,
'enable_unique_workflow_defaults': False,
'ftp_upload_dir': '/SOMEWHERE/galaxy/ftp_dir',
'ftp_upload_site': 'galaxy.com',
'library_import_dir': 'None',
'logo_url': None,
'support_url': 'https://galaxyproject.org/support',
'terms_url': None,
'user_library_import_dir': None,
'wiki_url': 'https://galaxyproject.org/'}
"""
return self._get()
[docs]
def get_version(self) -> dict:
"""
Get the current version of the Galaxy instance.
:rtype: dict
:return: Version of the Galaxy instance
For example::
{'extra': {}, 'version_major': '17.01'}
"""
url = self.gi.url + "/version"
return self._get(url=url)
[docs]
def whoami(self) -> dict:
"""
Return information about the current authenticated user.
:rtype: dict
:return: Information about current authenticated user
For example::
{'active': True,
'deleted': False,
'email': 'user@example.org',
'id': '4aaaaa85aacc9caa',
'last_password_change': '2021-07-29T05:34:54.632345',
'model_class': 'User',
'username': 'julia'}
"""
url = self.gi.url + "/whoami"
return self._get(url=url)
[docs]
def decode_id(self, encoded_id: str) -> int:
"""
Decode a Galaxy-encoded hexadecimal id to obtain the unencoded integer.
:rtype: int
:return: Integer value equivalent to the provided Galaxy-encoded id
"""
url = f"{self._make_url()}/decode/{encoded_id}"
return self._get(url=url)["decoded_id"]
[docs]
def encode_id(self, decoded_id: int) -> str:
"""
Encode an integer to a Galaxy-encoded hexadecimal id.
:rtype: str
:return: Galaxy-encoded hexadecimal id equivalent to the provided integer
"""
url = f"{self._make_url()}/encode/{decoded_id}"
return self._get(url=url)["encoded_id"]