Changeset - f508df06c162
Parent rev.
Child rev.
[Not reviewed]
0 3 0
Brett Smith - 3 years ago 2021-02-19 23:54:36
brettcsmith@brettcsmith.org
rewrite: Richer exceptions for error reporting.
3 files changed with 131 insertions and 50 deletions:
conservancy_beancount/errors.py
39
conservancy_beancount/reports/rewrite.py
84
37
tests/test_reports_rewrite.py
8
13
0 comments (0 inline, 0 general)
conservancy_beancount/errors.py
➞
Show inline comments
...
 
@@ -11,2 +11,3 @@ from typing import (
 
    Any,
 
    ClassVar,
 
    Iterable,
...
 
@@ -129 +130,39 @@ class InvalidMetadataError(Error):
 
        self.value = value
 

			




	
	
	
		
 

			




	
	
	
		
 
class RewriteRuleError(ValueError):


			




	
	
	
		
 
    item_type: ClassVar[Optional[str]] = None


			




	
	
	
		
 

			




	
	
	
		
 
    def __init__(self,


			




	
	
	
		
 
                 message: str,


			




	
	
	
		
 
                 filename: Optional[str]=None,


			




	
	
	
		
 
                 rulenum: Optional[int]=None,


			




	
	
	
		
 
                 source: Optional[Any]=None,


			




	
	
	
		
 
    ) -> None:


			




	
	
	
		
 
        super().__init__(message, filename, rulenum, source)


			




	
	
	
		
 
        self.message = message


			




	
	
	
		
 
        self.filename = filename


			




	
	
	
		
 
        self.rulenum = rulenum


			




	
	
	
		
 
        self.source = source


			




	
	
	
		
 

			




	
	
	
		
 
    def __str__(self) -> str:


			




	
	
	
		
 
        msg_parts = [self.message]


			




	
	
	
		
 
        if self.filename is not None:


			




	
	
	
		
 
            msg_parts.append(f"in {self.filename}")


			




	
	
	
		
 
        if self.rulenum is not None:


			




	
	
	
		
 
            msg_parts.append(f"rule #{self.rulenum}")


			




	
	
	
		
 
            if self.item_type is not None:


			




	
	
	
		
 
                msg_parts.append(self.item_type)


			




	
	
	
		
 
        return ' '.join(msg_parts)


			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
class RewriteRuleActionError(RewriteRuleError):


			




	
	
	
		
 
    item_type = 'action'


			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
class RewriteRuleConditionError(RewriteRuleError):


			




	
	
	
		
 
    item_type = 'condition'


			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
class RewriteRuleLoadError(RewriteRuleError): pass


			




	
	
	
		
 
class RewriteRuleValidationError(RewriteRuleError): pass


			




        

    


    
    

    

        

                

                    conservancy_beancount/reports/rewrite.py
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	...
	
		
 
@@ -151,2 +151,3 @@ import re


			




	
	
	
		
 
from typing import (


			




	
	
	
		
 
    Any,


			




	
	
	
		
 
    Callable,


			




	...
	
		
 
@@ -179,2 +180,3 @@ import yaml


			




	
	
	
		
 
from .. import data


			




	
	
	
		
 
from .. import errors


			




	
	
	
		
 

			




	...
	
		
 
@@ -201,3 +203,3 @@ class _Registry(Generic[T]):


			




	
	
	
		
 
    def __init__(self,


			




	
	
	
		
 
                 description: str,


			




	
	
	
		
 
                 error_cls: Type[errors.RewriteRuleError],


			




	
	
	
		
 
                 parser: Union[str, Pattern],


			




	...
	
		
 
@@ -208,3 +210,3 @@ class _Registry(Generic[T]):


			




	
	
	
		
 
            parser = re.compile(parser)


			




	
	
	
		
 
        self.description = description


			




	
	
	
		
 
        self.error_cls = error_cls


			




	
	
	
		
 
        self.parser = parser


			




	...
	
		
 
@@ -216,3 +218,3 @@ class _Registry(Generic[T]):


			




	
	
	
		
 
        if match is None:


			




	
	
	
		
 
            raise ValueError(f"could not parse {self.description} {s!r}")


			




	
	
	
		
 
            raise self.error_cls(f"parse error: {s!r}")


			




	
	
	
		
 
        subject = match.group(1)


			




	...
	
		
 
@@ -230,3 +232,3 @@ class _Registry(Generic[T]):


			




	
	
	
		
 
        except KeyError:


			




	
	
	
		
 
            raise ValueError(f"unknown subject in {self.description} {subject!r}") from None


			




	
	
	
		
 
            raise self.error_cls(f"unknown subject: {subject!r}") from None


			




	
	
	
		
 
        else:


			




	...
	
		
 
@@ -236,2 +238,3 @@ class _Registry(Generic[T]):


			




	
	
	
		
 
class Tester(Generic[T], metaclass=abc.ABCMeta):


			




	
	
	
		
 
    ERROR = errors.RewriteRuleConditionError


			




	
	
	
		
 
    OPS: Mapping[str, TestCallable] = CMP_OPS


			




	...
	
		
 
@@ -242,3 +245,3 @@ class Tester(Generic[T], metaclass=abc.ABCMeta):


			




	
	
	
		
 
        except KeyError:


			




	
	
	
		
 
            raise ValueError(f"unsupported operator {operator!r}") from None


			




	
	
	
		
 
            raise self.ERROR(f"unsupported operator: {operator!r}") from None


			




	
	
	
		
 
        self.operand = self.parse_operand(operand)


			




	...
	
		
 
@@ -270,3 +273,3 @@ class AccountTest(Tester[str]):


			




	
	
	
		
 
        else:


			




	
	
	
		
 
            raise ValueError(f"invalid account name {operand!r}")


			




	
	
	
		
 
            raise errors.RewriteRuleConditionError(f"invalid account name: {operand!r}")


			




	
	
	
		
 

			




	...
	
		
 
@@ -285,3 +288,6 @@ class DateTest(Tester[datetime.date]):


			




	
	
	
		
 
    def parse_operand(operand: str) -> datetime.date:


			




	
	
	
		
 
        return datetime.datetime.strptime(operand, '%Y-%m-%d').date()


			




	
	
	
		
 
        try:


			




	
	
	
		
 
            return datetime.datetime.strptime(operand, '%Y-%m-%d').date()


			




	
	
	
		
 
        except ValueError as error:


			




	
	
	
		
 
            raise errors.RewriteRuleConditionError(error.args[0])


			




	
	
	
		
 

			




	...
	
		
 
@@ -331,3 +337,3 @@ class NumberTest(Tester[Decimal]):


			




	
	
	
		
 
        except decimal.DecimalException:


			




	
	
	
		
 
            raise ValueError(f"could not parse decimal {operand!r}")


			




	
	
	
		
 
            raise errors.RewriteRuleConditionError(f"decimal parse error: {operand!r}")


			




	
	
	
		
 

			




	...
	
		
 
@@ -338,3 +344,3 @@ class NumberTest(Tester[Decimal]):


			




	
	
	
		
 
TestRegistry: _Registry[Tester] = _Registry(


			




	
	
	
		
 
    'condition',


			




	
	
	
		
 
    Tester.ERROR,


			




	
	
	
		
 
    '^{}{}'.format(


			




	...
	
		
 
@@ -355,2 +361,3 @@ class Setter(Generic[T], metaclass=abc.ABCMeta):


			




	
	
	
		
 
    _regtype = 'setter'


			




	
	
	
		
 
    ERROR = errors.RewriteRuleActionError


			




	
	
	
		
 

			




	...
	
		
 
@@ -363,4 +370,9 @@ class AccountSet(Setter[data.Account]):


			




	
	
	
		
 
        if operator != '=':


			




	
	
	
		
 
            raise ValueError(f"unsupported operator for account {operator!r}")


			




	
	
	
		
 
        self.value = data.Account(AccountTest.parse_operand(value))


			




	
	
	
		
 
            raise self.ERROR(f"unsupported operator for account: {operator!r}")


			




	
	
	
		
 
        try:


			




	
	
	
		
 
            self.value = data.Account(AccountTest.parse_operand(value))


			




	
	
	
		
 
        except errors.RewriteRuleConditionError as error:


			




	
	
	
		
 
            new_error = errors.RewriteRuleActionError(*error.args)


			




	
	
	
		
 
            new_error.__cause__ = error.__cause__


			




	
	
	
		
 
            raise new_error


			




	
	
	
		
 

			




	...
	
		
 
@@ -373,3 +385,3 @@ class MetadataSet(Setter[str]):


			




	
	
	
		
 
        if operator != '=':


			




	
	
	
		
 
            raise ValueError(f"unsupported operator for metadata {operator!r}")


			




	
	
	
		
 
            raise self.ERROR(f"unsupported operator for metadata: {operator!r}")


			




	
	
	
		
 
        self.key = key


			




	...
	
		
 
@@ -384,4 +396,9 @@ class NumberSet(Setter[data.Amount]):


			




	
	
	
		
 
        if operator != '*=':


			




	
	
	
		
 
            raise ValueError(f"unsupported operator for number {operator!r}")


			




	
	
	
		
 
        self.value = NumberTest.parse_operand(value)


			




	
	
	
		
 
            raise self.ERROR(f"unsupported operator for number: {operator!r}")


			




	
	
	
		
 
        try:


			




	
	
	
		
 
            self.value = NumberTest.parse_operand(value)


			




	
	
	
		
 
        except errors.RewriteRuleConditionError as error:


			




	
	
	
		
 
            new_error = errors.RewriteRuleActionError(*error.args)


			




	
	
	
		
 
            new_error.__cause__ = error.__cause__


			




	
	
	
		
 
            raise new_error


			




	
	
	
		
 

			




	...
	
		
 
@@ -393,3 +410,3 @@ class NumberSet(Setter[data.Amount]):


			




	
	
	
		
 
SetRegistry: _Registry[Setter] = _Registry(


			




	
	
	
		
 
    'action',


			




	
	
	
		
 
    Setter.ERROR,


			




	
	
	
		
 
    rf'^{SUBJECT_PAT}([-+/*]?=)',


			




	...
	
		
 
@@ -415,2 +432,4 @@ class _RootAccount(enum.Enum):


			




	
	
	
		
 
class RewriteRule:


			




	
	
	
		
 
    ERROR = errors.RewriteRuleValidationError


			




	
	
	
		
 

			




	
	
	
		
 
    def __init__(self, source: Mapping[str, List[str]]) -> None:


			




	...
	
		
 
@@ -429,3 +448,3 @@ class RewriteRule:


			




	
	
	
		
 
                    elif any(isinstance(t, type(setter)) for t in rewrites):


			




	
	
	
		
 
                        raise ValueError(f"rule conflicts with earlier action: {rule_s!r}")


			




	
	
	
		
 
                        raise self.ERROR(f"rule conflicts with earlier action: {rule_s!r}")


			




	
	
	
		
 
                    else:


			




	...
	
		
 
@@ -440,3 +459,3 @@ class RewriteRule:


			




	
	
	
		
 
        if not if_ok:


			




	
	
	
		
 
            raise ValueError("no `if` condition in rule") from None


			




	
	
	
		
 
            raise self.ERROR("no `if` condition in rule") from None


			




	
	
	
		
 

			




	...
	
		
 
@@ -462,3 +481,3 @@ class RewriteRule:


			




	
	
	
		
 
                    if new_root is not account_condition:


			




	
	
	
		
 
                        raise ValueError(


			




	
	
	
		
 
                        raise self.ERROR(


			




	
	
	
		
 
                            f"cannot assign {new_root} account "


			




	...
	
		
 
@@ -471,5 +490,5 @@ class RewriteRule:


			




	
	
	
		
 
        if not number_reallocation:


			




	
	
	
		
 
            raise ValueError("no rewrite actions in rule")


			




	
	
	
		
 
            raise self.ERROR("no rewrite actions")


			




	
	
	
		
 
        elif number_reallocation != 1:


			




	
	
	
		
 
            raise ValueError(f"rule multiplies number by {number_reallocation}")


			




	
	
	
		
 
            raise self.ERROR(f"rule multiplies number by {number_reallocation}")


			




	
	
	
		
 

			




	...
	
		
 
@@ -502,21 +521,49 @@ class RewriteRuleset:


			




	
	
	
		
 
    @classmethod


			




	
	
	
		
 
    def from_yaml(cls, source: Union[str, IO, Path]) -> 'RewriteRuleset':


			




	
	
	
		
 
    def _iter_yaml(cls, source: Iterable[Any], name: str) -> Iterator[RewriteRule]:


			




	
	
	
		
 
        for number, item in enumerate(source, 1):


			




	
	
	
		
 
            try:


			




	
	
	
		
 
                if not isinstance(item, Mapping):


			




	
	
	
		
 
                    raise errors.RewriteRuleLoadError(f"item is not a rule hash")


			




	
	
	
		
 
                for key, value in item.items():


			




	
	
	
		
 
                    if not isinstance(value, list):


			




	
	
	
		
 
                        raise errors.RewriteRuleLoadError(


			




	
	
	
		
 
                            f"YAML item {number} {key!r} value is not a list",


			




	
	
	
		
 
                        )


			




	
	
	
		
 
                    elif not all(isinstance(s, str) for s in value):


			




	
	
	
		
 
                        raise errors.RewriteRuleLoadError(


			




	
	
	
		
 
                            f"YAML item {number} {key!r} value is not all strings",


			




	
	
	
		
 
                        )


			




	
	
	
		
 
                yield RewriteRule(item)


			




	
	
	
		
 
            except errors.RewriteRuleError as error:


			




	
	
	
		
 
                error.filename = name


			




	
	
	
		
 
                error.rulenum = number


			




	
	
	
		
 
                error.source = item


			




	
	
	
		
 
                raise


			




	
	
	
		
 

			




	
	
	
		
 
    @classmethod


			




	
	
	
		
 
    def from_yaml(


			




	
	
	
		
 
            cls,


			




	
	
	
		
 
            source: Union[str, IO, Path],


			




	
	
	
		
 
            name: Optional[str]=None,


			




	
	
	
		
 
    ) -> 'RewriteRuleset':


			




	
	
	
		
 
        if isinstance(source, Path):


			




	
	
	
		
 
            with source.open() as source_file:


			




	
	
	
		
 
                return cls.from_yaml(source_file)


			




	
	
	
		
 
        doc = yaml.safe_load(source)


			




	
	
	
		
 
        if not isinstance(doc, list):


			




	
	
	
		
 
            raise ValueError("YAML root element is not a list")


			




	
	
	
		
 
        for number, item in enumerate(doc, 1):


			




	
	
	
		
 
            if not isinstance(item, Mapping):


			




	
	
	
		
 
                raise ValueError(f"YAML item {number} is not a rule hash")


			




	
	
	
		
 
            for key, value in item.items():


			




	
	
	
		
 
                if not isinstance(value, list):


			




	
	
	
		
 
                    raise ValueError(f"YAML item {number} {key!r} value is not a list")


			




	
	
	
		
 
                elif not all(isinstance(s, str) for s in value):


			




	
	
	
		
 
                    raise ValueError(f"YAML item {number} {key!r} value is not all strings")


			




	
	
	
		
 
                return cls.from_yaml(source_file, str(source))


			




	
	
	
		
 
        if name is None:


			




	
	
	
		
 
            if isinstance(source, str):


			




	
	
	
		
 
                name = '<string>'


			




	
	
	
		
 
            else:


			




	
	
	
		
 
                name = getattr(source, 'name', '<file>')


			




	
	
	
		
 
        try:


			




	
	
	
		
 
            logger.debug("loaded %s rewrite rules from YAML", number)


			




	
	
	
		
 
        except NameError:


			




	
	
	
		
 
            logger.warning("YAML source is empty; no rewrite rules loaded")


			




	
	
	
		
 
        return cls(RewriteRule(src) for src in doc)


			




	
	
	
		
 
            doc = yaml.safe_load(source)


			




	
	
	
		
 
        except yaml.error.YAMLError as error:


			




	
	
	
		
 
            raise errors.RewriteRuleLoadError(str(error), name)


			




	
	
	
		
 
        if not isinstance(doc, list):


			




	
	
	
		
 
            raise errors.RewriteRuleLoadError("YAML root element is not a list", name)


			




	
	
	
		
 
        retval = cls(cls._iter_yaml(doc, name))


			




	
	
	
		
 
        logger.log(


			




	
	
	
		
 
            logging.DEBUG if retval.rules else logging.WARNING,


			




	
	
	
		
 
            "loaded %s rewrite rules from %s",


			




	
	
	
		
 
            len(retval.rules), name,


			




	
	
	
		
 
        )


			




	
	
	
		
 
        return retval


			




        

    


    
    

    

        

                

                    tests/test_reports_rewrite.py
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	...
	
		
 
@@ -17,3 +17,3 @@ from . import testutil


			




	
	
	
		
 

			




	
	
	
		
 
from conservancy_beancount import data


			




	
	
	
		
 
from conservancy_beancount import data, errors


			




	
	
	
		
 
from conservancy_beancount.reports import rewrite


			




	...
	
		
 
@@ -133,3 +133,3 @@ def test_parse_good_condition(subject, operator, operand):


			




	
	
	
		
 
def test_parse_bad_condition(cond_s):


			




	
	
	
		
 
    with pytest.raises(ValueError):


			




	
	
	
		
 
    with pytest.raises(errors.RewriteRuleConditionError):


			




	
	
	
		
 
        rewrite.TestRegistry.parse(cond_s)


			




	...
	
		
 
@@ -197,3 +197,3 @@ def test_parse_good_set(subject, operator, operand):


			




	
	
	
		
 
def test_parse_bad_set(set_s):


			




	
	
	
		
 
    with pytest.raises(ValueError):


			




	
	
	
		
 
    with pytest.raises(errors.RewriteRuleActionError):


			




	
	
	
		
 
        rewrite.SetRegistry.parse(set_s)


			




	...
	
		
 
@@ -273,5 +273,2 @@ def test_valid_rewrite_rule(source):


			




	
	
	
		
 
    {'a': ['.account = Income:Other'], 'b': ['.account = Expenses:Other']},


			




	
	
	
		
 
    # Condition/assignment mixup


			




	
	
	
		
 
    {'if': ['.account = Equity:Other'], 'then': ['equity-type = other']},


			




	
	
	
		
 
    {'if': ['.account == Equity:Other'], 'then': ['equity-type != other']},


			




	
	
	
		
 
    # Cross-category account assignment


			




	...
	
		
 
@@ -282,4 +279,2 @@ def test_valid_rewrite_rule(source):


			




	
	
	
		
 
    {'if': ['.date >= 2020-01-01'], 'a': ['k1=v1'], 'b': ['k2=v2']},


			




	
	
	
		
 
    # Date assignment


			




	
	
	
		
 
    {'if': ['.date == 2020-01-01'], 'then': ['.date = 2020-02-02']},


			




	
	
	
		
 
    # Redundant assignments


			




	...
	
		
 
@@ -292,3 +287,3 @@ def test_valid_rewrite_rule(source):


			




	
	
	
		
 
def test_invalid_rewrite_rule(source):


			




	
	
	
		
 
    with pytest.raises(ValueError):


			




	
	
	
		
 
    with pytest.raises(errors.RewriteRuleValidationError):


			




	
	
	
		
 
        rewrite.RewriteRule(source)


			




	...
	
		
 
@@ -335,3 +330,3 @@ def test_bad_ruleset_yaml_path():


			




	
	
	
		
 
    yaml_path = testutil.test_path('repository/Projects/project-data.yml')


			




	
	
	
		
 
    with pytest.raises(ValueError):


			




	
	
	
		
 
    with pytest.raises(errors.RewriteRuleLoadError):


			




	
	
	
		
 
        rewrite.RewriteRuleset.from_yaml(yaml_path)


			




	...
	
		
 
@@ -346,4 +341,4 @@ def test_bad_ruleset_yaml_path():


			




	
	
	
		
 
    'string',


			




	
	
	
		
 
    [{}, 'a'],


			




	
	
	
		
 
    [{}, ['b']],


			




	
	
	
		
 
    ['a'],


			




	
	
	
		
 
    [['b']],


			




	
	
	
		
 
    # Rules have wrong type


			




	...
	
		
 
@@ -354,3 +349,3 @@ def test_bad_ruleset_yaml_str(source):


			




	
	
	
		
 
    yaml_doc = yaml.safe_dump(source)


			




	
	
	
		
 
    with pytest.raises(ValueError):


			




	
	
	
		
 
    with pytest.raises(errors.RewriteRuleLoadError):


			




	
	
	
		
 
        rewrite.RewriteRuleset.from_yaml(yaml_doc)


			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







    


    

  


    








    
        Server instance: kapok.sfconservancy.org-30870
    
    
        This site is powered by
            Kallithea 0.6.3,
        which is
        © 2010–2020 by various authors & licensed under GPLv3.
            – Support
        – Privacy Policy