Coverage for sources/frigid/__/nomina.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''' Common names and type aliases. ''' 

22 

23# ruff: noqa: F401 

24 

25 

26from classcore.standard.nomina import ( 

27 AttributesNamer, 

28 BehaviorExclusionVerifiersOmni, 

29 DecorationPreparers as ClassDecorationPreparers, 

30 DynadocConfiguration, 

31 concealment_label, 

32 immutability_label, 

33) 

34 

35from . import imports as __ 

36 

37 

38H = __.typx.TypeVar( 'H', bound = __.cabc.Hashable ) # Hash Key 

39T = __.typx.TypeVar( 'T', bound = type ) # Class 

40U = __.typx.TypeVar( 'U' ) # Class 

41V = __.typx.TypeVar( 'V' ) # Value 

42 

43 

44ComparisonResult: __.typx.TypeAlias = bool | __.types.NotImplementedType 

45NominativeArguments: __.typx.TypeAlias = __.cabc.Mapping[ str, __.typx.Any ] 

46PositionalArguments: __.typx.TypeAlias = __.cabc.Sequence[ __.typx.Any ] 

47 

48# TODO: Import ClassDecorator aliases from 'classcore' once documentation 

49# fragments have been removed from them. 

50ClassDecorator: __.typx.TypeAlias = ( 

51 __.cabc.Callable[ [ type[ U ] ], type[ U ] ] ) 

52ClassDecorators: __.typx.TypeAlias = ( 

53 __.cabc.Sequence[ ClassDecorator[ U ] ] ) 

54ClassDecoratorFactory: __.typx.TypeAlias = ( 

55 __.cabc.Callable[ ..., ClassDecorator[ U ] ] ) 

56ModuleReclassifier: __.typx.TypeAlias = __.cabc.Callable[ 

57 [ __.cabc.Mapping[ str, __.typx.Any ] ], None ] 

58 

59DictionaryNominativeArgument: __.typx.TypeAlias = __.typx.Annotated[ 

60 V, 

61 __.ddoc.Doc( 

62 'Zero or more keyword arguments from which to initialize ' 

63 'dictionary data.' ), 

64] 

65DictionaryPositionalArgument: __.typx.TypeAlias = __.typx.Annotated[ 

66 __.cabc.Mapping[ H, V ] | __.cabc.Iterable[ tuple[ H, V ] ], 

67 __.ddoc.Doc( 

68 'Zero or more iterables from which to initialize dictionary data. ' 

69 'Each iterable must be dictionary or sequence of key-value pairs. ' 

70 'Duplicate keys will result in an error.' ), 

71] 

72DictionaryValidator: __.typx.TypeAlias = __.typx.Annotated[ 

73 __.cabc.Callable[ [ H, V ], bool ], 

74 __.ddoc.Doc( 

75 'Callable which validates entries before addition to dictionary.' ), 

76] 

77 

78 

79package_name = __name__.split( '.', maxsplit = 1 )[ 0 ] 

80 

81 

82def calculate_attrname( level: str, core: str ) -> str: 

83 return f"_{package_name}_{level}_{core}_" 

84 

85 

86# TODO: Import 'is_public_identifier' from 'classcore'. 

87def is_public_identifier( name: str ) -> bool: 

88 ''' Is Python identifier public? ''' 

89 return not name.startswith( '_' )