Coverage for src / puzzletree / _version.py: 98.18%

1"""Version and debugging utilities.""" 

2 

3from __future__ import annotations (empty)

4 

5import os (empty)

6import platform (empty)

7import sys (empty)

8from dataclasses import dataclass (empty)

9from importlib import metadata (empty)

10 

11from rich.console import Console (empty)

12from rich.layout import Layout (empty)

13from rich.panel import Panel (empty)

14from rich.table import Table (empty)

15from rich.text import Text (empty)

16 

17from puzzletree.utils.theme.theme import set_theme (empty)

18 

19 

20@dataclass (empty)

21class Variable: (empty)

22 """Dataclass describing an environment variable.""" 

23 

24 name: str (empty)

25 """Variable name.""" (empty)

26 value: str (empty)

27 """Variable value.""" (empty)

28 

29 

30@dataclass (empty)

31class Package: (empty)

32 """Dataclass describing a Python package.""" 

33 

34 name: str (empty)

35 """Package name.""" (empty)

36 version: str (empty)

37 """Package version.""" (empty)

38 

39 

40@dataclass (empty)

41class Environment: (empty)

42 """Dataclass to store environment information.""" 

43 

44 interpreter_name: str (empty)

45 """Python interpreter name.""" (empty)

46 interpreter_version: str (empty)

47 """Python interpreter version.""" (empty)

48 interpreter_path: str (empty)

49 """Path to Python executable.""" (empty)

50 platform: str (empty)

51 """Operating System.""" (empty)

52 packages: list[Package] (empty)

53 """Installed packages.""" (empty)

54 variables: list[Variable] (empty)

55 """Environment variables.""" (empty)

56 

57 

58def _interpreter_name_version() -> tuple[str, str]: (empty)

59 if hasattr(sys, "implementation"): (empty)

60 impl = sys.implementation.version (empty)

61 version = f"{impl.major}.{impl.minor}.{impl.micro}" (empty)

62 kind = impl.releaselevel (empty)

63 if kind != "final": (empty)

64 version += kind[0] + str(impl.serial) (empty)

65 return sys.implementation.name, version (empty)

66 return "", "0.0.0" (empty)

67 

68 

69def get_version(dist: str = "puzzletree") -> str: (empty)

70 """Get version of the given distribution. 

71 

72 Parameters: 

73 dist: A distribution name. 

74 

75 Returns: 

76 A version number. 

77 """ 

78 if not dist: (empty)

79 raise ValueError("Distribution name cannot be empty or None") (empty)

80 try: (empty)

81 return metadata.version(dist) (empty)

82 except metadata.PackageNotFoundError: (empty)

83 return "0.0.0" (empty)

84 

85 

86def version_info() -> Text: (empty)

87 """Get version information. 

88 

89 Returns: 

90 Version information. 

91 """ 

92 version = get_version() (empty)

93 return Text.assemble(("puzzletree: ", "peach"), (f"{version}", "bold")) (empty)

94 

95 

96def get_debug_info() -> Environment: (empty)

97 """Get debug/environment information. 

98 

99 Returns: 

100 Environment information. 

101 """ 

102 py_name, py_version = _interpreter_name_version() (empty)

103 packages = ["puzzletree"] (empty)

104 variables = list( (empty)

105 dict.fromkeys( 

106 [ 

107 "PYTHONPATH", 

108 *[var for var in os.environ if var.lower().startswith("puzzletree")], 

109 ], 

110 ), 

111 ) 

112 return Environment( (empty)

113 interpreter_name=py_name, 

114 interpreter_version=py_version, 

115 interpreter_path=sys.executable, 

116 platform=platform.platform(), 

117 variables=[Variable(var, val) for var in variables if (val := os.getenv(var))], 

118 packages=[Package(pkg, get_version(pkg)) for pkg in packages], 

119 ) 

120 

121 

122def _make_debug_layout(env: Environment) -> Layout: (empty)

123 """Build a Layout for debug info: header + packages | env vars.""" 

124 header_text = Text( (empty)

125 f"{env.interpreter_name} {env.interpreter_version} | {env.interpreter_path} | {env.platform}", 

126 style="bold", 

127 ) 

128 header = Panel(header_text, title="Debug Info", title_align="left", border_style="bright_blue") (empty)

129 

130 packages_table = Table(highlight=True, box=None, show_header=True, title=f"Packages ({len(env.packages)})") (empty)

131 packages_table.add_column("Package", style="rosewater") (empty)

132 packages_table.add_column("Version", style="bold") (empty)

133 for pkg in env.packages: (empty)

134 packages_table.add_row(pkg.name, pkg.version) (empty)

135 

136 env_table = Table(highlight=True, box=None, show_header=True, title="Environment Variables") (empty)

137 env_table.add_column("Variable", style="rosewater") (empty)

138 env_table.add_column("Value", style="bold") (empty)

139 for var in env.variables: 139 ↛ 140line 139 didn't jump to line 140 because the loop on line 139 never started(empty)

140 env_table.add_row(var.name, var.value) 

141 

142 layout = Layout() (empty)

143 layout.split_column( (empty)

144 Layout(header, name="header", size=5), 

145 Layout(name="main", ratio=1), 

146 ) 

147 layout["main"].split_row( (empty)

148 Layout(Panel(packages_table, border_style="bright_blue"), name="packages", ratio=1), 

149 Layout(Panel(env_table, border_style="bright_blue"), name="vars", ratio=1, minimum_size=30), 

150 ) 

151 return layout (empty)

152 

153 

154def _make_debug_panel(env: Environment) -> Panel: (empty)

155 """Build a single Panel for debug info (fallback for narrow terminals).""" 

156 table = Table(highlight=True, box=None, show_header=False) (empty)

157 table.add_row( (empty)

158 Text("Interpreter Name", style="rosewater"), 

159 Text(env.interpreter_name, style="bold"), 

160 ) 

161 table.add_row( (empty)

162 Text("Interpreter Version", style="rosewater"), 

163 Text(env.interpreter_version, style="bold"), 

164 ) 

165 table.add_row( (empty)

166 Text("Interpreter Path", style="rosewater"), 

167 Text(env.interpreter_path, style="bold"), 

168 ) 

169 table.add_row(Text("Platform", style="rosewater"), Text(env.platform, style="bold")) (empty)

170 table.add_row( (empty)

171 Text(f"Packages ({len(env.packages)})", style="rosewater"), 

172 Text.assemble(*[Text(str(pkg), style="bold") for pkg in env.packages]), 

173 ) 

174 table.add_row( (empty)

175 Text("Environment Variables", style="rosewater"), 

176 Text.assemble(*[Text(str(var), style="bold") for var in env.variables]), 

177 ) 

178 return Panel(table, title="Debug Information", title_align="left") (empty)

179 

180 

181def debug_info(console: Console | None = None) -> None: (empty)

182 """Return debug information.""" 

183 if not console: (empty)

184 console = Console(theme=set_theme()) (empty)

185 

186 env = get_debug_info() (empty)

187 from puzzletree.cli.messages.layout import use_layout # noqa: PLC0415 - deferred to avoid circular import (empty)

188 

189 if use_layout(console): (empty)

190 console.print(_make_debug_layout(env)) (empty)

191 else: 

192 console.print(_make_debug_panel(env)) (empty)