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( __.immut.Object, BaseException ): 

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

29 # TODO: Class and instance attribute concealment. 

30 

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

32 frozenset( ( '__cause__', '__context__', ) ) ) 

33 

34 

35class Omnierror( Omniexception, Exception ): 

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

37 

38 

39class DataAwol( Omnierror, AssertionError ): 

40 ''' Unexpected data absence. ''' 

41 

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

43 super( ).__init__( 

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

45 

46 

47class FileDataAwol( DataAwol ): 

48 ''' Unexpected data absence from file. ''' 

49 

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

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

52 

53 

54class FileAwol( Omnierror, AssertionError ): 

55 ''' Unexpected file absence. ''' 

56 

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

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

59 

60 

61class FileEmpty( Omnierror, AssertionError ): 

62 ''' Unexpectedly empty file. ''' 

63 

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

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