build_tools.syllable_walk_web.services.pipeline_runner
======================================================

.. py:module:: build_tools.syllable_walk_web.services.pipeline_runner

.. autoapi-nested-parse::

   Pipeline runner service for the web application.

   Executes extraction → normalization → annotation → database build
   as sequential subprocesses in a background thread.



Attributes
----------

.. autoapisummary::

   build_tools.syllable_walk_web.services.pipeline_runner.STAGE_NAMES


Functions
---------

.. autoapisummary::

   build_tools.syllable_walk_web.services.pipeline_runner.start_pipeline
   build_tools.syllable_walk_web.services.pipeline_runner.cancel_pipeline
   build_tools.syllable_walk_web.services.pipeline_runner.get_status


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

.. py:data:: STAGE_NAMES
   :value: ('extract', 'normalize', 'annotate', 'database')


.. py:function:: start_pipeline(job, *, extractor = 'pyphen', language = 'auto', source_path = None, output_dir = None, file_pattern = '*.txt', min_syllable_length = 2, max_syllable_length = 8, run_normalize = True, run_annotate = True)

   Start a pipeline run in a background thread.

   Updates ``job`` state in-place as stages progress.

   :param job: Mutable pipeline job state (shared with server).
   :param extractor: ``"pyphen"`` or ``"nltk"``.
   :param language: Language code for pyphen (e.g. ``"en_US"``, ``"auto"``).
   :param source_path: Source directory containing text files.
   :param output_dir: Parent directory for pipeline output.
   :param file_pattern: Glob pattern for input files.
   :param min_syllable_length: Minimum syllable length filter.
   :param max_syllable_length: Maximum syllable length filter.
   :param run_normalize: Whether to run normalization stage.
   :param run_annotate: Whether to run annotation stage (requires normalization).


.. py:function:: cancel_pipeline(job)

   Cancel a running pipeline job.


.. py:function:: get_status(job)

   Return current pipeline job status as a JSON-serialisable dict.