Coverage for sources/emcdproj/exceptions.py: 81%

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 DataAwol( Omnierror, AssertionError ): 

44 ''' Unexpected data absence. ''' 

45 

46 def __init__( self, source: str, label: str ): 

47 super( ).__init__( 

48 f"Necessary data with label '{label}' is missing from {source}." ) 

49 

50 

51class FileDataAwol( DataAwol ): 

52 ''' Unexpected data absence from file. ''' 

53 

54 def __init__( self, file: str | __.Path, label: str ): 

55 super( ).__init__( source = f"file '{file}'", label = label ) 

56 

57 

58class FileAwol( Omnierror, AssertionError ): 

59 ''' Unexpected file absence. ''' 

60 

61 def __init__( self, file: str | __.Path ): 

62 super( ).__init__( f"Necessary file is missing at '{file}'." ) 

63 

64 

65class FileEmpty( Omnierror, AssertionError ): 

66 ''' Unexpectedly empty file. ''' 

67 

68 def __init__( self, file: str| __.Path ): 

69 super( ).__init__( f"Unexpectedly empty file at '{file}'." )