Method save

SLiCAP/SLiCAPprotos.py:683–731

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 - su

(self, filenameOrPath: str | Path)

        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
        
          - prefix: project folder -> SLiCAP.ini -> [projectpaths] -> myst_snippets
          - suffix: '.md'
              
        - html
        
          - prefix: project folder -> SLiCAP.ini -> [projectpaths] -> html_snippets
          - suffix: &#x27;.html

        - md
        
          - prefix: project folder -> SLiCAP.ini -> [projectpaths] -> md_snippets
          - suffix: '.md'
          
        """
        if self.snippet != None:
            if not filenameOrPath:
                raise ValueError("No filename given to save snippet.")
            if self.mode.lower() not in ["a", "w"]:
                raise ValueError("Mode must be 'a' or 'w'.")
            if isinstance(filenameOrPath, Path):
                filenameOrPath = str(filenameOrPath)
            if os.path.isabs(filenameOrPath):
                filePath = filenameOrPath
            else:
                filePath = self._prefix + filenameOrPath + self._suffix
            with open(filePath, self.mode) as f:
                f.write(self.snippet)
        
class _BaseFormatter:
    """