`tlc.service.object_service`¶

The 3LC Object Service.

Module Contents¶

Classes¶

Class	Description
`LitestarStateConstants`	Constants for the Litestar state.
`TLCObject`	In-flight representation of a TLCObject.
`TLCPatchOptions`	TLC patch request.
`TLCPatchRequest`	In-flight representation of a patch request for a TLCObject.
`ReindexRequest`	Request model for re-indexing operations.
`RollbackDeleteContext`	A context manager for rollback object creation without interfering with InsufficientCredits.
`ObjectServiceFeatures`
`ObjectServiceUserInfo`
`DashboardAnnotations`
`ETagMiddleware`	A middleware that may serve 304 not modified responses based on ETag headers.
`ObjectRoutesController`	Controller for all object-related routes
`ExternalDataRoutesController`	Controller for all external data-related routes
`SettingsRoutesController`	Controller for all settings-related routes
`TLCCustomLoggingMiddleware`	Custom middleware to log object service requests and responses.
`NGrokOutputAdaptor`	Helper class to format output from NGrokHelper for the Object Service.

Functions¶

Function	Description
`internal_server_error_handler`	Catch-all for application errors.
`insufficient_credits_handler`	Handler for insufficient credits.
`timestamp_skew_handler`	Handler for timestamp skew.
`resolve_cache_timeout`
`get_ip_addresses`
`get_running_urls`
`format_yaml_for_logging`
`open_in_web_browser`
`open_dashboard_in_web_browser`
`startup`	Setup HTTP client for connecting to 3LC Data Service
`shutdown`	Perform any required cleanup before terminating the application
`root`	Root endpoint of the service
`live`	Endpoint for checking if the service is running.
`get_status`	Returns status of the service
`get_last_lru_stats`
`status`	Returns status of the service
`create_litestar_app`

Data¶

Data	Description
`last_lru_stats`
`T`

API¶

class LitestarStateConstants¶

Constants for the Litestar state.

HOST_IP = HostIP¶

OBJECT_SERVICE_RUNNING_URLS = ObjectServiceRunningsURLs¶

NGROK_OBJECT_SERVICE_URL = NGrokObjectServiceURL¶

internal_server_error_handler( request: Request, exception: Exception, ) → Response¶: Catch-all for application errors.

insufficient_credits_handler( request: Request, exception: tlcsaas.transaction.InsufficientCredits, ) → Response¶: Handler for insufficient credits.

timestamp_skew_handler( request: Request, exception: TimestampSkewException, ) → Response¶: Handler for timestamp skew.

resolve_cache_timeout() → int¶

class TLCObject(

/,

**data: typing.Any,

)¶

Bases: pydantic.BaseModel

In-flight representation of a TLCObject.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

type: str = None¶

url: Optional[str] = None¶

model_config = ConfigDict(...)¶

class TLCPatchOptions(

/,

**data: typing.Any,

)¶

Bases: pydantic.BaseModel

TLC patch request.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

delete_old_url: bool = False¶

model_config = ConfigDict(...)¶

class TLCPatchRequest(

/,

**data: typing.Any,

)¶

Bases: pydantic.BaseModel

In-flight representation of a patch request for a TLCObject.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

patch_object: TLCObject = None¶

patch_options: TLCPatchOptions = TLCPatchOptions(...)¶

model_config = ConfigDict(...)¶

class ReindexRequest(

/,

**data: typing.Any,

)¶

Bases: pydantic.BaseModel

Request model for re-indexing operations.

Parameters:

force – Whether to force re-indexing to disregard the state of the current index timestamp files.
types – The types of objects to reindex. Defaults to “all”.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

force: bool = False¶

types: list[Literal[run, table, config, all]] = ['all']¶

model_config = ConfigDict(...)¶

class RollbackDeleteContext( url: Url, )¶

A context manager for rollback object creation without interfering with InsufficientCredits.

rollback() → None¶

get_ip_addresses() → list[str]¶

get_running_urls() → list[str]¶

format_yaml_for_logging( data: dict | list, indent: int = 4, ) → str¶

open_in_web_browser( url: str, ) → None¶

open_dashboard_in_web_browser( app: Litestar, ) → None¶

async startup( app: Litestar, ) → None¶: Setup HTTP client for connecting to 3LC Data Service

async shutdown( app: Litestar, ) → None¶: Perform any required cleanup before terminating the application

async root() → Response¶: Root endpoint of the service

async live() → Response¶: Endpoint for checking if the service is running.

class ObjectServiceFeatures(

/,

**data: typing.Any,

)¶

Bases: pydantic.BaseModel

post_external_data: bool = True¶

class ObjectServiceUserInfo(

/,

**data: typing.Any,

)¶

Bases: pydantic.BaseModel

user_id: str = None¶

tenant_id: str = None¶

user_full_name: str = None¶

user_email: str = None¶

tenant_name: str = None¶

class DashboardAnnotations(

/,

**data: typing.Any,

)¶

Bases: pydantic.BaseModel

banner_icon_url: str = <Multiline-String>¶

banner_background_color: str = <Multiline-String>¶

banner_message: str = <Multiline-String>¶

title_message: str = <Multiline-String>¶

get_status() → dict[str, Any]¶: Returns status of the service

last_lru_stats: dict[str, Any] | None = None¶

get_last_lru_stats() → dict[str, Any] | None¶

async status( request: Request, ) → dict[str, Any]¶: Returns status of the service

class ETagMiddleware(

app: litestar.types.ASGIApp,

**kwargs: Any,

)¶

Bases: litestar.middleware.MiddlewareProtocol

A middleware that may serve 304 not modified responses based on ETag headers.

Only affects endpoints/responses that have previously been served with ETag. Other requests are passed through.

If the request contains an If-None-Match header with the same ETag as the previous response, a 304 Not Modified response is returned.

class ObjectRoutesController( owner: Router, )¶

Bases: litestar.controller.Controller

Controller for all object-related routes

Initialize a controller.

Should only be called by routers as part of controller registration.

Args: owner: An instance of :class:Router <.router.Router>

path = /objects¶

cache_time_out = resolve_cache_timeout(...)¶

async get_encoded_url( encoded_url: str, request: Request, ) → Response[TLCObject]¶

async get_encoded_url_rows( encoded_url: str, attribute: str, request: Request, ) → Response[bytes]¶

async list_urls() → list[str]¶

Return all the objects.

Returns: list[Any]: List of the URLs of all the objects.

async request_reindex( data: ReindexRequest, ) → Response¶

Request a reindex operation.

Parameters:: data – The reindex request parameters.
Returns:: Response with status message.

async new_object( data: TLCObject, ) → Response¶

Create a new object.

Parameters:: data – Object to be created
Returns:: Empty response. URL of the created object will be in the ‘Location’ field of the response headers.

async delete_object( encoded_url: str, ) → None¶

Delete an object.

Parameters:: encoded_url – URL of the object to be deleted.
Raises:: HTTPException if no object can be found at the URL.

async update_object( encoded_url: str, data: TLCPatchRequest, ) → Response¶

Update the attributes of an object.

Raises: HTTPException: If the object type of obj_in does not match the type of the object at object_url.

class ExternalDataRoutesController( owner: Router, )¶

Bases: litestar.controller.Controller

Controller for all external data-related routes

Initialize a controller.

Should only be called by routers as part of controller registration.

Args: owner: An instance of :class:Router <.router.Router>

path = /external_data¶

cache_time_out = resolve_cache_timeout(...)¶

async get_encoded_url( encoded_url: str, ) → bytes¶

async post_encoded_url( request: Request, owner_url: str, base_name: str, extension: str, ) → Response¶

Write a new file with given binary contents.

Parameters:

request – The request object.
owner_url – The URL of the tlc Object that owns the file. Currently only support Table owners, data will be written in the table’s bulk data folder.
base_name – The base name of the file or folder to be created. Used to provide more context to the filename.
extension – The extension of the file.

Returns:

A response with a 201 status code and a Location header pointing to the newly created file.

async get_encoded_url_binary_contents( encoded_url: str, format: str, ) → Response¶

class SettingsRoutesController( owner: Router, )¶

Bases: litestar.controller.Controller

Controller for all settings-related routes

Initialize a controller.

Should only be called by routers as part of controller registration.

Args: owner: An instance of :class:Router <.router.Router>

path = /settings¶

async get_settings_key_value( settings_scope: str, settings_key: str, ) → Response¶

async put_settings_key_value( request: Request, settings_scope: str, settings_key: str, ) → Response¶

Create or update the value for a setting by key.

Parameters:

request – The request object.
settings_scope – The scope of the setting.
settings_key – The key for the setting.

async delete_settings_key_value( settings_scope: str, settings_key: str, ) → None¶

class TLCCustomLoggingMiddleware( app: litestar.types.ASGIApp, config: LoggingMiddlewareConfig, )¶

Bases: litestar.middleware.logging.LoggingMiddleware

Custom middleware to log object service requests and responses.

Logs request and response data to loglevel.INFO, together with the time it takes to complete the request.

Initialize LoggingMiddleware.

Args: app: The next ASGI app to call. config: An instance of LoggingMiddlewareConfig.

async log_request( scope: litestar.types.Scope, receive: litestar.types.Receive, ) → None¶: Record the start time and log the request data.

log_response( scope: litestar.types.Scope, ) → None¶: Measure elapsed time and log the response data.

log_message( values: dict[str, Any], ) → None¶

Log a message.

This is a copy of the superclass’ method, with special case handling of the /status endpoint, and url decoding of the path.

Parameters:: values – Extract values to log.
Returns:: None

class NGrokOutputAdaptor( role: str, ngrok_helper: tlccli.subcommands.ngrok_helper.NGrokHelper, )¶

Helper class to format output from NGrokHelper for the Object Service.

async output_public_url( app: Litestar, ) → None¶

T = TypeVar(...)¶

create_litestar_app( host: str, port: int, use_ngrok: bool, dashboard: bool = False, after_startup_handler: list[litestar.types.callable_types.LifespanHook] | litestar.types.callable_types.LifespanHook | None = None, after_shutdown_handler: list[litestar.types.callable_types.LifespanHook] | litestar.types.callable_types.LifespanHook | None = None, ) → Litestar¶

tlc.service.object_service¶

Module Contents¶

Classes¶

Functions¶

Data¶

API¶

`tlc.service.object_service`¶