maptekblastlogic package

A client library for accessing BlastLogic Extend API

class maptekblastlogic.AuthenticatedClient(base_url, token, prefix='', auth_header_name='API-KEY', *, raise_on_unexpected_status=False, cookies=NOTHING, headers=NOTHING, timeout=None, verify_ssl=True, follow_redirects=False, httpx_args=NOTHING)[source]

Bases: object

A Client which has been authenticated for use on secured endpoints

The following are accepted as keyword arguments and will be used to construct httpx Clients internally:

base_url: The base URL for the API, all requests are made to a relative path to this URL

cookies: A dictionary of cookies to be sent with every request

headers: A dictionary of headers to be sent with every request

timeout: The maximum amount of a time a request can take. API functions will raise httpx.TimeoutException if this is exceeded.

verify_ssl: Whether or not to verify the SSL certificate of the API server. This should be True in production, but can be set to False for testing purposes.

follow_redirects: Whether or not to follow redirects. Default value is False.

httpx_args: A dictionary of additional arguments to be passed to the httpx.Client and httpx.AsyncClient constructor.

Parameters:

base_url (str)
token (str)
prefix (str)
auth_header_name (str)
raise_on_unexpected_status (bool)
cookies (Dict[str, str])
headers (Dict[str, str])
timeout (Timeout | None)
verify_ssl (str | bool | SSLContext)
follow_redirects (bool)
httpx_args (Dict[str, Any])

raise_on_unexpected_status

Whether or not to raise an errors.UnexpectedStatus if the API returns a status code that was not documented in the source OpenAPI document. Can also be provided as a keyword argument to the constructor.

Type:: bool

token

The token to use for authentication

Type:: str

prefix

The prefix to use for the Authorization header

Type:: str

auth_header_name

The name of the Authorization header

Type:: str

raise_on_unexpected_status: bool

token: str

prefix: str

auth_header_name: str

with_headers(headers)[source]

Get a new client matching this one with additional headers

Parameters:: headers (Dict[str, str])
Return type:: AuthenticatedClient

with_cookies(cookies)[source]

Get a new client matching this one with additional cookies

Parameters:: cookies (Dict[str, str])
Return type:: AuthenticatedClient

with_timeout(timeout)[source]

Get a new client matching this one with a new timeout (in seconds)

Parameters:: timeout (Timeout)
Return type:: AuthenticatedClient

set_httpx_client(client)[source]

Manually the underlying httpx.Client

NOTE: This will override any other settings on the client, including cookies, headers, and timeout.

Parameters:: client (Client)
Return type:: AuthenticatedClient

get_httpx_client()[source]

Get the underlying httpx.Client, constructing a new one if not previously set

Return type:: Client

set_async_httpx_client(async_client)[source]

Manually the underlying httpx.AsyncClient

NOTE: This will override any other settings on the client, including cookies, headers, and timeout.

Parameters:: async_client (AsyncClient)
Return type:: AuthenticatedClient

get_async_httpx_client()[source]

Get the underlying httpx.AsyncClient, constructing a new one if not previously set

Return type:: AsyncClient

class maptekblastlogic.Client(base_url, *, raise_on_unexpected_status=False, cookies=NOTHING, headers=NOTHING, timeout=None, verify_ssl=True, follow_redirects=False, httpx_args=NOTHING)[source]

Bases: object

A class for keeping track of data related to the API

The following are accepted as keyword arguments and will be used to construct httpx Clients internally:

base_url: The base URL for the API, all requests are made to a relative path to this URL

cookies: A dictionary of cookies to be sent with every request

headers: A dictionary of headers to be sent with every request

timeout: The maximum amount of a time a request can take. API functions will raise httpx.TimeoutException if this is exceeded.

verify_ssl: Whether or not to verify the SSL certificate of the API server. This should be True in production, but can be set to False for testing purposes.

follow_redirects: Whether or not to follow redirects. Default value is False.

httpx_args: A dictionary of additional arguments to be passed to the httpx.Client and httpx.AsyncClient constructor.

Parameters:

base_url (str)
raise_on_unexpected_status (bool)
cookies (Dict[str, str])
headers (Dict[str, str])
timeout (Timeout | None)
verify_ssl (str | bool | SSLContext)
follow_redirects (bool)
httpx_args (Dict[str, Any])

raise_on_unexpected_status

Whether or not to raise an errors.UnexpectedStatus if the API returns a status code that was not documented in the source OpenAPI document. Can also be provided as a keyword argument to the constructor.

Type:: bool

raise_on_unexpected_status: bool

with_headers(headers)[source]

Get a new client matching this one with additional headers

Parameters:: headers (Dict[str, str])
Return type:: Client

with_cookies(cookies)[source]

Get a new client matching this one with additional cookies

Parameters:: cookies (Dict[str, str])
Return type:: Client

with_timeout(timeout)[source]

Get a new client matching this one with a new timeout (in seconds)

Parameters:: timeout (Timeout)
Return type:: Client

set_httpx_client(client)[source]

Manually the underlying httpx.Client

NOTE: This will override any other settings on the client, including cookies, headers, and timeout.

Parameters:: client (Client)
Return type:: Client

get_httpx_client()[source]

Get the underlying httpx.Client, constructing a new one if not previously set

Return type:: Client

set_async_httpx_client(async_client)[source]

Manually the underlying httpx.AsyncClient

NOTE: This will override any other settings on the client, including cookies, headers, and timeout.

Parameters:: async_client (AsyncClient)
Return type:: Client

get_async_httpx_client()[source]

Get the underlying httpx.AsyncClient, constructing a new one if not previously set

Return type:: AsyncClient

Subpackages

Submodules

maptekblastlogic.client module

class maptekblastlogic.client.Client(base_url, *, raise_on_unexpected_status=False, cookies=NOTHING, headers=NOTHING, timeout=None, verify_ssl=True, follow_redirects=False, httpx_args=NOTHING)[source]

Bases: object

A class for keeping track of data related to the API

The following are accepted as keyword arguments and will be used to construct httpx Clients internally:

base_url: The base URL for the API, all requests are made to a relative path to this URL

cookies: A dictionary of cookies to be sent with every request

headers: A dictionary of headers to be sent with every request

timeout: The maximum amount of a time a request can take. API functions will raise httpx.TimeoutException if this is exceeded.

verify_ssl: Whether or not to verify the SSL certificate of the API server. This should be True in production, but can be set to False for testing purposes.

follow_redirects: Whether or not to follow redirects. Default value is False.

httpx_args: A dictionary of additional arguments to be passed to the httpx.Client and httpx.AsyncClient constructor.

Parameters:

base_url (str)
raise_on_unexpected_status (bool)
cookies (Dict[str, str])
headers (Dict[str, str])
timeout (Timeout | None)
verify_ssl (str | bool | SSLContext)
follow_redirects (bool)
httpx_args (Dict[str, Any])

raise_on_unexpected_status

Whether or not to raise an errors.UnexpectedStatus if the API returns a status code that was not documented in the source OpenAPI document. Can also be provided as a keyword argument to the constructor.

Type:: bool

raise_on_unexpected_status: bool

with_headers(headers)[source]

Get a new client matching this one with additional headers

Parameters:: headers (Dict[str, str])
Return type:: Client

with_cookies(cookies)[source]

Get a new client matching this one with additional cookies

Parameters:: cookies (Dict[str, str])
Return type:: Client

with_timeout(timeout)[source]

Get a new client matching this one with a new timeout (in seconds)

Parameters:: timeout (Timeout)
Return type:: Client

set_httpx_client(client)[source]

Manually the underlying httpx.Client

NOTE: This will override any other settings on the client, including cookies, headers, and timeout.

Parameters:: client (Client)
Return type:: Client

get_httpx_client()[source]

Get the underlying httpx.Client, constructing a new one if not previously set

Return type:: Client

set_async_httpx_client(async_client)[source]

Manually the underlying httpx.AsyncClient

NOTE: This will override any other settings on the client, including cookies, headers, and timeout.

Parameters:: async_client (AsyncClient)
Return type:: Client

get_async_httpx_client()[source]

Get the underlying httpx.AsyncClient, constructing a new one if not previously set

Return type:: AsyncClient

class maptekblastlogic.client.AuthenticatedClient(base_url, token, prefix='', auth_header_name='API-KEY', *, raise_on_unexpected_status=False, cookies=NOTHING, headers=NOTHING, timeout=None, verify_ssl=True, follow_redirects=False, httpx_args=NOTHING)[source]

Bases: object

A Client which has been authenticated for use on secured endpoints

The following are accepted as keyword arguments and will be used to construct httpx Clients internally:

base_url: The base URL for the API, all requests are made to a relative path to this URL

cookies: A dictionary of cookies to be sent with every request

headers: A dictionary of headers to be sent with every request

timeout: The maximum amount of a time a request can take. API functions will raise httpx.TimeoutException if this is exceeded.

verify_ssl: Whether or not to verify the SSL certificate of the API server. This should be True in production, but can be set to False for testing purposes.

follow_redirects: Whether or not to follow redirects. Default value is False.

httpx_args: A dictionary of additional arguments to be passed to the httpx.Client and httpx.AsyncClient constructor.

Parameters:

base_url (str)
token (str)
prefix (str)
auth_header_name (str)
raise_on_unexpected_status (bool)
cookies (Dict[str, str])
headers (Dict[str, str])
timeout (Timeout | None)
verify_ssl (str | bool | SSLContext)
follow_redirects (bool)
httpx_args (Dict[str, Any])

raise_on_unexpected_status

Whether or not to raise an errors.UnexpectedStatus if the API returns a status code that was not documented in the source OpenAPI document. Can also be provided as a keyword argument to the constructor.

Type:: bool

token

The token to use for authentication

Type:: str

prefix

The prefix to use for the Authorization header

Type:: str

auth_header_name

The name of the Authorization header

Type:: str

raise_on_unexpected_status: bool

token: str

prefix: str

auth_header_name: str

with_headers(headers)[source]

Get a new client matching this one with additional headers

Parameters:: headers (Dict[str, str])
Return type:: AuthenticatedClient

with_cookies(cookies)[source]

Get a new client matching this one with additional cookies

Parameters:: cookies (Dict[str, str])
Return type:: AuthenticatedClient

with_timeout(timeout)[source]

Get a new client matching this one with a new timeout (in seconds)

Parameters:: timeout (Timeout)
Return type:: AuthenticatedClient

set_httpx_client(client)[source]

Manually the underlying httpx.Client

NOTE: This will override any other settings on the client, including cookies, headers, and timeout.

Parameters:: client (Client)
Return type:: AuthenticatedClient

get_httpx_client()[source]

Get the underlying httpx.Client, constructing a new one if not previously set

Return type:: Client

set_async_httpx_client(async_client)[source]

Manually the underlying httpx.AsyncClient

NOTE: This will override any other settings on the client, including cookies, headers, and timeout.

Parameters:: async_client (AsyncClient)
Return type:: AuthenticatedClient

get_async_httpx_client()[source]

Get the underlying httpx.AsyncClient, constructing a new one if not previously set

Return type:: AsyncClient

maptekblastlogic.errors module

Contains shared errors types that can be raised from API functions

exception maptekblastlogic.errors.UnexpectedStatus(status_code, content)[source]

Bases: Exception

Raised by api functions when the response status an undocumented status and Client.raise_on_unexpected_status is True

Parameters:

status_code (int)
content (bytes)

maptekblastlogic.types module

Contains some shared types for properties

class maptekblastlogic.types.File(payload, file_name=None, mime_type=None)[source]

Bases: object

Contains information for file uploads

Parameters:

payload (BinaryIO)
file_name (str | None)
mime_type (str | None)

payload: BinaryIO

file_name: str | None

mime_type: str | None

to_tuple()[source]

Return a tuple representation that httpx will accept for multipart/form-data

Return type:: Tuple[str | None, BinaryIO, str | None]

class maptekblastlogic.types.Response(status_code, content, headers, parsed)[source]

Bases: Generic[T]

A response from an endpoint

Parameters:

status_code (HTTPStatus)
content (bytes)
headers (MutableMapping[str, str])
parsed (T | None)

status_code: HTTPStatus

content: bytes

headers: MutableMapping[str, str]

parsed: T | None

class maptekblastlogic.types.Unset[source]: Bases: object