Coverage for sources/accretive/exceptions.py: 100%

1# vim: set filetype=python fileencoding=utf-8: 

2# -*- coding: utf-8 -*- 

3 

4#============================================================================# 

5# # 

6# Licensed under the Apache License, Version 2.0 (the "License"); # 

7# you may not use this file except in compliance with the License. # 

8# You may obtain a copy of the License at # 

9# # 

10# http://www.apache.org/licenses/LICENSE-2.0 # 

11# # 

12# Unless required by applicable law or agreed to in writing, software # 

13# distributed under the License is distributed on an "AS IS" BASIS, # 

14# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # 

15# See the License for the specific language governing permissions and # 

16# limitations under the License. # 

17# # 

18#============================================================================# 

19 

20 

21''' Family of exceptions for package API. ''' 

22 

23 

24from . import __ # pylint: disable=cyclic-import 

25 

26 

27class Omniexception( __.InternalObject, BaseException ): 

28 ''' Base for all exceptions raised by package API. ''' 

29 

30 _attribute_visibility_includes_: __.cabc.Collection[ str ] = ( 

31 frozenset( ( '__cause__', '__context__', ) ) ) 

32 

33 

34class Omnierror( Omniexception, Exception ): 

35 ''' Base for error exceptions raised by package API. ''' 

36 

37 

38class EntryValidationError( Omnierror, ValueError ): 

39 ''' Attempt to add invalid entry to dictionary. ''' 

40 

41 def __init__( self, key: __.cabc.Hashable, value: __.a.Any ) -> None: 

42 super( ).__init__( 

43 f"Cannot add invalid entry ( {key!r}, {value!r} ) to dictionary." ) 

44 

45 

46class IndelibleAttributeError( Omnierror, AttributeError, TypeError ): 

47 ''' Attempt to reassign or delete indelible attribute. ''' 

48 

49 def __init__( self, name: str ) -> None: 

50 super( ).__init__( 

51 f"Cannot reassign or delete existing attribute {name!r}." ) 

52 

53 

54class IndelibleEntryError( Omnierror, TypeError ): 

55 ''' Attempt to update or remove indelible dictionary entry. ''' 

56 

57 def __init__( self, indicator: __.a.Any ) -> None: 

58 super( ).__init__( 

59 f"Cannot update or remove existing entry for {indicator!r}." ) 

60 

61 

62class InvalidOperationError( Omnierror, RuntimeError, TypeError ): 

63 ''' Attempt to perform invalid operation. ''' 

64 

65 def __init__( self, name: str ) -> None: 

66 super( ).__init__( f"Cannot perform operation {name!r}." )