Skip to content

Base

base

Abstract base for compaction strategies.

SmeltStrategy

Bases: ABC

Base class for all compaction strategies.

Source code in packages/axm-smelt/src/axm_smelt/strategies/base.py
Python
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class SmeltStrategy(abc.ABC):
    """Base class for all compaction strategies."""

    @property
    @abc.abstractmethod
    def name(self) -> str: ...

    @property
    @abc.abstractmethod
    def category(self) -> str: ...

    @abc.abstractmethod
    def apply(self, ctx: SmeltContext) -> SmeltContext:
        """Apply the compaction strategy to the given context.

        Receives a ``SmeltContext`` carrying the current text (and optional
        parsed representation) and returns a new ``SmeltContext`` with the
        compacted result.  If the strategy does not apply, return *ctx*
        unchanged.
        """
        ...
apply(ctx) abstractmethod

Apply the compaction strategy to the given context.

Receives a SmeltContext carrying the current text (and optional parsed representation) and returns a new SmeltContext with the compacted result. If the strategy does not apply, return ctx unchanged.

Source code in packages/axm-smelt/src/axm_smelt/strategies/base.py
Python
25
26
27
28
29
30
31
32
33
34
@abc.abstractmethod
def apply(self, ctx: SmeltContext) -> SmeltContext:
    """Apply the compaction strategy to the given context.

    Receives a ``SmeltContext`` carrying the current text (and optional
    parsed representation) and returns a new ``SmeltContext`` with the
    compacted result.  If the strategy does not apply, return *ctx*
    unchanged.
    """
    ...