siibra.retrieval.requests

Request files with decoders, lazy loading, and caching.

Module Contents

Classes

EbrainsRequest	Implements lazy loading of HTTP Knowledge graph queries.
GitlabProxy
GitlabProxyEnum	Generic enumeration.
HttpRequest
MultiSourcedRequest
ZipfileRequest

Functions

find_suitiable_decoder(→ Callable)	By supplying a url or a filename, obtain a suitable decoder function
try_all_connectors()

Attributes

DECODERS
USER_AGENT_HEADER

exception siibra.retrieval.requests.MultiSourceRequestException

Common base class for all non-exit exceptions.

exception siibra.retrieval.requests.SiibraHttpRequestError(url: str, status_code: int, msg='Cannot execute http request.')

Common base class for all non-exit exceptions.

__str__()

Return str(self).

class siibra.retrieval.requests.EbrainsRequest(url, decoder=None, params={}, msg_if_not_cached=None, post=False)

Implements lazy loading of HTTP Knowledge graph queries.

property auth_headers

property kg_token

keycloak_endpoint = 'https://iam.ebrains.eu/auth/realms/hbp/protocol/openid-connect/token'

classmethod device_flow(**kwargs)

classmethod fetch_token(**kwargs)

Fetch an EBRAINS token using commandline-supplied username/password using the data proxy endpoint.

Details on how to access EBRAINS are here.

get()

Evaluate KG Token is evaluated only on execution of the request.

classmethod init_oidc()

classmethod set_token(token)

class siibra.retrieval.requests.GitlabProxy(flavour: GitlabProxyEnum, instance_id=None)

folder_dict

get()

class siibra.retrieval.requests.GitlabProxyEnum

Generic enumeration.

Derive from this class to define new enumerations.

property connectors: List[siibra.retrieval.repositories.GitlabConnector]

DATASETVERSION_V3 = 'DATASETVERSION_V3'

DATASET_V1 = 'DATASET_V1'

DATASET_V3 = 'DATASET_V3'

PARCELLATIONREGION_V1 = 'PARCELLATIONREGION_V1'

get(filename, decode_func=None, *, connector: siibra.retrieval.repositories.GitlabConnector = None)

search_files(folder: str, suffix=None, recursive=True, *, connector: siibra.retrieval.repositories.GitlabConnector = None) → List[str]

class siibra.retrieval.requests.HttpRequest(url: str, func: Callable = None, msg_if_not_cached: str = None, refresh=False, post=False, **kwargs)

property cached

property data

get()

class siibra.retrieval.requests.MultiSourcedRequest(requests: List[HttpRequest])

property data

requests: List[HttpRequest] = []

get()

class siibra.retrieval.requests.ZipfileRequest(url, filename, func=None, refresh=False)

get()

siibra.retrieval.requests.find_suitiable_decoder(url: str) → Callable

By supplying a url or a filename, obtain a suitable decoder function for siibra to digest based on predifined DECODERS. An extra layer of gzip decompresser automatically added for gzipped files.

Parameters:

url (str) – The url or filename with extension.

Return type:

Callable or None

siibra.retrieval.requests.try_all_connectors()

siibra.retrieval.requests.DECODERS

siibra.retrieval.requests.USER_AGENT_HEADER