Coverage for sources/ictruck/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 __ 

25 

26 

27class Omniexception( 

28 BaseException, 

29 metaclass = __.ImmutableClass, 

30 decorators = ( __.immutable, ), 

31): 

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

33 # TODO: Class and instance attribute concealment. 

34 

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

36 frozenset( ( '__cause__', '__context__', ) ) ) 

37 

38 

39class Omnierror( Omniexception, Exception ): 

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

41 

42 

43class ArgumentClassInvalidity( Omnierror, TypeError ): 

44 ''' Argument class is invalid. ''' 

45 

46 def __init__( self, name: str, classes: type | tuple[ type, ... ] ): 

47 if isinstance( classes, type ): classes = ( classes, ) 

48 cnames = ' | '.join( map( 

49 lambda cls: f"{cls.__module__}.{cls.__qualname__}", classes ) ) 

50 super( ).__init__( 

51 f"Argument {name!r} must be an instance of {cnames}." ) 

52 

53 

54class AttributeNondisplacement( Omnierror, AttributeError ): 

55 ''' Cannot displace existing attribute. ''' 

56 

57 def __init__( self, object_: __.typx.Any, name: str ): 

58 super( ).__init__( 

59 f"Cannot displace attribute {name!r} on: {object_}" ) 

60 

61 

62class FlavorInavailability( Omnierror, ValueError ): 

63 ''' Requested flavor is not available. ''' 

64 

65 def __init__( self, flavor: int | str ): 

66 super( ).__init__( f"Flavor {flavor!r} is not available." ) 

67 

68 

69class ModuleInferenceFailure( Omnierror, RuntimeError ): 

70 ''' Failure to infer invoking module from call stack. ''' 

71 

72 def __init__( self ): 

73 super( ).__init__( "Could not infer invoking module from call stack." )