Coverage for liitos/meta.py: 87.29%

1"""Weave the content of the meta file(s) of metadata.tex.in into the output metadata.tex.""" 

2 

3import datetime as dti 

4import os 

5import pathlib 

6from typing import Union, no_type_check 

7 

8import yaml 

9 

10import liitos.gather as gat 

11import liitos.template as tpl 

12import liitos.tools as too 

13from liitos import ENCODING, LOG_SEPARATOR, log 

14 

15METADATA_TEMPLATE = os.getenv('LIITOS_METADATA_TEMPLATE', '') 

16METADATA_TEMPLATE_IS_EXTERNAL = bool(METADATA_TEMPLATE) 

17if not METADATA_TEMPLATE: 17 ↛ 20line 17 didn't jump to line 20, because the condition on line 17 was never false

18 METADATA_TEMPLATE = 'templates/metadata.tex.in' 

19 

20METADATA_PATH = pathlib.Path('metadata.tex') 

21 

22SETUP_TEMPLATE = os.getenv('LIITOS_SETUP_TEMPLATE', '') 

23SETUP_TEMPLATE_IS_EXTERNAL = bool(SETUP_TEMPLATE) 

24if not SETUP_TEMPLATE: 24 ↛ 27line 24 didn't jump to line 27, because the condition on line 24 was never false

25 SETUP_TEMPLATE = 'templates/setup.tex.in' 

26 

27SETUP_PATH = pathlib.Path('setup.tex') 

28 

29DRIVER_TEMPLATE = os.getenv('LIITOS_DRIVER_TEMPLATE', '') 

30DRIVER_TEMPLATE_IS_EXTERNAL = bool(DRIVER_TEMPLATE) 

31if not DRIVER_TEMPLATE: 31 ↛ 34line 31 didn't jump to line 34, because the condition on line 31 was never false

32 DRIVER_TEMPLATE = 'templates/driver.tex.in' 

33 

34DRIVER_PATH = pathlib.Path('driver.tex') 

35 

36VALUE_SLOT = 'VALUE.SLOT' 

37DOC_BASE = pathlib.Path('..', '..') 

38STRUCTURE_PATH = DOC_BASE / 'structure.yml' 

39MAGIC_OF_TODAY = 'PUBLICATIONDATE' 

40 

41WEAVE_DEFAULTS = { 

42 'font_path': '/opt/fonts/', 

43 'font_suffix': '.otf', 

44 'bold_font': 'ITCFranklinGothicStd-Demi', 

45 'italic_font': 'ITCFranklinGothicStd-BookIt', 

46 'bold_italic_font': 'ITCFranklinGothicStd-DemiIt', 

47 'main_font': 'ITCFranklinGothicStd-Book', 

48 'fixed_font_package': 'sourcecodepro', 

49 'code_fontsize': r'\scriptsize', 

50 'chosen_logo': '/opt/logo/liitos-logo.png', 

51 'footer_frame_note': os.getenv('LIITOS_FOOTER_FRAME_NOTE', ' '), # TODO 

52 'footer_outer_field_normal_pages': r'\theMetaPageNumPrefix { } \thepage { }', 

53 'approvals_adjustable_vertical_space': '2.5em', 

54 'change_log_tune_header_sep': '-0em', 

55 'proprietary_information': '/opt/legal/proprietary-information.txt', 

56 'proprietary_information_adjustable_vertical_space': '-0em', 

57 'proprietary_information_tune_header_sep': '-0em', 

58} 

59ACROSS = { 

60 'eff_font_folder': '', 

61 'eff_font_suffix': '', 

62} 

63 

64 

65@no_type_check 

66def process_meta(aspects: dict[str, str]) -> Union[gat.Meta, int]: 

67 """TODO.""" 

68 meta_path = DOC_BASE / aspects[gat.KEY_META] 

69 if not meta_path.is_file() or not meta_path.stat().st_size: 69 ↛ 70line 69 didn't jump to line 70, because the condition on line 69 was never true

70 log.error(f'destructure failed to find non-empty meta file at {meta_path}') 

71 return 1 

72 if meta_path.suffix.lower() not in ('.yaml', '.yml'): 72 ↛ 73line 72 didn't jump to line 73, because the condition on line 72 was never true

73 return 1 

74 with open(meta_path, 'rt', encoding=ENCODING) as handle: 

75 metadata = yaml.safe_load(handle) 

76 if not metadata: 76 ↛ 77line 76 didn't jump to line 77, because the condition on line 76 was never true

77 log.error(f'empty metadata file? Please add metadata to ({meta_path})') 

78 return 1 

79 if 'import' in metadata['document']: 79 ↛ 92line 79 didn't jump to line 92, because the condition on line 79 was never false

80 base_meta_path = DOC_BASE / metadata['document']['import'] 

81 if not base_meta_path.is_file() or not base_meta_path.stat().st_size: 81 ↛ 82line 81 didn't jump to line 82, because the condition on line 81 was never true

82 log.error( 

83 f'metadata declares import of base data from ({base_meta_path.name})' 

84 f' but failed to find non-empty base file at {base_meta_path}' 

85 ) 

86 return 1 

87 with open(base_meta_path, 'rt', encoding=ENCODING) as handle: 

88 base_data = yaml.safe_load(handle) 

89 for key, value in metadata['document']['patch'].items(): 

90 base_data['document']['common'][key] = value 

91 metadata = base_data 

92 with open('metadata.yml', 'wt', encoding=ENCODING) as handle: 

93 yaml.dump(metadata, handle, default_flow_style=False) 

94 return metadata 

95 

96 

97@no_type_check 

98def weave_setup_font_path( 

99 mapper: dict[str, Union[str, int, bool, None]], 

100 text: str, 

101) -> str: 

102 """Weave in the xxxx from mapper or default for driver. 

103 

104 Trigger is text.rstrip().endswith('%%_PATCH_%_FONT_%_PATH_%%') 

105 """ 

106 defaults = {**WEAVE_DEFAULTS} 

107 if mapper.get('font_path'): 

108 font_path = mapper.get('font_path') 

109 if not pathlib.Path(font_path).is_dir(): 109 ↛ 110line 109 didn't jump to line 110, because the condition on line 109 was never true

110 log.warning(f'font_path ({font_path}) is no directory on this system - rendering may not work as intended') 

111 ACROSS['eff_font_folder'] = font_path 

112 return text.replace(VALUE_SLOT, font_path) 

113 else: 

114 log.warning(f'font_path value missing ... setting default ({defaults["font_path"]})') 

115 ACROSS['eff_font_folder'] = defaults['font_path'] 

116 return text.replace(VALUE_SLOT, defaults['font_path']) 

117 

118 

119@no_type_check 

120def weave_setup_font_suffix( 

121 mapper: dict[str, Union[str, int, bool, None]], 

122 text: str, 

123) -> str: 

124 """Weave in the font_suffix from mapper or default for driver. 

125 

126 Trigger is text.rstrip().endswith('%%_PATCH_%_FONT_%_SUFFIX_%%') 

127 """ 

128 defaults = {**WEAVE_DEFAULTS} 

129 if mapper.get('font_suffix'): 

130 font_suffix = mapper.get('font_suffix') 

131 if font_suffix not in ('.otf', '.ttf'): 131 ↛ 132line 131 didn't jump to line 132, because the condition on line 131 was never true

132 log.warning(f'font_suffix ({font_suffix}) is unexpected - rendering may not work as intended') 

133 ACROSS['eff_font_suffix'] = font_suffix 

134 return text.replace(VALUE_SLOT, font_suffix) 

135 else: 

136 log.warning(f'font_suffix value missing ... setting default ({defaults["font_suffix"]})') 

137 ACROSS['eff_font_suffix'] = defaults['font_suffix'] 

138 return text.replace(VALUE_SLOT, defaults['font_suffix']) 

139 

140 

141@no_type_check 

142def weave_setup_bold_font( 

143 mapper: dict[str, Union[str, int, bool, None]], 

144 text: str, 

145) -> str: 

146 """Weave in the bold_font from mapper or default for driver. 

147 

148 Trigger is text.rstrip().endswith('%%_PATCH_%_BOLD_%_FONT_%%') 

149 """ 

150 defaults = {**WEAVE_DEFAULTS} 

151 eff_font_folder = ACROSS['eff_font_folder'] 

152 eff_font_suffix = ACROSS['eff_font_suffix'] 

153 if mapper.get('bold_font'): 

154 bold_font = mapper.get('bold_font') 

155 font_path = pathlib.Path(eff_font_folder) / f'{bold_font}{eff_font_suffix}' 

156 if not font_path.is_file(): 156 ↛ 157line 156 didn't jump to line 157, because the condition on line 156 was never true

157 log.warning( 

158 f'bold_font ({bold_font}) is not found' 

159 f' as ({font_path}) on this system - rendering may not work as intended' 

160 ) 

161 return text.replace(VALUE_SLOT, bold_font) 

162 else: 

163 log.warning(f'bold_font value missing ... setting default ({defaults["bold_font"]})') 

164 return text.replace(VALUE_SLOT, defaults['bold_font']) 

165 

166 

167@no_type_check 

168def weave_setup_italic_font( 

169 mapper: dict[str, Union[str, int, bool, None]], 

170 text: str, 

171) -> str: 

172 """Weave in the italic_font from mapper or default for driver. 

173 

174 Trigger is text.rstrip().endswith('%%_PATCH_%_ITALIC_%_FONT_%%') 

175 """ 

176 defaults = {**WEAVE_DEFAULTS} 

177 eff_font_folder = ACROSS['eff_font_folder'] 

178 eff_font_suffix = ACROSS['eff_font_suffix'] 

179 if mapper.get('italic_font'): 

180 italic_font = mapper.get('italic_font') 

181 font_path = pathlib.Path(eff_font_folder) / f'{italic_font}{eff_font_suffix}' 

182 if not font_path.is_file(): 182 ↛ 183line 182 didn't jump to line 183, because the condition on line 182 was never true

183 log.warning( 

184 f'italic_font ({italic_font}) is not found' 

185 f' as ({font_path}) on this system - rendering may not work as intended' 

186 ) 

187 return text.replace(VALUE_SLOT, italic_font) 

188 else: 

189 log.warning(f'italic_font value missing ... setting default ({defaults["italic_font"]})') 

190 return text.replace(VALUE_SLOT, defaults['italic_font']) 

191 

192 

193@no_type_check 

194def weave_setup_bold_italic_font( 

195 mapper: dict[str, Union[str, int, bool, None]], 

196 text: str, 

197) -> str: 

198 """Weave in the bold_italic_font from mapper or default for driver. 

199 

200 Trigger is text.rstrip().endswith('%%_PATCH_%_BOLDITALIC_%_FONT_%%') 

201 """ 

202 defaults = {**WEAVE_DEFAULTS} 

203 eff_font_folder = ACROSS['eff_font_folder'] 

204 eff_font_suffix = ACROSS['eff_font_suffix'] 

205 if mapper.get('bold_italic_font'): 

206 bold_italic_font = mapper.get('bold_italic_font') 

207 font_path = pathlib.Path(eff_font_folder) / f'{bold_italic_font}{eff_font_suffix}' 

208 if not font_path.is_file(): 208 ↛ 209line 208 didn't jump to line 209, because the condition on line 208 was never true

209 log.warning( 

210 f'bold_italic_font ({bold_italic_font}) is not found' 

211 f' as ({font_path}) on this system - rendering may not work as intended' 

212 ) 

213 return text.replace(VALUE_SLOT, bold_italic_font) 

214 else: 

215 log.warning(f'bold_italic_font value missing ... setting default ({defaults["bold_italic_font"]})') 

216 return text.replace(VALUE_SLOT, defaults['bold_italic_font']) 

217 

218 

219@no_type_check 

220def weave_setup_main_font( 

221 mapper: dict[str, Union[str, int, bool, None]], 

222 text: str, 

223) -> str: 

224 """Weave in the main_font from mapper or default for driver. 

225 

226 Trigger is text.rstrip().endswith('%%_PATCH_%_MAIN_%_FONT_%%') 

227 """ 

228 defaults = {**WEAVE_DEFAULTS} 

229 eff_font_folder = ACROSS['eff_font_folder'] 

230 eff_font_suffix = ACROSS['eff_font_suffix'] 

231 if mapper.get('main_font'): 

232 main_font = mapper.get('main_font') 

233 font_path = pathlib.Path(eff_font_folder) / f'{main_font}{eff_font_suffix}' 

234 if not font_path.is_file(): 234 ↛ 235line 234 didn't jump to line 235, because the condition on line 234 was never true

235 log.warning( 

236 f'main_font ({main_font}) is not found' 

237 f' as ({font_path}) on this system - rendering may not work as intended' 

238 ) 

239 return text.replace(VALUE_SLOT, main_font) 

240 else: 

241 log.warning(f'main_font value missing ... setting default ({defaults["main_font"]})') 

242 return text.replace(VALUE_SLOT, defaults['main_font']) 

243 

244 

245@no_type_check 

246def weave_setup_fixed_font_package( 

247 mapper: dict[str, Union[str, int, bool, None]], 

248 text: str, 

249) -> str: 

250 """Weave in the fixed_font_package from mapper or default for driver. 

251 

252 Trigger is text.rstrip().endswith('%%_PATCH_%_FIXED_%_FONT_%_PACKAGE_%%') 

253 """ 

254 defaults = {**WEAVE_DEFAULTS} 

255 if mapper.get('fixed_font_package'): 

256 fixed_font_package = mapper.get('fixed_font_package') 

257 if fixed_font_package != defaults['fixed_font_package']: 257 ↛ 258line 257 didn't jump to line 258, because the condition on line 257 was never true

258 log.warning( 

259 f'fixed_font_package ({fixed_font_package}) has not' 

260 ' been tested on this system - rendering may not work as intended' 

261 ) 

262 return text.replace(VALUE_SLOT, fixed_font_package) 

263 else: 

264 log.warning(f'fixed_font_package value missing ... setting default ({defaults["fixed_font_package"]})') 

265 return text.replace(VALUE_SLOT, defaults['fixed_font_package']) 

266 

267 

268@no_type_check 

269def weave_setup_code_fontsize( 

270 mapper: dict[str, Union[str, int, bool, None]], 

271 text: str, 

272) -> str: 

273 """Weave in the code_fontsize from mapper or default for driver. 

274 

275 Trigger is text.rstrip().endswith('%%_PATCH_%_CODE_%_FONTSIZE_%%') 

276 """ 

277 defaults = {**WEAVE_DEFAULTS} 

278 if mapper.get('code_fontsize'): 

279 code_fontsize = mapper.get('code_fontsize') 

280 valid_code_font_sizes = ( 

281 r'\Huge', 

282 r'\huge', 

283 r'\LARGE', 

284 r'\Large', 

285 r'\large', 

286 r'\normalsize', 

287 r'\small', 

288 r'\footnotesize', 

289 r'\scriptsize', 

290 r'\tiny', 

291 ) 

292 bs = '\\' 

293 sizes = tuple(size[1:] for size in valid_code_font_sizes) 

294 if code_fontsize.startswith(r'\\'): 294 ↛ 295line 294 didn't jump to line 295, because the condition on line 294 was never true

295 code_fontsize = code_fontsize[1:] 

296 if code_fontsize not in valid_code_font_sizes: 296 ↛ 297line 296 didn't jump to line 297, because the condition on line 296 was never true

297 log.error( 

298 f'code_fontsize ({code_fontsize}) is not a valid font size value' 

299 ' - rendering would not work as intended' 

300 ) 

301 log.info(f'valid values for code_fontsize must be in {bs}{(", " + bs).join(sizes)}') 

302 log.warning( 

303 f'overriding code font size value with the (working) default of ({defaults["code_fontsize"]})' 

304 f' - in config that would be {defaults["code_fontsize"]}' 

305 ) 

306 return text.replace(VALUE_SLOT, defaults['code_fontsize']) 

307 else: 

308 return text.replace(VALUE_SLOT, code_fontsize) 

309 else: 

310 log.info( 

311 f'code_fontsize value missing ... setting default ({defaults["code_fontsize"]})' 

312 f' - in config that would be {defaults["code_fontsize"]}' 

313 ) 

314 return text.replace(VALUE_SLOT, defaults['code_fontsize']) 

315 

316 

317@no_type_check 

318def weave_setup_chosen_logo( 

319 mapper: dict[str, Union[str, int, bool, None]], 

320 text: str, 

321) -> str: 

322 """Weave in the chosen_logo from mapper or default for driver. 

323 

324 Trigger is text.rstrip().endswith('%%_PATCH_%_CHOSEN_%_LOGO_%%') 

325 """ 

326 defaults = {**WEAVE_DEFAULTS} 

327 if mapper.get('chosen_logo'): 

328 chosen_logo = mapper.get('chosen_logo') 

329 logo_path = pathlib.Path(chosen_logo) 

330 if not logo_path.is_file(): 330 ↛ 331line 330 didn't jump to line 331, because the condition on line 330 was never true

331 log.warning( 

332 f'chosen_logo ({chosen_logo}) is not found' 

333 f' as ({logo_path}) on this system - rendering may not work as intended' 

334 ) 

335 return text.replace(VALUE_SLOT, chosen_logo) 

336 else: 

337 log.info(f'chosen_logo value missing ... setting default ({defaults["chosen_logo"]})') 

338 return text.replace(VALUE_SLOT, defaults['chosen_logo']) 

339 

340 

341@no_type_check 

342def weave_setup_footer_outer_field_normal_pages( 

343 mapper: dict[str, Union[str, int, bool, None]], 

344 text: str, 

345) -> str: 

346 """Weave in the footer_outer_field_normal_pages from mapper or default for driver. 

347 

348 Trigger is text.rstrip().endswith('%%_PATCH_%_NORMAL_%_PAGES_%_OUTER_%_FOOT_%_CONTENT_%_VALUE_%%') 

349 """ 

350 defaults = {**WEAVE_DEFAULTS} 

351 if mapper.get('footer_outer_field_normal_pages'): 351 ↛ 355line 351 didn't jump to line 355, because the condition on line 351 was never false

352 footer_outer_field_normal_pages = mapper.get('footer_outer_field_normal_pages') 

353 return text.replace(VALUE_SLOT, footer_outer_field_normal_pages) 

354 else: 

355 log.info( 

356 'footer_outer_field_normal_pages value missing ...' 

357 f' setting default ({defaults["footer_outer_field_normal_pages"]})' 

358 ) 

359 return text.replace(VALUE_SLOT, defaults['footer_outer_field_normal_pages']) 

360 

361 

362@no_type_check 

363def dispatch_setup_weaver( 

364 mapper: dict[str, Union[str, int, bool, None]], 

365 text: str, 

366) -> str: 

367 """Dispatch the driver weaver by mapping to handled groups per source marker.""" 

368 dispatch = { 

369 '%%_PATCH_%_FONT_%_PATH_%%': weave_setup_font_path, 

370 '%%_PATCH_%_FONT_%_SUFFIX_%%': weave_setup_font_suffix, 

371 '%%_PATCH_%_BOLD_%_FONT_%%': weave_setup_bold_font, 

372 '%%_PATCH_%_ITALIC_%_FONT_%%': weave_setup_italic_font, 

373 '%%_PATCH_%_BOLDITALIC_%_FONT_%%': weave_setup_bold_italic_font, 

374 '%%_PATCH_%_MAIN_%_FONT_%%': weave_setup_main_font, 

375 '%%_PATCH_%_FIXED_%_FONT_%_PACKAGE_%%': weave_setup_fixed_font_package, 

376 '%%_PATCH_%_CODE_%_FONTSIZE_%%': weave_setup_code_fontsize, 

377 '%%_PATCH_%_CHOSEN_%_LOGO_%%': weave_setup_chosen_logo, 

378 '%%_PATCH_%_NORMAL_%_PAGES_%_OUTER_%_FOOT_%_CONTENT_%_VALUE_%%': weave_setup_footer_outer_field_normal_pages, 

379 } 

380 for trigger, weaver in dispatch.items(): 

381 if text.rstrip().endswith(trigger): 

382 return weaver(mapper, text) 

383 return text 

384 

385 

386@no_type_check 

387def weave_meta_setup(meta_map: gat.Meta, latex: list[str]) -> list[str]: 

388 """TODO.""" 

389 log.info('weaving in the meta data per setup.tex.in into setup.tex ...') 

390 completed = [dispatch_setup_weaver(meta_map['document']['common'], line) for line in latex] 

391 if completed and completed[-1]: 

392 completed.append('\n') 

393 return completed 

394 

395 

396@no_type_check 

397def weave_driver_toc_level( 

398 mapper: dict[str, Union[str, int, bool, None]], 

399 text: str, 

400) -> str: 

401 """Weave in the toc_level from mapper or default for driver. 

402 

403 Trigger is text.rstrip().endswith('%%_PATCH_%_TOC_%_LEVEL_%%') 

404 """ 

405 toc_level = 2 

406 if mapper.get('toc_level'): 

407 try: 

408 toc_level_read = int(mapper['toc_level']) 

409 toc_level = toc_level_read if 0 < toc_level_read < 5 else 2 

410 if toc_level != toc_level_read: 

411 log.warning( 

412 f'ignored toc level ({toc_level_read}) set to default (2) - expected value 0 < toc_level < 5' 

413 ) 

414 except ValueError as err: 

415 toc_level = 2 

416 log.warning(f'toc_level ({mapper["toc_level"]}) not in (1, 2, 3, 4) - resorting to default ({toc_level})') 

417 log.error(f'error detail: {err}') 

418 else: 

419 log.info(f'toc_level value missing ... setting default ({toc_level})') 

420 return text.replace(VALUE_SLOT, str(toc_level)) 

421 

422 

423@no_type_check 

424def weave_driver_list_of_figures( 

425 mapper: dict[str, Union[str, int, bool, None]], 

426 text: str, 

427) -> str: 

428 """Weave in the list_of_figures from mapper or default for driver. 

429 

430 Trigger is text.rstrip().endswith('%%_PATCH_%_LOF_%%') 

431 """ 

432 if mapper.get('list_of_figures', None) is not None: 

433 lof = mapper['list_of_figures'] 

434 if lof in ('', '%'): 

435 return text.replace(VALUE_SLOT, str(lof)) 

436 else: 

437 lof = '%' 

438 log.warning( 

439 f"list_of_figures ({mapper['list_of_figures']}) not in ('', '%')" 

440 f' - resorting to default ({lof}) i.e. commenting out the list of figures' 

441 ) 

442 else: 

443 log.info('list_of_figures value missing ... setting default (comment out the lof per %)') 

444 

445 return text.replace(VALUE_SLOT, '%') 

446 

447 

448@no_type_check 

449def weave_driver_list_of_tables( 

450 mapper: dict[str, Union[str, int, bool, None]], 

451 text: str, 

452) -> str: 

453 """Weave in the list_of_tables from mapper or default for driver. 

454 

455 Trigger is text.rstrip().endswith('%%_PATCH_%_LOT_%%') 

456 """ 

457 if mapper.get('list_of_tables', None) is not None: 

458 lof = mapper['list_of_tables'] 

459 if lof in ('', '%'): 

460 return text.replace(VALUE_SLOT, str(lof)) 

461 else: 

462 lof = '%' 

463 log.warning( 

464 f"list_of_tables ({mapper['list_of_tables']}) not in ('', '%')" 

465 f' - resorting to default ({lof}) i.e. commenting out the list of tables' 

466 ) 

467 else: 

468 log.info('list_of_tables value missing ... setting default (comment out the lot per %)') 

469 

470 return text.replace(VALUE_SLOT, '%') 

471 

472 

473@no_type_check 

474def dispatch_driver_weaver( 

475 mapper: dict[str, Union[str, int, bool, None]], 

476 text: str, 

477) -> str: 

478 """Dispatch the driver weaver by mapping to handled groups per source marker.""" 

479 dispatch = { 

480 '%%_PATCH_%_TOC_%_LEVEL_%%': weave_driver_toc_level, 

481 '%%_PATCH_%_LOF_%%': weave_driver_list_of_figures, 

482 '%%_PATCH_%_LOT_%%': weave_driver_list_of_tables, 

483 } 

484 for trigger, weaver in dispatch.items(): 

485 if text.rstrip().endswith(trigger): 

486 return weaver(mapper, text) 

487 return text 

488 

489 

490@no_type_check 

491def weave_meta_driver(meta_map: gat.Meta, latex: list[str]) -> list[str]: 

492 """TODO.""" 

493 log.info('weaving in the meta data per driver.tex.in into driver.tex ...') 

494 completed = [dispatch_driver_weaver(meta_map['document']['common'], line) for line in latex] 

495 if completed and completed[-1]: 

496 completed.append('\n') 

497 return completed 

498 

499 

500@no_type_check 

501def weave_meta_part_header_title( 

502 mapper: dict[str, Union[str, int, bool, None]], 

503 text: str, 

504) -> str: 

505 """Weave in the header_title from mapper or default. 

506 

507 Trigger is text.rstrip().endswith('%%_PATCH_%_HEADER_%_TITLE_%%') 

508 """ 

509 if mapper.get('header_title'): 

510 return text.replace(VALUE_SLOT, mapper['header_title']) 

511 else: 

512 log.info('header_title value missing ... setting default (the title value)') 

513 return text.replace(VALUE_SLOT, mapper['title']) 

514 

515 

516@no_type_check 

517def weave_meta_part_title_slug( 

518 mapper: dict[str, Union[str, int, bool, None]], 

519 text: str, 

520) -> str: 

521 """Weave in the title slug deriving from mapper or default. 

522 

523 Trigger is text.rstrip().endswith('%%_PATCH_%_MAIN_%_TITLE_%_SLUG_%%') 

524 """ 

525 if mapper.get('bookmark_title'): 525 ↛ 526line 525 didn't jump to line 526, because the condition on line 525 was never true

526 return text.replace(VALUE_SLOT, mapper['bookmark_title']) 

527 else: 

528 log.info('bookmark_title value missing ... setting default (the slugged title value)') 

529 return text.replace(VALUE_SLOT, mapper['title'].replace('\\\\', '').replace(' ', ' ').title()) 

530 

531 

532@no_type_check 

533def weave_meta_part_title( 

534 mapper: dict[str, Union[str, int, bool, None]], 

535 text: str, 

536) -> str: 

537 """Weave in the title from mapper or default. 

538 

539 Trigger is text.rstrip().endswith('%%_PATCH_%_MAIN_%_TITLE_%%') 

540 """ 

541 return text.replace(VALUE_SLOT, mapper['title']) 

542 

543 

544@no_type_check 

545def weave_meta_part_sub_title( 

546 mapper: dict[str, Union[str, int, bool, None]], 

547 text: str, 

548) -> str: 

549 """Weave in the sub_title from mapper or default. 

550 

551 Trigger is text.rstrip().endswith('%%_PATCH_%_SUB_%_TITLE_%%') 

552 """ 

553 if mapper.get('sub_title'): 

554 return text.replace(VALUE_SLOT, mapper['sub_title']) 

555 else: 

556 log.info('sub_title value missing ... setting default (single space)') 

557 return text.replace(VALUE_SLOT, ' ') 

558 

559 

560@no_type_check 

561def weave_meta_part_header_type( 

562 mapper: dict[str, Union[str, int, bool, None]], 

563 text: str, 

564) -> str: 

565 """Weave in the header_type from mapper or default. 

566 

567 Trigger is text.rstrip().endswith('%%_PATCH_%_TYPE_%%') 

568 """ 

569 if mapper.get('header_type'): 

570 return text.replace(VALUE_SLOT, mapper['header_type']) 

571 else: 

572 log.info('header_type value missing ... setting default (Engineering Document)') 

573 return text.replace(VALUE_SLOT, 'Engineering Document') 

574 

575 

576@no_type_check 

577def weave_meta_part_header_id_label( 

578 mapper: dict[str, Union[str, int, bool, None]], 

579 text: str, 

580) -> str: 

581 """Weave in the header_id_label from mapper or default. 

582 

583 Trigger is text.rstrip().endswith('%%_PATCH_%_ID_%_LABEL_%%') 

584 """ 

585 if mapper.get('header_id_show', None) is not None and not mapper['header_id_show']: 585 ↛ 586line 585 didn't jump to line 586, because the condition on line 585 was never true

586 log.info('header_id_show set to false - hiding id slot in header by setting label to a single space(" ")') 

587 return text.replace(VALUE_SLOT, ' ') 

588 log.info('header_id_show not set - considering header_id_label ...') 

589 if mapper.get('header_id_label'): 589 ↛ 590line 589 didn't jump to line 590, because the condition on line 589 was never true

590 pub_id_label = mapper['header_id_label'].strip() 

591 if not pub_id_label: 

592 pub_id_label = ' ' # single space to please the backend parser 

593 return text.replace(VALUE_SLOT, pub_id_label) 

594 else: 

595 log.info('header_id_label value missing ... setting default(Doc. ID:)') 

596 return text.replace(VALUE_SLOT, 'Doc. ID:') 

597 

598 

599@no_type_check 

600def weave_meta_part_header_id( 

601 mapper: dict[str, Union[str, int, bool, None]], 

602 text: str, 

603) -> str: 

604 """Weave in the header_id from mapper or default. 

605 

606 Trigger is text.rstrip().endswith('%%_PATCH_%_ID_%%') 

607 """ 

608 if mapper.get('header_id_show', None) is not None and not mapper['header_id_show']: 608 ↛ 609line 608 didn't jump to line 609, because the condition on line 608 was never true

609 log.info('header_id_show set to false - hiding id slot in header by setting value to a single space(" ")') 

610 return text.replace(VALUE_SLOT, ' ') 

611 log.info('header_id_show not set - considering header_id ...') 

612 if mapper.get('header_id'): 

613 return text.replace(VALUE_SLOT, mapper['header_id']) 

614 else: 

615 log.info('header_id value missing ... setting default (N/A)') 

616 return text.replace(VALUE_SLOT, 'N/A') 

617 

618 

619@no_type_check 

620def weave_meta_part_issue( 

621 mapper: dict[str, Union[str, int, bool, None]], 

622 text: str, 

623) -> str: 

624 """Weave in the issue from mapper or default. 

625 

626 Trigger is text.rstrip().endswith('%%_PATCH_%_ISSUE_%%') 

627 """ 

628 if mapper.get('issue'): 

629 return text.replace(VALUE_SLOT, mapper['issue']) 

630 else: 

631 log.info('issue value missing ... setting default (01)') 

632 return text.replace(VALUE_SLOT, '01') 

633 

634 

635@no_type_check 

636def weave_meta_part_revision( 

637 mapper: dict[str, Union[str, int, bool, None]], 

638 text: str, 

639) -> str: 

640 """Weave in the revision from mapper or default. 

641 

642 Trigger is text.rstrip().endswith('%%_PATCH_%_REVISION_%%') 

643 """ 

644 if mapper.get('revision'): 

645 return text.replace(VALUE_SLOT, mapper['revision']) 

646 else: 

647 log.info('revision value missing ... setting default (00)') 

648 return text.replace(VALUE_SLOT, '00') 

649 

650 

651@no_type_check 

652def weave_meta_part_header_date_label( 

653 mapper: dict[str, Union[str, int, bool, None]], 

654 text: str, 

655) -> str: 

656 """Weave in the header_date_label from mapper or default. 

657 

658 Trigger is text.rstrip().endswith('%%_PATCH_%_DATE_%_LABEL_%%') 

659 """ 

660 if mapper.get('header_date_show', None) is not None and not mapper['header_date_show']: 660 ↛ 661line 660 didn't jump to line 661, because the condition on line 660 was never true

661 log.info('header_date_show set to false - hiding date slot in header by setting label to a single space(" ")') 

662 return text.replace(VALUE_SLOT, ' ') 

663 log.info('header_date_show not set - considering header_date_label ...') 

664 if mapper.get('header_date_label'): 664 ↛ 665line 664 didn't jump to line 665, because the condition on line 664 was never true

665 pub_date_label = mapper['header_date_label'].strip() 

666 if not pub_date_label: 

667 pub_date_label = ' ' # single space to please the backend parser 

668 return text.replace(VALUE_SLOT, pub_date_label) 

669 else: 

670 log.info('header_date_label value missing ... setting default(" ")') 

671 return text.replace(VALUE_SLOT, ' ') 

672 

673 

674@no_type_check 

675def weave_meta_part_header_date( 

676 mapper: dict[str, Union[str, int, bool, None]], 

677 text: str, 

678) -> str: 

679 """Weave in the header_date from mapper or default. 

680 

681 Trigger is text.rstrip().endswith('%%_PATCH_%_DATE_%%') 

682 """ 

683 if mapper.get('header_date_show', None) is not None and not mapper['header_date_show']: 683 ↛ 684line 683 didn't jump to line 684, because the condition on line 683 was never true

684 log.info('header_date_show set to false - hiding date slot in header by setting value to a single space(" ")') 

685 return text.replace(VALUE_SLOT, ' ') 

686 log.info('header_date_show not set - considering header_date ...') 

687 if mapper.get('header_date_enable_auto', None) is not None and not mapper['header_date_enable_auto']: 687 ↛ 688line 687 didn't jump to line 688, because the condition on line 687 was never true

688 log.info('header_date_enable_auto set to false - setting that slot value as is (no date semantics enforced)') 

689 if mapper.get('header_date'): 

690 pub_date_or_any = mapper['header_date'].strip() 

691 if not pub_date_or_any: 

692 pub_date_or_any = ' ' # single space to please the backend parser 

693 return text.replace(VALUE_SLOT, pub_date_or_any) 

694 else: 

695 log.info('header_date value missing and as-is mode ... setting to single space ( ) a.k.a. hiding') 

696 return text.replace(VALUE_SLOT, ' ') 

697 else: 

698 today = dti.datetime.today() 

699 pub_date_today = today.strftime('%d %b %Y').upper() 

700 if mapper.get('header_date'): 

701 pub_date = mapper['header_date'].strip() 

702 if pub_date == MAGIC_OF_TODAY: 

703 pub_date = pub_date_today 

704 return text.replace(VALUE_SLOT, pub_date) 

705 else: 

706 log.info('header_date value missing ... setting default as empty(" ")') 

707 return text.replace(VALUE_SLOT, ' ') 

708 

709 

710@no_type_check 

711def weave_meta_part_footer_frame_note( 

712 mapper: dict[str, Union[str, int, bool, None]], 

713 text: str, 

714) -> str: 

715 """Weave in the footer_frame_note from mapper or default. 

716 

717 Trigger is text.rstrip().endswith('%%_PATCH_%_FRAME_%_NOTE_%%') 

718 """ 

719 if mapper.get('footer_frame_note'): 

720 return text.replace(VALUE_SLOT, mapper['footer_frame_note']) 

721 else: 

722 log.info('footer_frame_note value missing ... setting default from module / environment ...') 

723 return text.replace(VALUE_SLOT, WEAVE_DEFAULTS['footer_frame_note']) 

724 

725 

726@no_type_check 

727def weave_meta_part_footer_page_number_prefix( 

728 mapper: dict[str, Union[str, int, bool, None]], 

729 text: str, 

730) -> str: 

731 """Weave in the footer_page_number_prefix from mapper or default. 

732 

733 Trigger is text.rstrip().endswith('%%_PATCH_%_FOOT_%_PAGE_%_COUNTER_%_LABEL_%%') 

734 """ 

735 if mapper.get('footer_page_number_prefix'): 

736 return text.replace(VALUE_SLOT, mapper['footer_page_number_prefix']) 

737 else: 

738 log.info('footer_page_number_prefix value missing ... setting default (Page)') 

739 return text.replace(VALUE_SLOT, 'Page') 

740 

741 

742@no_type_check 

743def weave_meta_part_change_log_issue_label( 

744 mapper: dict[str, Union[str, int, bool, None]], 

745 text: str, 

746) -> str: 

747 """Weave in the change_log_issue_label from mapper or default. 

748 

749 Trigger is text.rstrip().endswith('%%_PATCH_%_CHANGELOG_%_ISSUE_%_LABEL_%%') 

750 """ 

751 if mapper.get('change_log_issue_label'): 

752 return text.replace(VALUE_SLOT, mapper['change_log_issue_label']) 

753 else: 

754 log.info('change_log_issue_label value missing ... setting default (Iss.)') 

755 return text.replace(VALUE_SLOT, 'Iss.') 

756 

757 

758@no_type_check 

759def weave_meta_part_change_log_revision_label( 

760 mapper: dict[str, Union[str, int, bool, None]], 

761 text: str, 

762) -> str: 

763 """Weave in the change_log_revision_label from mapper or default. 

764 

765 Trigger is text.rstrip().endswith('%%_PATCH_%_CHANGELOG_%_REVISION_%_LABEL_%%') 

766 """ 

767 if mapper.get('change_log_revision_label'): 

768 return text.replace(VALUE_SLOT, mapper['change_log_revision_label']) 

769 else: 

770 log.info('change_log_revision_label value missing ... setting default (Rev.)') 

771 return text.replace(VALUE_SLOT, 'Rev.') 

772 

773 

774@no_type_check 

775def weave_meta_part_change_log_date_label( 

776 mapper: dict[str, Union[str, int, bool, None]], 

777 text: str, 

778) -> str: