mkt.databases.klifs.KinaseInfo

class mkt.databases.klifs.KinaseInfo(search_term: str | None = None, search_field: str | None = None, species: str = 'Human')

Bases: KLIFS

Class to get information about a kinase from KLIFS.

__init__(search_term: str | None = None, search_field: str | None = None, species: str = 'Human') → None

Initialize KinaseInfo Class object.

Upon initialization, KLIFS API is queried and kinase information for specificied kinase is retrieved.

Parameters:

• search_term (str) – Search term used to query KLIFS API; if None will return all kinases

• search_field (str | None) – Search field (optional; default: None); only used to post-hoc annotate column with search term in case of missing data

• species (str) – Species of the kinase; default “Human” but can also be “Mouse”

Variables:

• search_term (str) – Search term used to query KLIFS API

• search_field (str | None) – Search field (optional; default: None); only used to post-hoc annotate column with search term in case of missing data

• species (str) – Species of the kinase

• status_code (int | None) – Status code of the query; None if query fails

• _kinase_info (list[dict[str, str | int | None]] | None) – List of KLIFS API object for search term

Methods

__eq__(other)	Return self==value.
__init__([search_term, search_field, species])	Initialize KinaseInfo Class object.
_stamp_from_response(res)	Record query datetime + cache provenance from a requests-cache response.
_stamp_now()	Record current UTC datetime; cache provenance unknown.
call_bravado_function()	Check which bravado.client.CallableOperation to use.
check_response(res)	Check the response status code for errors.
check_species()	Check if species is supported.
get_kinase_info()	Get information about the kinase from KLIFS query.
get_klifs()	Get KLIFS API object.
get_search_field()	Get search field used for query.
get_search_term()	Get search term used for query.
get_species()	Get species used for query.
get_status_code()	Get status code of the query.
get_url()	Get KLIFS API URL.
handle_page_not_found()	Handle page not found error.
query_api()	Get KLIFS API as bravado.client.SwaggerClient object.
query_kinase_info()	Get information about a kinase from KLIFS.

Attributes

__dataclass_fields__
__dataclass_params__
__match_args__
from_cache	Whether the most recent response was served from requests-cache.
query_datetime	UTC datetime the underlying network query was made (cache creation time if served from cache).

__init__(search_term: str | None = None, search_field: str | None = None, species: str = 'Human') → None

Initialize KinaseInfo Class object.

Upon initialization, KLIFS API is queried and kinase information for specificied kinase is retrieved.

Parameters:

• search_term (str) – Search term used to query KLIFS API; if None will return all kinases

• search_field (str | None) – Search field (optional; default: None); only used to post-hoc annotate column with search term in case of missing data

• species (str) – Species of the kinase; default “Human” but can also be “Mouse”

Variables:

• search_term (str) – Search term used to query KLIFS API

• search_field (str | None) – Search field (optional; default: None); only used to post-hoc annotate column with search term in case of missing data

• species (str) – Species of the kinase

• status_code (int | None) – Status code of the query; None if query fails

• _kinase_info (list[dict[str, str | int | None]] | None) – List of KLIFS API object for search term

call_bravado_function() → list[Any]

Check which bravado.client.CallableOperation to use.

check_species() → bool

Check if species is supported.

get_kinase_info()

Get information about the kinase from KLIFS query.

get_search_field()

Get search field used for query.

get_search_term()

Get search term used for query.

get_species()

Get species used for query.

get_status_code()

Get status code of the query.

handle_page_not_found()

Handle page not found error.

query_kinase_info() → list[dict[str, str | int | None]] | None

Get information about a kinase from KLIFS.

Returns:

List of dictionaries with information about the kinase

Return type:

list[dict[str, str | int | None]] | None