Coverage for /var/devmt/py/utils4_1.8.0/utils4/termcolour.py: 100%

1#!/usr/bin/env python 

2# -*- coding: utf-8 -*- 

3""" 

4:Purpose: This module contains basic and bright (16 colours) text and 

5 background ANSI colour codes for colouring Linux and Windows 

6 terminal output. 

7 

8:Developer: J Berendt 

9:Email: support@s3dev.uk 

10 

11:Comments: If used on Windows, the ``colorama.init()`` method is 

12 called by the ``utils4.__init__`` module to configure Windows 

13 to handle CLI colouring. 

14 

15:Example: 

16 

17 Print red text to the terminal:: 

18 

19 >>> from utils4.termcolour import Text 

20 

21 >>> print(f'{Text.RED}ALERT! This is red text.{Text.RESET}') 

22 ALERT! This is red text. 

23 

24 

25 Print red text on a white background to the terminal:: 

26 

27 >>> from utils4.termcolour import Back, Text 

28 

29 >>> print(f'{Text.RED}{Back.BRIGHTWHITE}ALERT! This is red text on white.{Text.RESET}') 

30 ALERT! This is red text on white. 

31 

32 

33 Print bold yellow text on a black background to the terminal:: 

34 

35 >>> from utils4.termcolour import Back, Text, Style 

36 

37 >>> print(f'{Text.YELLOW}{Back.BLACK}{Style.BOLD}Bold yellow text.{Text.RESET}') 

38 Bold yellow text. 

39 

40""" 

41# pylint: disable=too-few-public-methods 

42 

43 

44class _AnsiBase: 

45 """Generic base ANSI colours class. 

46 

47 The colours for each class are dynamically created as class attributes 

48 by the initialiser of this base class. 

49 

50 """ 

51 

52 RESET = 0 

53 

54 def __init__(self): 

55 """ANSI generic base class initialiser.""" 

56 for i in self.__dir__(): 

57 if not i.startswith('_'): 

58 self.__setattr__(i, f'\033[{self.__getattribute__(i)}m') 

59 

60 

61class AnsiBack(_AnsiBase): 

62 """ANSI background colour codes. 

63 

64 Note: 

65 The bright colours have been included, but are not always supported. 

66 

67 """ 

68 

69 BLACK = 40 

70 RED = 41 

71 GREEN = 42 

72 YELLOW = 43 

73 BLUE = 44 

74 MAGENTA = 45 

75 CYAN = 46 

76 WHITE = 47 

77 BRIGHTBLACK = 100 

78 BRIGHTRED = 101 

79 BRIGHTGREEN = 102 

80 BRIGHTYELLOW = 103 

81 BRIGHTBLUE = 104 

82 BRIGHTMAGENTA = 105 

83 BRIGHTCYAN = 106 

84 BRIGHTWHITE = 107 

85 

86class AnsiStyle(_AnsiBase): 

87 """ANSI style codes.""" 

88 

89 BOLD = 1 

90 DIM = 2 

91 UNDERLINE = 4 

92 NORMAL = 22 

93 

94 

95class AnsiText(_AnsiBase): 

96 """ANSI foreground (text) colour codes. 

97 

98 Note: 

99 The bright colours have been included, but are not always supported. 

100 

101 """ 

102 

103 BLACK = 30 

104 RED = 31 

105 GREEN = 32 

106 YELLOW = 33 

107 BLUE = 34 

108 MAGENTA = 35 

109 CYAN = 36 

110 WHITE = 37 

111 BRIGHTBLACK = 90 

112 BRIGHTRED = 91 

113 BRIGHTGREEN = 92 

114 BRIGHTYELLOW = 93 

115 BRIGHTBLUE = 94 

116 BRIGHTMAGENTA = 95 

117 BRIGHTCYAN = 96 

118 BRIGHTWHITE = 97 

119 

120 

121Text = AnsiText() 

122Back = AnsiBack() 

123Style = AnsiStyle()