Coverage for sources/frigid/__/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''' Docstrings table for reuse across entities. ''' 

22 

23 

24from . import imports as __ 

25 

26 

27fragments: __.cabc.Mapping[ str, str ] = __.types.MappingProxyType( { 

28 

29 'cfc class conceal': 

30 ''' By default, conceals non-public class attributes. ''', 

31 

32 'cfc class protect': 

33 ''' By default, protects class attributes. ''', 

34 

35 'cfc dynadoc': ''' Applies Dynadoc decoration to classes. ''', 

36 

37 'cfc instance conceal': 

38 ''' Produces classes which can conceal instance attributes. ''', 

39 

40 'cfc instance protect': 

41 ''' Produces classes which can protect instance attributes. ''', 

42 

43 'cfc produce abstract base class': 

44 ''' Produces abstract base classes compatible with :py:class:`abc.ABCMeta`. 

45 ''', 

46 

47 'cfc produce dataclass': 

48 ''' Produces inheritable dataclasses with keyword-only instantiation. ''', 

49 

50 'cfc produce protocol class': 

51 ''' Produces :pep:`544` protocol classes. ''', 

52 

53 'class concealment': 

54 ''' By default, non-public class attributes are invisible. ''', 

55 

56 'class protection': 

57 ''' By default, class attributes are immutable. ''', 

58 

59 'class instance conceal': 

60 ''' By default, conceals non-public instance attributes. ''', 

61 

62 'class instance protect': 

63 ''' By default, protects instance attributes. ''', 

64 

65 'dataclass': 

66 ''' Inheritable dataclass with keyword-only instantiation. ''', 

67 

68 'protocol class': 

69 ''' Protocol class (:pep:`544`). Nominal and structural subtyping. ''', 

70 

71 'class dynadoc': ''' Is decorated by Dynadoc. ''', 

72 

73 'dictionary entries protect': 

74 ''' Protects dictionary entries on initialization. ''', 

75 

76 'dictionary entries validate': 

77 ''' Validates dictionary entries on initialization. ''', 

78 

79 'module': 

80 ''' Python module class, derived from :py:class:`types.ModuleType`. ''', 

81 

82 'module conceal': 

83 ''' By default, conceals non-public module attributes. ''', 

84 

85 'module protect': 

86 ''' By default, protects module attributes. ''', 

87 

88 'namespace': 

89 ''' Namespace object, modeled after :py:class:`types.SimpleNamespace. ''', 

90 

91} )