spb_curate package

Subpackages

• spb_curate.abstract package
  • Subpackages
    • spb_curate.abstract.api package
      • Submodules
      • spb_curate.abstract.api.resource module
      • Module contents
  • Submodules
  • spb_curate.abstract.superb_ai_object module
    • SuperbAIObject
      • SuperbAIObject.ReprJSONEncoder
      • SuperbAIObject.api_base()
      • SuperbAIObject.construct_from_dict()
      • SuperbAIObject.get_cls_by_discriminator()
      • SuperbAIObject.get_endpoint()
      • SuperbAIObject.get_endpoint_method()
      • SuperbAIObject.load_from_dict()
      • SuperbAIObject.request()
      • SuperbAIObject.to_dict()
      • SuperbAIObject.to_dict_deep()
      • SuperbAIObject.update()
  • Module contents
• spb_curate.curate package
  • Subpackages
    • spb_curate.curate.api package
      • Submodules
      • spb_curate.curate.api.abstract module
      • spb_curate.curate.api.curate module
      • spb_curate.curate.api.enums module
      • spb_curate.curate.api.job module
      • spb_curate.curate.api.model_diagnosis module
      • spb_curate.curate.api.settings module
      • Module contents
    • spb_curate.curate.model package
      • Submodules
      • spb_curate.curate.model.annotation_types module
      • Module contents
  • Module contents

Submodules

spb_curate.api_requestor module

class spb_curate.api_requestor.APIRequestor(*, access_key=None, api_base=None, team_name=None)

Bases: object

handle_error_response(rbody, rcode, resp, rheaders)

interpret_response(*, rbody, rcode, rheaders)

Return type:

SuperbAIResponse

request(*, method, url, params=None, headers=None)

request_headers(*, access_key, team_name, method)

Return type:

dict

request_raw(*, method, url, params=None, supplied_headers=None)

Mechanism for issuing an API call

specific_api_error(rbody, rcode, resp, rheaders, error_data=None, error_type=None)

spb_curate.config module

class spb_curate.config.Config(profile=None)

Bases: object

access_key = None

profile = None

team_name = None

spb_curate.error module

exception spb_curate.error.APIConnectionError(message='', http_status=None, code=None, error_body=None, should_retry=False)

Bases: SuperbAIError

exception spb_curate.error.APIError(message='', http_status=None, code=None, error_body=None)

Bases: SuperbAIError

exception spb_curate.error.AuthenticationError(message='', http_status=None, code=None, error_body=None)

Bases: SuperbAIError

HTTP CODE: 401

exception spb_curate.error.BadRequestError(message='', http_status=None, code=None, error_body=None)

Bases: SuperbAIError

HTTP CODE: 400

exception spb_curate.error.ConflictError(message='', http_status=None, code=None, error_body=None)

Bases: SuperbAIError

HTTP CODE: 409

exception spb_curate.error.DependencyError

Bases: Exception

exception spb_curate.error.MaxFieldCountReachedError(message='', http_status=None, code=None, error_body=None)

Bases: SuperbAIError

HTTP CODE: 403

exception spb_curate.error.NotFoundError(message='', http_status=None, code=None, error_body=None)

Bases: SuperbAIError

HTTP CODE: 404

exception spb_curate.error.QuerySyntaxError(message='', http_status=None, code=None, error_body=None)

Bases: BadRequestError

HTTP CODE: 400

exception spb_curate.error.RetryableError(message='', http_status=None, code=None, error_body=None)

Bases: SuperbAIError

exception spb_curate.error.SuperbAIError(message='', http_status=None, code=None, error_body=None)

Bases: Exception

build_error_object()

exception spb_curate.error.SystemError(message='', http_status=None, code=None, error_body=None)

Bases: SuperbAIError

HTTP CODE: 500

exception spb_curate.error.TooManyRequestsError(message='', http_status=None, code=None, error_body=None)

Bases: SuperbAIError

HTTP CODE: 429

exception spb_curate.error.ValidationError

Bases: Exception

spb_curate.http_client module

class spb_curate.http_client.RequestsClient(timeout=80, session=None, **kwargs)

Bases: object

close()

name = 'requests'

request(*, method, url, headers, post_data=None)

spb_curate.http_client.calculate_backoff(attempt, factor=1)

Return type:

int

spb_curate.object_mapping module

spb_curate.superb_ai_response module

class spb_curate.superb_ai_response.SuperbAIResponse(body, code, headers)

Bases: object

property idempotency_key

property request_id

spb_curate.util module

spb_curate.util.convert_to_superb_ai_object(*, data, access_key=None, team_name=None, cls=None)

spb_curate.util.get_object_mapping()

Get the’s the object class mapped against the ‘object type’. Using this function avoids a circular import.

Return type:

Dict[str, SuperbAIObject]

Returns:

The dictionary of the object type mappings.

spb_curate.util.is_running_in_notebook()

Return type:

bool

spb_curate.util.log_debug(message, **params)

spb_curate.util.log_info(message, **params)

spb_curate.util.logfmt(props)

spb_curate.util.validate_argument_list(keys, values, is_required)

Return type:

any

spb_curate.util.validate_argument_value(key, value, is_required)

Return type:

any

spb_curate.util.validate_arguments_require_all(items)

Validates that all of the provided key-value fields are valid.

Parameters:

items (List[Tuple[str, any]]) – Key-value tuples that represent required fields.

spb_curate.util.validate_arguments_require_one(items)

Validates that one of the provided fields are valid. If the list item is a list itself, then it will require all the items within to have valid values.

Parameters:

items (List[Union[Tuple[str, any], List[Tuple[str, any]]]]) – Key-value tuples or list of the tuples that represent required fields.

Raises:

error.ValidationError – Thrown when a required field is missing.

spb_curate.version module

Module contents