Coverage for rendercv/renderer/renderer.py: 100%

1""" 

2The `rendercv.renderer.renderer` module contains the necessary functions for rendering 

3$\\LaTeX$, PDF, Markdown, HTML, and PNG files from the `RenderCVDataModel` object. 

4""" 

5 

6import importlib.resources (empty)

7import pathlib (empty)

8import re (empty)

9import shutil (empty)

10from typing import Optional (empty)

11 

12import fitz (empty)

13import markdown (empty)

14import rendercv_tinytex (empty)

15 

16from .. import data (empty)

17from . import templater (empty)

18 

19 

20def copy_theme_files_to_output_directory( (empty)

21 theme_name: str, 

22 output_directory_path: pathlib.Path, 

23): 

24 """Copy the auxiliary files (all the files that don't end with `.j2.tex` and `.py`) 

25 of the theme to the output directory. For example, a theme can have custom 

26 fonts, and the $\\LaTeX$ needs it. If the theme is a custom theme, then it will be 

27 copied from the current working directory. 

28 

29 Args: 

30 theme_name: The name of the theme. 

31 output_directory_path: Path to the output directory. 

32 """ 

33 if theme_name in data.available_themes: (empty)

34 theme_directory_path = importlib.resources.files( (empty)

35 f"rendercv.themes.{theme_name}" 

36 ) 

37 else: 

38 # Then it means the theme is a custom theme. If theme_directory is not given 

39 # as an argument, then look for the theme in the current working directory. 

40 theme_directory_path = pathlib.Path.cwd() / theme_name (empty)

41 

42 if not theme_directory_path.is_dir(): (empty)

43 message = ( (empty)

44 f"The theme {theme_name} doesn't exist in the available themes and" 

45 " the current working directory!" 

46 ) 

47 raise FileNotFoundError(message) (empty)

48 

49 for theme_file in theme_directory_path.iterdir(): (empty)

50 dont_copy_files_with_these_extensions = [".j2.tex", ".py"] (empty)

51 # theme_file.suffix returns the latest part of the file name after the last dot. 

52 # But we need the latest part of the file name after the first dot: 

53 try: (empty)

54 suffix = re.search(r"\..*", theme_file.name)[0] # type: ignore (empty)

55 except TypeError: (empty)

56 suffix = "" (empty)

57 

58 if suffix not in dont_copy_files_with_these_extensions: (empty)

59 if theme_file.is_dir(): (empty)

60 shutil.copytree( (empty)

61 str(theme_file), 

62 output_directory_path / theme_file.name, 

63 dirs_exist_ok=True, 

64 ) 

65 else: 

66 shutil.copyfile( (empty)

67 str(theme_file), output_directory_path / theme_file.name 

68 ) 

69 

70 

71def create_a_latex_file( (empty)

72 rendercv_data_model: data.RenderCVDataModel, output_directory: pathlib.Path 

73) -> pathlib.Path: 

74 """Render the $\\LaTeX$ file with the given data model and write it to the output 

75 directory. 

76 

77 Args: 

78 rendercv_data_model: The data model. 

79 output_directory: Path to the output directory. 

80 

81 Returns: 

82 The path to the generated $\\LaTeX$ file. 

83 """ 

84 # Create output directory if it doesn't exist: 

85 if not output_directory.is_dir(): (empty)

86 output_directory.mkdir(parents=True) (empty)

87 

88 jinja2_environment = templater.setup_jinja2_environment() (empty)

89 latex_file_object = templater.LaTeXFile( (empty)

90 rendercv_data_model, 

91 jinja2_environment, 

92 ) 

93 

94 latex_file_name = f"{str(rendercv_data_model.cv.name).replace(' ', '_')}_CV.tex" (empty)

95 latex_file_path = output_directory / latex_file_name (empty)

96 latex_file_object.create_file(latex_file_path) (empty)

97 

98 return latex_file_path (empty)

99 

100 

101def create_a_markdown_file( (empty)

102 rendercv_data_model: data.RenderCVDataModel, output_directory: pathlib.Path 

103) -> pathlib.Path: 

104 """Render the Markdown file with the given data model and write it to the output 

105 directory. 

106 

107 Args: 

108 rendercv_data_model: The data model. 

109 output_directory: Path to the output directory. 

110 

111 Returns: 

112 The path to the rendered Markdown file. 

113 """ 

114 # create output directory if it doesn't exist: 

115 if not output_directory.is_dir(): (empty)

116 output_directory.mkdir(parents=True) (empty)

117 

118 jinja2_environment = templater.setup_jinja2_environment() (empty)

119 markdown_file_object = templater.MarkdownFile( (empty)

120 rendercv_data_model, 

121 jinja2_environment, 

122 ) 

123 

124 markdown_file_name = f"{str(rendercv_data_model.cv.name).replace(' ', '_')}_CV.md" (empty)

125 markdown_file_path = output_directory / markdown_file_name (empty)

126 markdown_file_object.create_file(markdown_file_path) (empty)

127 

128 return markdown_file_path (empty)

129 

130 

131def create_a_latex_file_and_copy_theme_files( (empty)

132 rendercv_data_model: data.RenderCVDataModel, output_directory: pathlib.Path 

133) -> pathlib.Path: 

134 """Render the $\\LaTeX$ file with the given data model in the output directory and 

135 copy the auxiliary theme files to the output directory. 

136 

137 Args: 

138 rendercv_data_model: The data model. 

139 output_directory: Path to the output directory. 

140 

141 Returns: 

142 The path to the rendered $\\LaTeX$ file. 

143 """ 

144 latex_file_path = create_a_latex_file(rendercv_data_model, output_directory) (empty)

145 copy_theme_files_to_output_directory( (empty)

146 rendercv_data_model.design.theme, output_directory 

147 ) 

148 

149 # Copy the profile picture to the output directory, if it exists: 

150 if rendercv_data_model.cv.photo: (empty)

151 shutil.copyfile( (empty)

152 rendercv_data_model.cv.photo, 

153 output_directory / rendercv_data_model.cv.photo.name, 

154 ) 

155 return latex_file_path (empty)

156 

157 

158def render_a_pdf_from_latex( (empty)

159 latex_file_path: pathlib.Path, local_latex_command: Optional[str] = None 

160) -> pathlib.Path: 

161 """Run TinyTeX with the given $\\LaTeX$ file to render the PDF. 

162 

163 Args: 

164 latex_file_path: The path to the $\\LaTeX$ file. 

165 

166 Returns: 

167 The path to the rendered PDF file. 

168 """ 

169 return rendercv_tinytex.run_latex(latex_file_path, local_latex_command) (empty)

170 

171 

172def render_pngs_from_pdf(pdf_file_path: pathlib.Path) -> list[pathlib.Path]: (empty)

173 """Render a PNG file for each page of the given PDF file. 

174 

175 Args: 

176 pdf_file_path: The path to the PDF file. 

177 

178 Returns: 

179 The paths to the rendered PNG files. 

180 """ 

181 # check if the file exists: 

182 if not pdf_file_path.is_file(): (empty)

183 message = f"The file {pdf_file_path} doesn't exist!" (empty)

184 raise FileNotFoundError(message) (empty)

185 

186 # convert the PDF to PNG: 

187 png_directory = pdf_file_path.parent (empty)

188 png_file_name = pdf_file_path.stem (empty)

189 png_files = [] (empty)

190 pdf = fitz.open(pdf_file_path) # open the PDF file (empty)

191 for page in pdf: # iterate the pages (empty)

192 image = page.get_pixmap(dpi=300) # type: ignore (empty)

193 png_file_path = png_directory / f"{png_file_name}_{page.number + 1}.png" # type: ignore (empty)

194 image.save(png_file_path) (empty)

195 png_files.append(png_file_path) (empty)

196 

197 return png_files (empty)

198 

199 

200def render_an_html_from_markdown(markdown_file_path: pathlib.Path) -> pathlib.Path: (empty)

201 """Render an HTML file from a Markdown file with the same name and in the same 

202 directory. It uses `rendercv/themes/main.j2.html` as the Jinja2 template. 

203 

204 Args: 

205 markdown_file_path: The path to the Markdown file. 

206 

207 Returns: 

208 The path to the rendered HTML file. 

209 """ 

210 # check if the file exists: 

211 if not markdown_file_path.is_file(): (empty)

212 message = f"The file {markdown_file_path} doesn't exist!" (empty)

213 raise FileNotFoundError(message) (empty)

214 

215 # Convert the markdown file to HTML: 

216 markdown_text = markdown_file_path.read_text(encoding="utf-8") (empty)

217 html_body = markdown.markdown(markdown_text) (empty)

218 

219 # Get the title of the markdown content: 

220 title = re.search(r"# (.*)\n", markdown_text) (empty)

221 title = title.group(1) if title else None (empty)

222 

223 jinja2_environment = templater.setup_jinja2_environment() (empty)

224 html_template = jinja2_environment.get_template("main.j2.html") (empty)

225 html = html_template.render(html_body=html_body, title=title) (empty)

226 

227 # Write html into a file: 

228 html_file_path = markdown_file_path.parent / f"{markdown_file_path.stem}.html" (empty)

229 html_file_path.write_text(html, encoding="utf-8") (empty)

230 

231 return html_file_path (empty)