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# pylint: disable=unused-wildcard-import,wildcard-import 

24# ruff: noqa: F403,F405 

25 

26 

27from __future__ import annotations 

28 

29from .imports import * 

30 

31 

32TABLE: types.MappingProxyType[ str, str ] = types.MappingProxyType( { 

33 

34 'class attributes immutability': ''' 

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

36''', 

37 

38 'description of class factory class': ''' 

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

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

41instances. 

42''', 

43 

44 'description of module': ''' 

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

46Python module class. 

47''', 

48 

49 'description of namespace': ''' 

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

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

52namespace object reflects its current instance attributes. Modeled after 

53:py:class:`types.SimpleNamespace`. 

54''', 

55 

56 'dictionary entries immutability': ''' 

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

58''', 

59 

60 'dictionary entries validation': ''' 

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

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

63dictionary creation is rejected. 

64''', 

65 

66 'instance attributes immutability': ''' 

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

68''', 

69 

70 'module attributes immutability': ''' 

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

72 

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

74module interfaces remain stable during runtime. 

75''', 

76 

77} )