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# ruff: noqa: F403,F405 

24 

25 

26from . import imports as __ 

27 

28 

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

30 

31 'cfc class conceal': 

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

33 

34 'cfc class protect': 

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

36 

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

38 

39 'cfc instance conceal': 

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

41 

42 'cfc instance protect': 

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

44 

45 'cfc produce abstract base class': 

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

47 ''', 

48 

49 'cfc produce dataclass': 

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

51 

52 'cfc produce protocol class': 

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

54 

55 'class concealment': 

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

57 

58 'class protection': 

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

60 

61 'class instance conceal': 

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

63 

64 'class instance protect': 

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

66 

67 'dataclass': 

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

69 

70 'protocol class': 

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

72 

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

74 

75 'dictionary entries protect': 

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

77 

78 'dictionary entries validate': 

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

80 

81 'module': 

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

83 

84 'module conceal': 

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

86 

87 'module protect': 

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

89 

90 'namespace': 

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

92 

93} )