Coverage for src / rendercv / cli / app.py: 100%

1import importlib (empty)

2import json (empty)

3import os (empty)

4import pathlib (empty)

5import sys (empty)

6import threading (empty)

7import time (empty)

8import urllib.request (empty)

9from typing import Annotated (empty)

10 

11import packaging.version (empty)

12import typer (empty)

13from rich import print (empty)

14 

15from rendercv import __version__ (empty)

16 

17VERSION_CHECK_TTL_SECONDS = 86400 # 24 hours (empty)

18 

19app = typer.Typer( (empty)

20 rich_markup_mode="rich", 

21 # to make `rendercv --version` work: 

22 invoke_without_command=True, 

23 context_settings={"help_option_names": ["-h", "--help"]}, 

24) 

25 

26 

27@app.callback() (empty)

28def cli_command_no_args( (empty)

29 ctx: typer.Context, 

30 version_requested: Annotated[ 

31 bool | None, typer.Option("--version", "-v", help="Show the version") 

32 ] = None, 

33): 

34 """RenderCV is a command-line tool for rendering CVs from YAML input files. For more 

35 information, see https://docs.rendercv.com. 

36 """ 

37 warn_if_new_version_is_available() (empty)

38 

39 if version_requested: (empty)

40 print(f"RenderCV v{__version__}") (empty)

41 elif ctx.invoked_subcommand is None: (empty)

42 # No command was provided, show help 

43 print(ctx.get_help()) (empty)

44 raise typer.Exit() (empty)

45 

46 

47def get_cache_dir() -> pathlib.Path: (empty)

48 """Return the platform-appropriate cache directory for RenderCV.""" 

49 if sys.platform == "win32": (empty)

50 base = pathlib.Path( (empty)

51 os.environ.get("LOCALAPPDATA", pathlib.Path.home() / "AppData" / "Local") 

52 ) 

53 elif sys.platform == "darwin": (empty)

54 base = pathlib.Path.home() / "Library" / "Caches" (empty)

55 else: 

56 base = pathlib.Path( (empty)

57 os.environ.get("XDG_CACHE_HOME", pathlib.Path.home() / ".cache") 

58 ) 

59 return base / "rendercv" (empty)

60 

61 

62def get_version_cache_file() -> pathlib.Path: (empty)

63 """Return the path to the version check cache file.""" 

64 return get_cache_dir() / "version_check.json" (empty)

65 

66 

67def read_version_cache() -> dict | None: (empty)

68 """Read the cached version check data, or None if unavailable/corrupt.""" 

69 try: (empty)

70 data = json.loads(get_version_cache_file().read_text(encoding="utf-8")) (empty)

71 if isinstance(data, dict) and "last_check" in data and "latest_version" in data: (empty)

72 return data (empty)

73 except (OSError, json.JSONDecodeError, KeyError): (empty)

74 pass (empty)

75 return None (empty)

76 

77 

78def write_version_cache(version_string: str) -> None: (empty)

79 """Write the latest version string and current timestamp to the cache file.""" 

80 cache_file = get_version_cache_file() (empty)

81 try: (empty)

82 cache_file.parent.mkdir(parents=True, exist_ok=True) (empty)

83 cache_file.write_text( (empty)

84 json.dumps({"last_check": time.time(), "latest_version": version_string}), 

85 encoding="utf-8", 

86 ) 

87 except OSError: (empty)

88 pass (empty)

89 

90 

91def fetch_latest_version_from_pypi() -> str | None: (empty)

92 """Fetch the latest RenderCV version string from PyPI, or None on failure.""" 

93 url = "https://pypi.org/pypi/rendercv/json" (empty)

94 try: (empty)

95 with urllib.request.urlopen(url, timeout=5) as response: (empty)

96 data = response.read() (empty)

97 encoding = response.info().get_content_charset("utf-8") (empty)

98 json_data = json.loads(data.decode(encoding)) (empty)

99 return json_data["info"]["version"] (empty)

100 except (OSError, json.JSONDecodeError, KeyError, ValueError): (empty)

101 return None (empty)

102 

103 

104def fetch_and_cache_latest_version() -> None: (empty)

105 """Fetch the latest version from PyPI and write it to the cache file.""" 

106 version_string = fetch_latest_version_from_pypi() (empty)

107 if version_string: (empty)

108 write_version_cache(version_string) (empty)

109 

110 

111def warn_if_new_version_is_available() -> None: (empty)

112 """Check for a newer RenderCV version using a stale-while-revalidate cache. 

113 

114 Why: 

115 Uses a disk cache with background refresh so the CLI never blocks on 

116 network I/O. If the cache is stale or missing, a daemon thread refreshes 

117 it for the next invocation. 

118 """ 

119 cache = read_version_cache() (empty)

120 

121 if not cache or (time.time() - cache["last_check"]) >= VERSION_CHECK_TTL_SECONDS: (empty)

122 thread = threading.Thread(target=fetch_and_cache_latest_version, daemon=True) (empty)

123 thread.start() (empty)

124 

125 if cache: (empty)

126 try: (empty)

127 latest = packaging.version.Version(cache["latest_version"]) (empty)

128 current = packaging.version.Version(__version__) (empty)

129 if current < latest: (empty)

130 print( (empty)

131 "\n[bold yellow]A new version of RenderCV is available!" 

132 f" You are using v{__version__}, and the latest version" 

133 f" is v{latest}.[/bold yellow]\n" 

134 ) 

135 except packaging.version.InvalidVersion: (empty)

136 pass (empty)

137 

138 

139# Auto import all commands so that they are registered with the app: 

140cli_folder_path = pathlib.Path(__file__).parent (empty)

141for file in cli_folder_path.rglob("*_command.py"): (empty)

142 # Enforce folder structure: ./name_command/name_command.py 

143 folder_name = file.parent.name # e.g. "foo_command" (empty)

144 py_file_name = file.stem # e.g. "foo_command" (empty)

145 

146 # Build full module path: <parent_pkg>.foo_command.foo_command 

147 full_module = f"{__package__}.{folder_name}.{py_file_name}" (empty)

148 

149 module = importlib.import_module(full_module) (empty)