Coverage for sources/frigid/_docstrings.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 subpackages. ''' 

22 

23 

24from types import MappingProxyType as _DictionaryProxy 

25 

26 

27TABLE: _DictionaryProxy[ str, str ] = _DictionaryProxy( { 

28 

29 'class attributes immutability': ''' 

30Prevents assignment or deletion of class attributes after class creation. 

31''', 

32 

33 'description of class factory class': ''' 

34Derived from :py:class:`type`, this is a metaclass. A metaclass is a class 

35factory class. I.e., it is a class that produces other classes as its 

36instances. 

37''', 

38 

39 'description of module': ''' 

40Derived from :py:class:`types.ModuleType`, this class is suitable for use as a 

41Python module class. 

42''', 

43 

44 'description of namespace': ''' 

45A namespace is an object, whose attributes can be determined from iterables and 

46keyword arguments, at initialization time. The string representation of the 

47namespace object reflects its current instance attributes. Modeled after 

48:py:class:`types.SimpleNamespace`. 

49''', 

50 

51 'dictionary entries immutability': ''' 

52Prevents addition, alteration, or removal of dictionary entries after creation. 

53''', 

54 

55 'dictionary entries validation': ''' 

56When an attempt to create a dictionary with entries, each entry is validated 

57against supplied criteria. If validation fails for any entry, then the 

58dictionary creation is rejected. 

59''', 

60 

61 'instance attributes immutability': ''' 

62Prevents assignment or deletion of instance attributes after instance creation. 

63''', 

64 

65 'module attributes immutability': ''' 

66Prevents assignment or deletion of module attributes after module creation. 

67 

68This behavior helps ensure that module-level constants remain constant and that 

69module interfaces remain stable during runtime. 

70''', 

71 

72} )