sda.analysis.loaders
====================

.. py:module:: sda.analysis.loaders

.. autoapi-nested-parse::

   Supplementary file loaders shared across SDA analysis scripts.

   Provides :func:`load_supplementary_xlsx`, a robust loader for non-standard
   ``.xlsx`` files that live inside a test folder but are not registered as SDA
   tables (e.g. ``T346_analyse_EP.xlsx``).

   The loader handles Windows file-lock issues by copying to a temp location
   before opening with openpyxl.



Functions
---------

.. autoapisummary::

   sda.analysis.loaders.load_supplementary_xlsx


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

.. py:function:: load_supplementary_xlsx(test_name, filename = None, glob_patterns = None, sheet = 0, label = None)

   Load a supplementary ``.xlsx`` from the folder of an SDA test.

   Copies the file to a temporary location first so that Windows file locks
   (e.g. the file is open in Excel) do not prevent reading.

   :param test_name: the folder via :func:`sda.api.file_discovery.resolve_local_test_path`.
   :type test_name: :py:class:`SDA test identifier (e.g. `````"T346"``:py:class:```).  Used` to :py:class:`resolve`
   :param filename: When ``None``, the first file matching *glob_patterns* is used.
   :type filename: :py:class:`Exact filename` to :py:class:`load (e.g. `````"T346_analyse_EP.xlsx"``:py:class:```).`
   :param glob_patterns: *filename* is not given.  Defaults to
                         ``["*analyse*.xlsx", "*EP*.xlsx", "*ep*.xlsx"]``.
   :type glob_patterns: :py:class:`Glob patterns relative` to :py:class:`the test folder` to :py:class:`search when`
   :param sheet:
   :type sheet: :py:class:`Sheet index` or :py:class:`name` to :py:class:`parse.  Defaults` to ``0`` (first sheet).
   :param label: ``"<test_name>-sup"``).
   :type label: :py:class:`Short label for log messages (defaults to`

   :rtype: :class:`pandas.DataFrame` — empty on any failure.