10.7.1. Abstract Base Class for all Adapters¶

class pytan3.adapters.Adapter[source]¶

Bases: object

Abstract base class for all Adapters.

api_objects¶

Get the API objects container.

Returns:	pytan3.api_objects.ApiObjects

api_client¶

Get the API client.

Returns:	pytan3.api_clients.ApiClient

http_client¶

Get the HTTP client.

Returns:	pytan3.http_client.HttpClient

auth_method¶

Get the Auth Method.

Returns:	pytan3.auth_methods.AuthMethod

classmethod get_name()[source]¶

Get the ref name of this class for use by load().

Returns:	str

classmethod get_type()[source]¶

Get the ref type of this class for use by load_type().

Returns:	str

classmethod get_version_req()[source]¶

Get the min, max, and eq version requirements of this class.

Notes

Dict can specify keys: “vmin”, “vmax”, “veq”.

This class method gets called by pytan3.utils.versions.version_check_obj_req() to perform version checks.

Returns:	dict

result_cls¶

Get the result deserializer class.

Returns:	pytan3.results.Result

api_get(obj, **kwargs)[source]¶

Send an API request to get an object.

Parameters:	obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:	pytan3.results.Result

api_add(obj, **kwargs)[source]¶

Send an API request to add an object.

Parameters:	obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:	pytan3.results.Result

api_delete(obj, **kwargs)[source]¶

Send an API request to delete an object.

Parameters:	obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:	pytan3.results.Result

api_update(obj, **kwargs)[source]¶

Send an API request to update an object.

Parameters:	obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:	pytan3.results.Result

api_get_audit_logs(type, target, **kwargs)[source]¶

Send an API request to get audit logs for an object.

Parameters:	type (str) – Type of object to get audit logs of. target (int) – ID of object type to get audit logs for.
Returns:	pytan3.results.Result

api_get_client_count(**kwargs)[source]¶

Send an API request to get the client count.

Returns:	pytan3.results.Result

api_parse_question(text, **kwargs)[source]¶

Send an API request to parse text.

Parameters:	text (str) – Text to parse into question objects.
Returns:	pytan3.results.Result

api_add_parsed_question(obj, **kwargs)[source]¶

Send an API request to add a parsed question object.

Parameters:	obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:	pytan3.results.Result

api_get_result_info(obj, **kwargs)[source]¶

Send an API request to get result info for an object.

Parameters:	obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:	pytan3.results.Result

api_get_result_data(obj, **kwargs)[source]¶

Send an API request to get result data for an object.

Parameters:	obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:	pytan3.results.Result

api_get_merged_result_data(objlist, **kwargs)[source]¶

Send an API request to get merged result data for a list of objects.

Parameters:	objlist (list) – List of API Objects to use for request.
Returns:	pytan3.results.Result

_abc_impl = <_abc_data object>¶