wasm_modules¶

Client API for wasm_modules in Nexus.

qnexus.client.wasm_modules.get( *, id: UUID | str | None = None, name: str | None = None, name_like: str | None = None, creator_email: list[str] | None = None, project: ProjectRef | None = None, properties: OrderedDict[str, bool | int | float | str] | None = None, created_before: datetime | None = None, created_after: datetime | None = datetime.datetime(2023, 1, 1, 0, 0), modified_before: datetime | None = None, modified_after: datetime | None = None, sort_filters: list[SortFilterEnum] | None = None, page_number: int | None = None, page_size: int | None = None, scope: ScopeFilterEnum = ScopeFilterEnum.USER, ) → WasmModuleRef[source]¶

Get a single wasm_module using filters. Throws an exception if the filters do not match exactly one object.

Examples

>>> import qnexus as qnx
>>> wasm_ref = qnx.wasm_modules.get(name="my_wasm_module")

qnexus.client.wasm_modules.get_all( *, name_like: str | None = None, name_exact: list[str] | None = None, creator_email: list[str] | None = None, project: ProjectRef | None = None, properties: OrderedDict[str, bool | int | float | str] | None = None, created_before: datetime | None = None, created_after: datetime | None = datetime.datetime(2023, 1, 1, 0, 0), modified_before: datetime | None = None, modified_after: datetime | None = None, sort_filters: list[SortFilterEnum] | None = None, page_number: int | None = None, page_size: int | None = None, scope: ScopeFilterEnum = ScopeFilterEnum.USER, ) → NexusIterator[WasmModuleRef][source]¶

Get a NexusIterator over wasm_modules with optional filters.

Examples

>>> import qnexus as qnx
>>> all_wasm = qnx.wasm_modules.get_all()
>>> all_wasm.df()

>>> project_wasm = qnx.wasm_modules.get_all(
...     name_like="my_module",
...     project=my_project_ref,
... )

qnexus.client.wasm_modules.update( ref: WasmModuleRef, name: str | None = None, description: str | None = None, properties: OrderedDict[str, bool | int | float | str] | None = None, ) → WasmModuleRef[source]¶

Update the annotations on a WasmModuleRef.

Examples

>>> import qnexus as qnx
>>> updated_ref = qnx.wasm_modules.update(
...     wasm_ref,
...     name="renamed_module",
... )

qnexus.client.wasm_modules.upload( wasm_module_handler: WasmModuleHandler, project: ProjectRef | None = None, name: str | None = None, description: str | None = None, properties: OrderedDict[str, bool | int | float | str] | None = None, ) → WasmModuleRef[source]¶

Upload a pytket WasmModule to Nexus.

Examples

>>> import qnexus as qnx
>>> from pytket.wasm import WasmModuleHandler
>>> wasm_handler = WasmModuleHandler("my_wasm_module.wasm")
>>> wasm_ref = qnx.wasm_modules.upload(
...     wasm_handler,
...     name="my_wasm_module",
...     project=my_project_ref,
... )