..
    ----------------------------------------------------------------------------------------------
     Copyright (c) The Einsums Developers. All rights reserved.
     Licensed under the MIT License. See LICENSE.txt in the project root for license information.
    ----------------------------------------------------------------------------------------------


.. _cppapi_PyiEmitter:

==========
PyiEmitter
==========

.. note::
   Generated from the C++ headers by ``apiary --emit-cpp-docs-json``.

.. cpp:namespace:: apiary

.. cpp:class:: PyiOptions

   Options controlling Python stub (.pyi) emission.


   .. cpp:member:: std::string banner

      Optional comment header inserted at the top (e.g. "// generated from XYZ.hpp"). Empty by default.



.. cpp:function:: std::string emit_pyi(const Module &module_, const PyiOptions &opts)

   Render the module IR as a Python stub file.

   :param module_: The module IR to emit.
   :param opts: Emission options; defaults to an empty PyiOptions.
   :returns: The rendered .pyi stub file contents.