Coverage for sources/classcore/__/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 'cfc class conceal': 

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

32 

33 'cfc class protect': 

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

35 

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

37 

38 'cfc instance conceal': 

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

40 

41 'cfc instance protect': 

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

43 

44 'cfc produce dataclass': 

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

46 

47 'cfc produce protocol class': 

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

49 

50 'class concealment': 

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

52 

53 'class protection': 

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

55 

56 'class instance conceal': 

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

58 

59 'class instance protect': 

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

61 

62 'dataclass': 

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

64 

65 'protocol class': 

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

67 

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

69 

70 'decorators': 

71 ''' Sequence of class decorators. 

72 

73 Each element takes a class argument and returns a class. 

74 ''', 

75 

76} )