.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/cython/plot_06_multifile_support_files.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_cython_plot_06_multifile_support_files.py>`
        to download the full example code or to run this example in your browser via JupyterLite or Binder.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_cython_plot_06_multifile_support_files.py:


Multi-file builds: .pxi includes and external headers
=====================================================

.. currentmodule:: scikitplot.cython

Real projects often split Cython code across multiple files:

- ``.pxi`` for shared Cython fragments (``include "helper.pxi"``)
- ``.pxd`` for shared declarations (usually used with ``cimport`` across modules)
- ``.h`` for C-level declarations used via ``cdef extern from ...``

This single-module example uses ``support_files`` to ship extra files into the
build dir without touching your repository.

Important
---------
A ``.pxd`` file alone does not create a runtime module. Using ``cimport name``
requires that ``name`` is an actual compiled module. To keep this demo as a
single-module build, we include the ``.pxd`` textually instead of ``cimport``.
See the package-build note below for the real multi-module ``cimport`` pattern.

.. GENERATED FROM PYTHON SOURCE LINES 23-27

.. code-block:: Python


    # Authors: The scikit-plots developers
    # SPDX-License-Identifier: BSD-3-Clause








.. GENERATED FROM PYTHON SOURCE LINES 28-32

.. code-block:: Python

    from __future__ import annotations

    from scikitplot import cython








.. GENERATED FROM PYTHON SOURCE LINES 33-35

Generate `python` Module from `cython`
--------------------------------------

.. GENERATED FROM PYTHON SOURCE LINES 35-87

.. code-block:: Python


    report = cython.check_build_prereqs(numpy=False)

    if not report.get('cython', {}).get('ok'):
        print("Skipping compilation because build prerequisites are missing.")
        problems = report.get("problems", [])
        if problems:
            print("Problems:", problems)
    else:
        support_files = {
            # Declarations file (used as textual include in this single-module demo).
            "_helper_decl.pxd": "cdef inline int square_d(int x):\n    return x * x\n",
            # Implementation fragment (text include).
            "_helper_square.pxi": "cdef int square_i(int x):\n    return x * x\n",
            # C header (extern usage).
            "_helper_add.h": "static int add_i(int a, int b) { return a + b; }\n",
        }

        code = r"""
    # distutils: language = c

    # Single-module demo: include .pxd textually for declarations (no runtime import).
    from _helper_decl cimport square_d

    include "_helper_square.pxi"

    cdef extern from "_helper_add.h":
        int add_i(int a, int b)

    def squared(int n):
        return square_d(n)

    def square(int n):
        return square_i(n)

    def add(int a, int b):
        return add_i(a, b)
    """

        r = cython.compile_and_load_result(
            code,
            module_name="multifile_demo",
            profile="fast-debug",
            support_files=support_files,
            compiler_directives={"language_level": 3, "embedsignature": True},
            verbose=0,
        )

        print("squared(7) =", r.module.squared(7))
        print("square(7)  =", r.module.square(7))
        print("add(2,3)   =", r.module.add(2, 3))





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    squared(7) = 49
    square(7)  = 49
    add(2,3)   = 5




.. GENERATED FROM PYTHON SOURCE LINES 88-93

.. tags::

   domain: cython
   plot-type: cython
   purpose: showcase


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.465 seconds)


.. _sphx_glr_download_auto_examples_cython_plot_06_multifile_support_files.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: binder-badge

      .. image:: images/binder_badge_logo.svg
        :target: https://mybinder.org/v2/gh/scikit-plots/scikit-plots/main?urlpath=lab/tree/notebooks/auto_examples/cython/plot_06_multifile_support_files.ipynb
        :alt: Launch binder
        :width: 150 px

    .. container:: lite-badge

      .. image:: images/jupyterlite_badge_logo.svg
        :target: ../../lite/lab/index.html?path=auto_examples/cython/plot_06_multifile_support_files.ipynb
        :alt: Launch JupyterLite
        :width: 150 px

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_06_multifile_support_files.ipynb <plot_06_multifile_support_files.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_06_multifile_support_files.py <plot_06_multifile_support_files.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_06_multifile_support_files.zip <plot_06_multifile_support_files.zip>`


.. include:: plot_06_multifile_support_files.recommendations


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_