EVECelery.tasks.ESI.Search.get_characters_character_id_search

A task definition module with associated response models returned by the task.

This module was automatically generated from Jinja templates with the codegen tool included in the root of this repo. You should not directly modify this module but instead modify the template ‘codegen/Templates/ESI_Task.py’.

Module Contents

Classes

get_characters_character_id_search

Search on a string

class EVECelery.tasks.ESI.Search.get_characters_character_id_search.get_characters_character_id_search

Bases: EVECelery.tasks.BaseTasks.TaskESI.TaskESI

Search on a string

request_method() → str

Returns the type of request made to ESI

This method will return the request method (get, post, etc.) made to ESI.

Returns:

Request method passed to requests.request()

Return type:

str

route(character_id: int, **kwargs) → str

ESI route with input request parameters

Parameters:

character_id (int) – An EVE character ID

Returns:

ESI route with request path parameters if any

Return type:

str

cache_ttl_default() → int

TTL for when cache is unspecified.

Returns:

The number of seconds to cache a response

Return type:

int

get_sync(categories: list[str], character_id: int, search: str, datasource: str = 'tranquility', language: str = 'en', strict: bool = False, token: str | None = None, kwargs_apply_async: dict | None = None, kwargs_get: dict | None = None) → EVECelery.tasks.ESI.Search.Models.get_characters_character_id_search_200.Response200_get_characters_character_id_search

Search on a string

Search for entities that match a given sub-string.

— Alternate route: /dev/characters/{character_id}/search/

Alternate route: /legacy/characters/{character_id}/search/

Alternate route: /v3/characters/{character_id}/search/

— This route is cached for up to 3600 seconds

NOTE: This function calls the task and blocks until the result is available. This function is a wrapper around Celery’s task.apply_async() and AsyncResult.get() methods. Instead of a dictionary, this function returns a pydantic model to more easily see what returned data responses look like, what is optionally returned, etc.

If you would instead like to return an async result, use Celery’s apply_async() method on this task.

Parameters:

• categories (list[str]) – Type of entities to search for

• character_id (int) – An EVE character ID

• search (str) – The string to search on

• datasource (str) – The server name you would like data from – [‘tranquility’]

• language (str) – Language to use in the response, takes precedence over Accept-Language – [‘en’, ‘en-us’, ‘de’, ‘fr’, ‘ja’, ‘ru’, ‘zh’, ‘ko’, ‘es’]

• strict (bool) – Whether the search should be a strict match

• token (str | None) – Access token to use if unable to set a header

• kwargs_apply_async (Optional[dict]) –

  Dictionary of keyword arguments passed to task.apply_async()

• kwargs_get (Optional[dict]) –

  Dictionary of keyword arguments passed to AsyncResult.get()

Returns:

The response from ESI as a pydantic object. The response model will follow the structure of Response200_get_characters_character_id_search.

Return type:

Union[EVECelery.tasks.ESI.Search.Models.get_characters_character_id_search_200.Response200_get_characters_character_id_search]

run(categories: list[str], character_id: int, search: str, datasource: str = 'tranquility', language: str = 'en', strict: bool = False, token: str | None = None, **kwargs) → dict

The task body that runs on the EVECelery worker

This is the task body that runs on the EVECelery worker.

IMPORTANT NOTE: You should not directly call this function from your client code as it will run within the context of your client and won’t be sent to the message broker to run on a worker node. To correctly call this task body, see Celery’s documentation on methods for calling tasks.

See also this task’s get_sync() which is a wrapper function around Celery’s apply_async().get() call.

Search on a string

Search for entities that match a given sub-string.

— Alternate route: /dev/characters/{character_id}/search/

Alternate route: /legacy/characters/{character_id}/search/

Alternate route: /v3/characters/{character_id}/search/

— This route is cached for up to 3600 seconds

Parameters:

• categories (list[str]) – Type of entities to search for

• character_id (int) – An EVE character ID

• search (str) – The string to search on

• datasource (str) – The server name you would like data from – [‘tranquility’]

• language (str) – Language to use in the response, takes precedence over Accept-Language – [‘en’, ‘en-us’, ‘de’, ‘fr’, ‘ja’, ‘ru’, ‘zh’, ‘ko’, ‘es’]

• strict (bool) – Whether the search should be a strict match

• token (str | None) – Access token to use if unable to set a header

Returns:

The response from ESI as a JSON dictionary. The response dictionary will follow the structure of Response200_get_characters_character_id_search.

Return type:

dict