Coverage for src / rendercv / cli / render_command / progress_panel.py: 97%

1import pathlib (empty)

2from dataclasses import dataclass (empty)

3 

4import rich.box (empty)

5import rich.console (empty)

6import rich.live (empty)

7import rich.panel (empty)

8import rich.table (empty)

9import typer (empty)

10 

11from rendercv.exception import RenderCVUserError, RenderCVValidationError (empty)

12 

13 

14def format_validation_error_location(error_object: RenderCVValidationError) -> str: (empty)

15 """Format schema/YAML location for validation error table rows. 

16 

17 Why: 

18 YAML parsing errors don't have schema locations, so we show source file 

19 and line/column coordinates to keep the location column actionable. 

20 

21 Args: 

22 error_object: Validation error with schema and YAML location metadata. 

23 

24 Returns: 

25 Human-readable location string for table display. 

26 """ 

27 if error_object.schema_location is not None: (empty)

28 return ".".join(error_object.schema_location) (empty)

29 

30 if error_object.yaml_location is None: (empty)

31 return error_object.yaml_source (empty)

32 

33 (start_line, _), (end_line, _) = error_object.yaml_location (empty)

34 if start_line == end_line: (empty)

35 return f"{error_object.yaml_source}: line {start_line}" (empty)

36 return f"{error_object.yaml_source}: line {start_line} to line {end_line}" (empty)

37 

38 

39class ProgressPanel(rich.live.Live): (empty)

40 """Live-updating terminal panel showing CV generation progress with timing. 

41 

42 Example: 

43 ```py 

44 with ProgressPanel(quiet=False) as progress: 

45 progress.update_progress("50", "Generated PDF", [Path("cv.pdf")]) 

46 progress.finish_progress() 

47 # Displays: ✓ 50 ms Generated PDF: ./cv.pdf 

48 ``` 

49 

50 Args: 

51 quiet: Suppress all terminal output. 

52 """ 

53 

54 def __init__(self, quiet: bool = False): (empty)

55 self.completed_steps: list[CompletedStep] = [] (empty)

56 super().__init__( (empty)

57 rich.panel.Panel( 

58 "...", 

59 title="Rendering your CV...", 

60 title_align="left", 

61 border_style="bright_black", 

62 ), 

63 console=rich.console.Console(quiet=quiet), 

64 refresh_per_second=4, 

65 ) 

66 

67 def update_progress( (empty)

68 self, time_took: str, message: str, paths: list[pathlib.Path] 

69 ) -> None: 

70 """Add completed step to progress display. 

71 

72 Args: 

73 time_took: Execution time in milliseconds as string. 

74 message: Step description. 

75 paths: Generated file paths to display. 

76 """ 

77 self.completed_steps.append(CompletedStep(time_took, message, paths)) (empty)

78 self.print_progress_panel(title="Rendering your CV...") (empty)

79 

80 def finish_progress(self) -> None: (empty)

81 """Display final success panel and clear state.""" 

82 self.print_progress_panel(title="Your CV is ready") (empty)

83 self.completed_steps.clear() (empty)

84 

85 def print_progress_panel(self, title: str) -> None: (empty)

86 """Render progress panel with all completed steps. 

87 

88 Args: 

89 title: Panel title text. 

90 """ 

91 lines: list[str] = [] (empty)

92 for step in self.completed_steps: (empty)

93 paths_str = "" (empty)

94 if step.paths: (empty)

95 try: (empty)

96 paths = [ (empty)

97 path.relative_to(pathlib.Path.cwd()) for path in step.paths 

98 ] 

99 except ValueError: 

100 paths = step.paths 

101 paths_as_strings = [f"./{path}" for path in paths] (empty)

102 paths_str = "; ".join(paths_as_strings) (empty)

103 

104 timing = f"[bold green]{step.timing_ms + ' ms':<8}[/bold green]" (empty)

105 message = step.message + (": " if paths_str else ".") (empty)

106 paths_display = f"[purple]{paths_str}[/purple]" if paths_str else "" (empty)

107 lines.append(f"[green]✓[/green] {timing} {message:<26} {paths_display}") (empty)

108 

109 content = "\n".join(lines) if lines else "Rendering..." (empty)

110 

111 self.update( (empty)

112 rich.panel.Panel( 

113 content, 

114 title=title, 

115 title_align="left", 

116 border_style="bright_black", 

117 ) 

118 ) 

119 

120 def print_user_error(self, user_error: RenderCVUserError) -> None: (empty)

121 """Display error panel and exit with error code. 

122 

123 Args: 

124 user_error: User-facing error to display. 

125 """ 

126 self.clear() (empty)

127 self.update( (empty)

128 rich.panel.Panel( 

129 user_error.message or "An unknown error occurred.", 

130 title="[bold red]Error[/bold red]", 

131 title_align="left", 

132 border_style="bold red", 

133 ) 

134 ) 

135 raise typer.Exit(code=1) (empty)

136 

137 def print_validation_errors(self, errors: list[RenderCVValidationError]) -> None: (empty)

138 """Display validation errors in table format and exit. 

139 

140 Why: 

141 Pydantic validation errors are parsed into user-friendly messages with 

142 YAML locations. Table shows exactly which field failed and why. 

143 

144 Args: 

145 errors: List of validation errors with location, input, and message. 

146 """ 

147 self.completed_steps.clear() (empty)

148 table = rich.table.Table(expand=True, show_lines=True, box=rich.box.ROUNDED) (empty)

149 table.add_column("Location", style="cyan", no_wrap=True) (empty)

150 table.add_column("Input Value", style="magenta", no_wrap=True) (empty)

151 table.add_column("Explanation", style="orange4") (empty)

152 

153 for error_object in errors: (empty)

154 table.add_row( (empty)

155 format_validation_error_location(error_object), 

156 error_object.input, 

157 error_object.message, 

158 ) 

159 

160 self.update( (empty)

161 rich.panel.Panel( 

162 table, 

163 title="[bold red]There are validation errors![/bold red]", 

164 title_align="left", 

165 border_style="bold red", 

166 ) 

167 ) 

168 

169 raise typer.Exit(code=1) (empty)

170 

171 def clear(self) -> None: (empty)

172 """Clear all completed steps and panel display.""" 

173 self.completed_steps.clear() (empty)

174 self.update("") (empty)

175 

176 

177@dataclass (empty)

178class CompletedStep: (empty)

179 timing_ms: str (empty)

180 message: str (empty)

181 paths: list[pathlib.Path] (empty)