Coverage for sources/dynadoc/__/doctab.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''' Docstring fragments. ''' 

22 

23 

24from . import imports as __ 

25 

26 

27_FragmentsTable: __.typx.TypeAlias = __.cabc.Mapping[ str, str ] 

28fragments: _FragmentsTable = __.types.MappingProxyType( { 

29 

30 'context': 

31 ''' Data transfer object for various behaviors. 

32 

33 Controls how annotations are resolved and how fragments are 

34 processed and rendered. 

35 ''', 

36 

37 'fragment rectifier': 

38 ''' Cleans and normalizes documentation fragment. ''', 

39 

40 'fragments name': 

41 ''' Name of class attribute which stores documentation fragments. ''', 

42 

43 'introspection': 

44 ''' Controls on introspection behavior. 

45 

46 Is introspection enabled? 

47 Which kinds of objects to recursively document? 

48 Etc... 

49 ''', 

50 

51 'introspection limit name': 

52 ''' Name of class attribute which stores introspection limit. ''', 

53 

54 'invoker globals': 

55 ''' Dictionary of globals from the frame of a caller. 

56 

57 Used by renderers for determing whether to fully-qualify a name. 

58 ''', 

59 

60 'notifier': ''' Notifies of warnings and errors. ''', 

61 

62 'renderer': 

63 ''' Produces docstring fragment from object and information about it. ''', 

64 

65 'resolver globals': 

66 ''' Dictionary of globals for annotation resolution. 

67 

68 Used for resolving string annotations. 

69 ''', 

70 

71 'resolver locals': 

72 ''' Dictionary of locals for annotation resolution. 

73 

74 Used for resolving string annotations. 

75 ''', 

76 

77 'visibility decider': 

78 ''' Decides if attribute should have visible documentation. ''', 

79 

80} )