Releasing 1.1.0 with safer filenames

Author: rgaudin

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2024-01-30
+
+### Changed
+
+- `fs_name` now includes image reference and is filesystem safe for all OS.
+- Default export filename now includes platform as well.
+
 ## [1.0.1] - 2023-08-11
 
 ### Changed

pyproject.toml

@@ -22,6 +22,7 @@ classifiers = [
 ]
 dependencies = [
     "requests>=2,<3",
+    "pathvalidate==3.2.0",
 ]
 dynamic = ["version"]
 
@@ -47,7 +48,7 @@ dev = [
   "docker-export[lint]",
   "docker-export[test]",
   "docker-export[check]",
-  "docker-export[all]",
+  "docker-export[visual]",
 ]
 visual = [
   "humanfriendly>=8.0",

src/docker_export/__init__.py

@@ -20,6 +20,7 @@
 from typing import Any
 
 import requests
+from pathvalidate import sanitize_filename
 
 try:
     import progressbar  # pyright: ignore [reportMissingTypeStubs]
@@ -32,7 +33,7 @@
 
 REQUEST_TIMEOUT = 60
 
-__version__ = "1.0.1"
+__version__ = "1.1.0"
 logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
 logger = logging.getLogger("docker-export")
 logging.getLogger("urllib3").setLevel(logging.WARNING)
@@ -230,30 +231,32 @@ class Image:
     tag: str
     digest: str
 
-    def __str__(self):
+    def __str__(self) -> str:
         value = f"{self.registry}/{self.repository}/{self.name}:{self.tag}"
         if self.digest:
             value += f"@{self.digest}"
         return value
 
     @property
-    def fullname(self):
+    def fullname(self) -> str:
         return f"{self.repository}/{self.name}"
 
     @property
-    def reg_fullname(self):
+    def reg_fullname(self) -> str:
         return f"{self.registry}/{self.fullname}"
 
     @property
-    def fs_name(self):
-        return "_".join(pathlib.Path(self.reg_fullname).parts)
+    def fs_name(self) -> str:
+        return sanitize_filename(
+            "_".join(pathlib.Path(self.reg_fullname).parts) + f"_{self.reference}"
+        )
 
     @property
     def reference(self):
         return self.digest or self.tag
 
     @property
-    def url(self):
+    def url(self) -> str:
         domain = (
             "hub.docker.com" if self.registry == "index.docker.io" else self.registry
         )
@@ -903,7 +906,7 @@ def main():
         image = Image.parse(**args)
         dest = pathlib.Path(output).expanduser().resolve()
         if not dest.suffix == ".tar":
-            dest = dest.joinpath(f"{image.fs_name}.tar")
+            dest = dest.joinpath(sanitize_filename(f"{image.fs_name}_{platform}.tar"))
         build_dir = (
             pathlib.Path(build_dir).expanduser().resolve() if build_dir else None
         )