blight.action

  1"""
  2The different actions supported by blight.
  3"""
  4
  5from typing import Any, Dict, Optional
  6
  7import blight.tool
  8from blight.tool import Tool
  9
 10
 11class Action:
 12    """
 13    A generic action, run with every tool (both before and after the tool's execution).
 14    """
 15
 16    def __init__(self, config: Dict[str, str]):
 17        self._config = config
 18        self._result: Optional[Dict[str, Any]] = None
 19
 20    def _should_run_on(self, tool: Tool) -> bool:
 21        return True
 22
 23    def before_run(self, tool: Tool) -> None:  # pragma: no cover
 24        """
 25        Invoked right before the underlying tool is run.
 26
 27        Args:
 28            tool: The tool about to run
 29        """
 30        pass
 31
 32    def _before_run(self, tool: Tool) -> None:
 33        if self._should_run_on(tool):
 34            self.before_run(tool)
 35
 36    def after_run(self, tool: Tool, *, run_skipped: bool = False) -> None:  # pragma: no cover
 37        """
 38        Invoked right after the underlying tool is run.
 39
 40        Args:
 41            tool: The tool that just ran
 42        """
 43        pass
 44
 45    def _after_run(self, tool: Tool, *, run_skipped: bool = False) -> None:
 46        if self._should_run_on(tool):
 47            self.after_run(tool, run_skipped=run_skipped)
 48
 49    @property
 50    def result(self) -> Optional[Dict[str, Any]]:
 51        """
 52        Returns the result computed by this action, if there is one.
 53        """
 54        return self._result
 55
 56
 57class CCAction(Action):
 58    """
 59    A `cc` action, run whenever the tool is a `blight.tool.CC` instance.
 60    """
 61
 62    def _should_run_on(self, tool: Tool) -> bool:
 63        return isinstance(tool, blight.tool.CC)
 64
 65
 66class CXXAction(Action):
 67    """
 68    A `c++` action, run whenever the tool is a `blight.tool.CXX` instance.
 69    """
 70
 71    def _should_run_on(self, tool: Tool) -> bool:
 72        return isinstance(tool, blight.tool.CXX)
 73
 74
 75class CompilerAction(CCAction, CXXAction):
 76    """
 77    A generic compiler action, run whenever the tool is a `blight.tool.CC`
 78    or `blight.tool.CXX` instance.
 79
 80    **NOTE:** Action writers should generally prefer this over `CCAction` and `CXXAction`,
 81    as messy builds may use `cc` to compile C++ sources (via `-x c`) and vice versa.
 82    """
 83
 84    def _should_run_on(self, tool: Tool) -> bool:
 85        return isinstance(tool, (blight.tool.CC, blight.tool.CXX))
 86
 87
 88class CPPAction(Action):
 89    """
 90    A `cpp` action, run whenever the tool is a `blight.tool.CPP` instance.
 91    """
 92
 93    def _should_run_on(self, tool: Tool) -> bool:
 94        return isinstance(tool, blight.tool.CPP)
 95
 96
 97class LDAction(Action):
 98    """
 99    An `ld` action, run whenever the tool is a `blight.tool.LD` instance.
100    """
101
102    def _should_run_on(self, tool: Tool) -> bool:
103        return isinstance(tool, blight.tool.LD)
104
105
106class ASAction(Action):
107    """
108    An `as` action, run whenever the tool is a `blight.tool.AS` instance.
109    """
110
111    def _should_run_on(self, tool: Tool) -> bool:
112        return isinstance(tool, blight.tool.AS)
113
114
115class ARAction(Action):
116    """
117    An `ar` action, run whenever the tool is a `blight.tool.AR` instance.
118    """
119
120    def _should_run_on(self, tool: Tool) -> bool:
121        return isinstance(tool, blight.tool.AR)
122
123
124class STRIPAction(Action):
125    """
126    A `strip` action, run whenever the tool is a `blight.tool.STRIP` instance.
127    """
128
129    def _should_run_on(self, tool: Tool) -> bool:
130        return isinstance(tool, blight.tool.STRIP)