gamebench_api_client.api.requests_retriever.builder.url package

Submodules

gamebench_api_client.api.requests_retriever.builder.url.url_builder module

class gamebench_api_client.api.requests_retriever.builder.url.url_builder.AuthURL

Bases: gamebench_api_client.api.requests_retriever.builder.url.url_builder.URLBuilder

Concrete builder that constructs and assembles the auth URL object by implementing UrlBuilder interface.

set_suffix()

Implementation of the abstract set_suffix method.

Sets the proper suffix for authentication.

set_url()

Implementation of the abstract set_url method.

Sets the url property to the URL string created by _build_url

class gamebench_api_client.api.requests_retriever.builder.url.url_builder.SessionURL

Bases: gamebench_api_client.api.requests_retriever.builder.url.url_builder.URLBuilder

Concrete builder that constructs and assembles the session URL object by implementing UrlBuilder interface.

set_suffix(**request_parameters)

Implementation of the abstract set_suffix method.

Creates the suffix variable for the URL object and sets it to the proper suffix for authentication.

Parameters:request_parameters – session_id, metric - strings representing the session_id and metric respectively.

set_url()

Implementation of the abstract set_url method. Sets the completed URL string to the URL object.

class gamebench_api_client.api.requests_retriever.builder.url.url_builder.URL

Bases: object

URL object with basic properties used by the URLBuilder.

__init__()

Initialize self. See help(type(self)) for accurate signature.

class gamebench_api_client.api.requests_retriever.builder.url.url_builder.URLBuilder

Bases: abc.ABC

Abstract interface for creating each part of the URL object.

__init__()

Initialize self. See help(type(self)) for accurate signature.

set_suffix()

Abstract method for setting the suffix properties to the URL.

set_url()

Base class for setting the completed URL to the URL object.

gamebench_api_client.api.requests_retriever.builder.url.url_director module

class gamebench_api_client.api.requests_retriever.builder.url.url_director.URLDirector

Bases: object

Constructs the URL object using the URLBuilder interface.

__init__()

Initialize self. See help(type(self)) for accurate signature.

construct_url(builder, **request_parameters)

Constructs an URL object.

Parameters:

• builder – object which determines which concrete creator to use.
• request_parameters – strings used when creating the session URL (session_id, metric).

static get_auth_url()

Constructs an auth URL object and returns the auth URL string.

Returns:auth.url - The auth URL string.

static get_session_url(**request_parameters)

Constructs a session URL object and returns the session URL string.

Parameters:request_parameters – Dictionary from the user containing information for the request. Returns:session.url - The session URL string.

Module contents