Class Snippet

SLiCAP/SLiCAPprotos.py:646–731

Text snippet created by the formatters.

}

class Snippet:
    """
    Text snippet created by the formatters.
    """
    def __init__(self, snippet: str = "", format: None | str = None, mode="w") -> None:
        self._snippet = snippet
        self.mode     = mode
        if format is None:
            self._format = "raw"
            self._prefix, self._suffix = _FORMATS[self._format]
        else:
            try:
                self._prefix, self._suffix = _FORMATS[format]
                self._format = format
            except KeyError:
                raise KeyError(f"Unknown formatting: {format}.")

    @property
    def snippet(self):
        """
        Will be set by the formatter method.
        """
        return self._snippet

    @property
    def format(self):
        """
        Will be set by the formatter method.
        """
        return self._format

    def __str__(self):
        return self._snippet

    def __repr__(self):
        return f'Snippet("{self.snippet}", format="{self.format}")'

    def save(self, filenameOrPath: str | Path):
        """
        Saves the snippet.

        If the path is absolute, it saves it in that location.
        Otherwise, the preffix and suffix are added according to format:
            
        - latex
        
          - prefix: project folder -> SLiCAP.ini -> [projectpaths] -> tex_snippets
          - suffix: '.tex'
              
        - rst
        
          - prefix: project folder -> SLiCAP.ini -> [projectpaths] -> rst_snippets
          - suffix: '.rst'    
          - expressions and inline equations are appended to the file as:
            
            \\|<variable name>\\| = <expr>\\|<inline equation>
          
        - myst