latch package

Subpackages

• latch.functions package
  • Submodules
  • latch.functions.messages module
  • latch.functions.operators module
  • latch.functions.secrets module
  • Module contents
• latch.gql package
  • Module contents
• latch.registry package
  • Subpackages
    • latch.registry.upstream_types package
      • Submodules
      • latch.registry.upstream_types.types module
      • latch.registry.upstream_types.values module
      • Module contents
  • Submodules
  • latch.registry.project module
  • latch.registry.record module
  • latch.registry.table module
  • latch.registry.types module
  • latch.registry.utils module
  • Module contents
• latch.resources package
  • Submodules
  • latch.resources.conditional module
  • latch.resources.launch_plan module
  • latch.resources.map_tasks module
  • latch.resources.reference_workflow module
  • latch.resources.tasks module
  • latch.resources.workflow module
  • Module contents
• latch.types package
  • Submodules
  • latch.types.directory module
  • latch.types.file module
  • latch.types.glob module
  • latch.types.json module
  • latch.types.metadata module
  • latch.types.utils module
  • Module contents
• latch.verified package
  • Submodules
  • latch.verified.deseq2 module
  • latch.verified.mafft module
  • latch.verified.pathway module
  • latch.verified.rnaseq module
  • latch.verified.trim_galore module
  • Module contents

Submodules

latch.account module

class latch.account.Account(id: str)

Bases: object

User or team workspace. Can be used to fetch related resources.

current() is the typical way of getting an Account.

If the current request signer (CLI user or execution context) lacks permissions to fetch some information, the corresponding operations will act as if the information does not exist. Update operations will usually produce errors.

id: str

Unique identifier.

classmethod current() → typing_extensions.Self

Get current account.

In an execution context, this is the workspace in which the execution was run.

In the CLI context (when running latch commands) this is the current setting of latch workspace, which defaults to the user’s personal workspace.

Returns

Current account.

load() → None

(Re-)populate this account instance’s cache.

Future calls to most getters will return immediately without making a network request.

Always makes a network request.

list_registry_projects(*, load_if_missing: Literal[True] = 'True') → List[latch.registry.project.Project]

list_registry_projects(*, load_if_missing: bool) → Optional[List[latch.registry.project.Project]]

List Registry projects owned by this workspace.

Parameters

load_if_missing – If true, load() the project list if not in cache. If false, return None if not in cache.

Returns

Projects owned by this workspace.

update(*, reload_on_commit: bool = True) → Iterator[latch.account.AccountUpdate]

Start an update transaction.

The transaction will commit when the context manager closes unless an error occurs.

No changes will occur until the transaction commits.

The transaction can be cancelled by running AccountUpdate.clear() before closing the context manager.

Parameters

reload_on_commit – If true, load() this account after the transaction commits.

Returns

Context manager for the new transaction.

class latch.account.AccountUpdate(account: latch.account.Account)

Bases: object

account: latch.account.Account

upsert_registry_project(display_name: str)

Upsert a registry project.

Not idempotent. Two calls with the same args will create two projects.

Parameters

display_name – Display name of the new project.

delete_registry_project(id: str)

Delete a registry project.

Parameters

id – The ID of the target project.

commit() → None

Commit this account update transaction.

May be called multiple times.

All pending updates are committed with one network request.

Atomic. The entire transaction either commits or fails with an exception.

clear()

Remove pending updates.

May be called to cancel any pending updates that have not been committed.

Module contents

The Latch SDK

A commandline toolchain to define and register serverless workflows with the Latch platform.