injector_fw
===========

.. py:module:: injector_fw

.. autoapi-nested-parse::

   LibCST Transformer for Injecting Framework Mappings.

   This module provides the logic to modify framework adapter files (e.g. `torch.py`)
   by locating the specific class registered for a framework and injecting a new
   `StandardMap` definition into its `definitions` property.

   It handles:
   1.  **Definitions Injection**: Appending the mapping to the definitions dictionary.
   2.  **Smart Import Injection**: Analyzing the target API path (e.g. `scipy.special.erf`)
       and injecting necessary top-level imports (`import scipy`) if missing.
   3.  **Variant Parameter Injection**: Supporting `inject_args` for adding fixed arguments.
   4.  **Complex Literal Support**: Recursively converting Lists, Tuples, and Dicts to CST nodes.



Classes
-------

.. autoapisummary::

   injector_fw.FrameworkInjector


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

.. py:class:: FrameworkInjector(target_fw: str, op_name: str, variant: ml_switcheroo.core.dsl.FrameworkVariant)

   Bases: :py:obj:`libcst.CSTTransformer`


   Injects a `StandardMap` entry into a Framework Adapter's definitions.

   It performs a targeted search for:
   1. A class decorated with `@register_framework("target_fw")`.
   2. A method named `definitions` decorated with `@property`.
   3. A `return` statement returning a `Dict`.

   Additionally, it scans the module for existing imports and injects missing
   dependencies required by the new mapping (e.g. injecting `import scipy` if
   the API is `scipy.special.erf`).

   .. attribute:: target_fw

      The framework key to look for (e.g. 'torch').

      :type: str

   .. attribute:: op_name

      The abstract operation name (e.g. 'LogSoftmax').

      :type: str

   .. attribute:: variant

      The configuration to inject.

      :type: FrameworkVariant

   .. attribute:: found

      True if intrusion was successful.

      :type: bool


   .. py:attribute:: target_fw


   .. py:attribute:: op_name


   .. py:attribute:: variant


   .. py:attribute:: found
      :value: False



   .. py:method:: visit_Import(node: libcst.Import) -> None

      Tracks existing top-level imports.



   .. py:method:: visit_ImportFrom(node: libcst.ImportFrom) -> None

      Tracks existing from-imports.



   .. py:method:: visit_ClassDef(node: libcst.ClassDef) -> Optional[bool]

      Checks if the class matches the target framework via decorator.



   .. py:method:: leave_ClassDef(original_node: libcst.ClassDef, updated_node: libcst.ClassDef) -> libcst.ClassDef

      Exit class scope.



   .. py:method:: visit_FunctionDef(node: libcst.FunctionDef) -> Optional[bool]

      Enters functions. Only interested if inside target class and named 'definitions'.



   .. py:method:: leave_FunctionDef(original_node: libcst.FunctionDef, updated_node: libcst.FunctionDef) -> libcst.FunctionDef

      Exit function scope.



   .. py:method:: leave_Return(original_node: libcst.Return, updated_node: libcst.Return) -> Union[libcst.Return, libcst.RemovalSentinel]

      Intercepts the return statement of the definitions property.
      Injects the new key-value into the dictionary.



   .. py:method:: leave_Module(original_node: libcst.Module, updated_node: libcst.Module) -> libcst.Module

      Post-process module to inject missing top-level imports.