:py:mod:`nexus_worker.stubs`
============================

.. py:module:: nexus_worker.stubs

.. autodoc2-docstring:: nexus_worker.stubs
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`submit <nexus_worker.stubs.submit>`
     - .. autodoc2-docstring:: nexus_worker.stubs.submit
          :summary:
   * - :py:obj:`check_status <nexus_worker.stubs.check_status>`
     - .. autodoc2-docstring:: nexus_worker.stubs.check_status
          :summary:
   * - :py:obj:`get_results <nexus_worker.stubs.get_results>`
     - .. autodoc2-docstring:: nexus_worker.stubs.get_results
          :summary:

API
~~~

.. py:class:: submit
   :canonical: nexus_worker.stubs.submit

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: nexus_worker.stubs.submit

   .. py:attribute:: circuits
      :canonical: nexus_worker.stubs.submit.circuits
      :type: tierkreis.controller.data.models.TKR[list[tierkreis.controller.data.models.OpaqueType[pytket._tket.circuit.Circuit]]]
      :value: None

      .. autodoc2-docstring:: nexus_worker.stubs.submit.circuits

   .. py:attribute:: n_shots
      :canonical: nexus_worker.stubs.submit.n_shots
      :type: tierkreis.controller.data.models.TKR[int]
      :value: None

      .. autodoc2-docstring:: nexus_worker.stubs.submit.n_shots

   .. py:method:: out() -> type[tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[qnexus.models.references.ExecuteJobRef]]]
      :canonical: nexus_worker.stubs.submit.out
      :staticmethod:

      .. autodoc2-docstring:: nexus_worker.stubs.submit.out

   .. py:property:: namespace
      :canonical: nexus_worker.stubs.submit.namespace
      :type: str

      .. autodoc2-docstring:: nexus_worker.stubs.submit.namespace

.. py:class:: check_status
   :canonical: nexus_worker.stubs.check_status

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: nexus_worker.stubs.check_status

   .. py:attribute:: execute_ref
      :canonical: nexus_worker.stubs.check_status.execute_ref
      :type: tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[qnexus.models.references.ExecuteJobRef]]
      :value: None

      .. autodoc2-docstring:: nexus_worker.stubs.check_status.execute_ref

   .. py:method:: out() -> type[tierkreis.controller.data.models.TKR[str]]
      :canonical: nexus_worker.stubs.check_status.out
      :staticmethod:

      .. autodoc2-docstring:: nexus_worker.stubs.check_status.out

   .. py:property:: namespace
      :canonical: nexus_worker.stubs.check_status.namespace
      :type: str

      .. autodoc2-docstring:: nexus_worker.stubs.check_status.namespace

.. py:class:: get_results
   :canonical: nexus_worker.stubs.get_results

   Bases: :py:obj:`typing.NamedTuple`

   .. autodoc2-docstring:: nexus_worker.stubs.get_results

   .. py:attribute:: execute_ref
      :canonical: nexus_worker.stubs.get_results.execute_ref
      :type: tierkreis.controller.data.models.TKR[tierkreis.controller.data.models.OpaqueType[qnexus.models.references.ExecuteJobRef]]
      :value: None

      .. autodoc2-docstring:: nexus_worker.stubs.get_results.execute_ref

   .. py:method:: out() -> type[tierkreis.controller.data.models.TKR[list[tierkreis.controller.data.models.OpaqueType[pytket.backends.backendresult.BackendResult]]]]
      :canonical: nexus_worker.stubs.get_results.out
      :staticmethod:

      .. autodoc2-docstring:: nexus_worker.stubs.get_results.out

   .. py:property:: namespace
      :canonical: nexus_worker.stubs.get_results.namespace
      :type: str

      .. autodoc2-docstring:: nexus_worker.stubs.get_results.namespace