Skip to main content

Lattice SDK Python Library

pypi

The Lattice SDK Python library provides convenient access to the Lattice SDK APIs from Python.

Table of Contents

Documentation

API reference documentation is available here.

Requirements

To use the SDK please ensure you have the following installed:

Installation

pip install anduril-lattice-sdk

Support

For support with this library please reach out to your Anduril representative.

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

from anduril import Lattice

client = Lattice(
    client_id="<clientId>",
    client_secret="<clientSecret>",
)

client.entities.long_poll_entity_events(
    session_token="sessionToken",
)

Environments

This SDK allows you to configure different environments for API requests.

from anduril import Lattice
from anduril.environment import LatticeEnvironment

client = Lattice(
    environment=LatticeEnvironment.DEFAULT,
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).

import asyncio

from anduril import AsyncLattice

client = AsyncLattice(
    client_id="<clientId>",
    client_secret="<clientSecret>",
)


async def main() -> None:
    await client.entities.long_poll_entity_events(
        session_token="sessionToken",
    )


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from anduril.core.api_error import ApiError

try:
    client.entities.long_poll_entity_events(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Streaming

The SDK supports streaming responses, as well, the response will be a generator that you can loop over.

from anduril import Lattice

client = Lattice(
    client_id="<clientId>",
    client_secret="<clientSecret>",
)

client.entities.stream_entities()

Pagination

Paginated requests will return a SyncPager or AsyncPager, which can be used as generators for the underlying object.

from anduril import Lattice

client = Lattice(
    client_id="<clientId>",
    client_secret="<clientSecret>",
)

client.objects.list_objects()
# You can also iterate through pages and access the typed response per page
pager = client.objects.list_objects(...)
for page in pager.iter_pages():
    print(page.response)  # access the typed response for each page
    for item in page:
        print(item)

Oauth Token Override

This SDK supports two authentication methods: OAuth client credentials flow (automatic token management) or direct bearer token authentication. You can choose between these options when initializing the client:

from anduril import Lattice

# Option 1: Direct bearer token (bypass OAuth flow)
client = Lattice(
    ...,
    token="my-pre-generated-bearer-token",
)

# Option 2: OAuth client credentials flow (automatic token management)
client = Lattice(
    ...,
    client_id="your-client-id",
    client_secret="your-client-secret",
)

Advanced

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

from anduril import Lattice

client = Lattice(...)
response = client.entities.with_raw_response.long_poll_entity_events(...)
print(response.headers)  # access the response headers
print(response.status_code)  # access the response status code
print(response.data)  # access the underlying object

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

Which status codes are retried depends on the retryStatusCodes generator configuration:

legacy (current default): retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 5XX (All server errors, including 500)

recommended: retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 502 (Bad Gateway)
  • 503 (Service Unavailable)
  • 504 (Gateway Timeout)

Use the max_retries request option to configure this behavior.

client.entities.long_poll_entity_events(..., request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from anduril import Lattice

client = Lattice(..., timeout=20.0)

# Override timeout for a specific method
client.entities.long_poll_entity_events(..., request_options={
    "timeout": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from anduril import Lattice

client = Lattice(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

anduril_lattice_sdk-4.24.0.tar.gz (151.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

anduril_lattice_sdk-4.24.0-py3-none-any.whl (296.3 kB view details)

Uploaded Python 3

File details

Details for the file anduril_lattice_sdk-4.24.0.tar.gz.

File metadata

  • Download URL: anduril_lattice_sdk-4.24.0.tar.gz
  • Upload date:
  • Size: 151.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.20 Linux/6.17.0-1020-azure

File hashes

Hashes for anduril_lattice_sdk-4.24.0.tar.gz
Algorithm Hash digest
SHA256 6e92275512cfc584379cfd3e52bbb62dd4c1b8d08da42a64ab3fc8a8bbd2f6e6
MD5 a2ac18d747ac681bd75d8d3446037ad2
BLAKE2b-256 1a0b758bfc7eef857463433155cbabd1e0d8462a3649e54c43426836a8136ad0

See more details on using hashes here.

File details

Details for the file anduril_lattice_sdk-4.24.0-py3-none-any.whl.

File metadata

  • Download URL: anduril_lattice_sdk-4.24.0-py3-none-any.whl
  • Upload date:
  • Size: 296.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.20 Linux/6.17.0-1020-azure

File hashes

Hashes for anduril_lattice_sdk-4.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1f9d416114a8f4b53638e61fb3ebb1b31ddf545d7eee79b26e057c68ea1e03e0
MD5 49d5eb3da231901b1bbb20f761cf50d9
BLAKE2b-256 076e85c1b6c1568945c89b0bdcf401aa3a57481b75b19c3eda3a0f4c3837703f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page