Cassowary
b389506b4b
- Update copyright.
- Remove manifest.in since we're switching to PDM (and defaults moved
to the module).
- Remove setup.py since we're switching to PDM.
- Remove chains.yaml, move data to the processor module.
- Fix passthrough in __main__
- Move main function to separate function to support PDM entrypoint.
- metadata.py: Extensive rework
* Add heck support (lots of little changes to support it). (.heck files can
replace .meta files)
* Add yaml metadata support (.meta files can be yaml)
* Some formatting changes.
* Make metatree be a little easier to read by separating out
functionality into extra functions
- processchain.py: Move chains.yaml to a structure internal.
- Add processors/process_heck.py to support the document side of HECKformat
- add pyproject.toml and embrace PDM.
72 lines
2.2 KiB
Python
72 lines
2.2 KiB
Python
import abc
|
|
from typing import Dict, Iterable, Optional
|
|
|
|
|
|
class PassthroughException(Exception):
|
|
"""Raised when the processor would like the file to pass through unchanged."""
|
|
|
|
class NoOutputException(Exception):
|
|
"""Raised when the processor would like no output to be written from the processing chain."""
|
|
|
|
class ProcessorException(Exception): # pragma: no cover
|
|
"""A base exception class to be used by processor objects."""
|
|
|
|
|
|
class Processor(abc.ABC): # pragma: no cover
|
|
def __init__(self, *args, **kwargs):
|
|
"""Initialize the class."""
|
|
|
|
@abc.abstractmethod
|
|
def filename(self, oldname: str, ctx: Optional[Dict] = None) -> str:
|
|
"""Return the filename of the post-processed file.
|
|
|
|
Arguments:
|
|
oldname (str): the previous name for the file.
|
|
ctx (dict, optional): A context object generated from the processor configuration
|
|
|
|
Returns:
|
|
str: the new name for the file
|
|
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def mime_type(self, oldname: str, ctx: Optional[Dict] = None) -> str:
|
|
"""Return the mimetype of the post-processed file.
|
|
|
|
Arguments:
|
|
oldname (str): the input filename
|
|
ctx (dict, optional): A context object generated from the processor configuration
|
|
|
|
Returns:
|
|
str: the new mimetype of the file after processing
|
|
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def extension(self, oldname: str, ctx: Optional[Dict] = None) -> str:
|
|
"""Return the mimetype of the post-processed file.
|
|
|
|
Arguments:
|
|
oldname (str): the input filename
|
|
ctx (dict, optional): A context object generated from the processor configuration
|
|
|
|
Returns:
|
|
str: the new extension of the file after processing
|
|
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def process(self, input_file: Iterable, ctx: Optional[Dict] = None) -> Iterable:
|
|
"""Return an iterable object of the post-processed file.
|
|
|
|
Arguments:
|
|
input_file (iterable): An input stream
|
|
ctx (dict, optional): A context object generated from the processor configuration
|
|
|
|
Returns:
|
|
iterable: The post-processed output stream
|
|
"""
|
|
|
|
def repr(self) -> str:
|
|
return self.__class__.__name__
|
