Skip to content

Commit 0797736

Browse files
committed
Convert pretty_reference into a abstract property
This allows us to provide a better references depending on the container type
1 parent 1584aac commit 0797736

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

src/bci_build/package/__init__.py

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -982,9 +982,14 @@ def reference(self) -> str:
982982
pass
983983

984984
@property
985+
@abc.abstractmethod
985986
def pretty_reference(self) -> str:
986-
"""
987-
Returns the human readable pretty URL to this image. Used in image documentation.
987+
"""Returns the human readable registry URL to this image. It is intended
988+
to be used in the image documentation.
989+
990+
This url needn't point to an exact version-release but can include just
991+
the major os version or the latest tag.
992+
988993
"""
989994
return (
990995
f"{self.registry}/{self._registry_prefix}/{self.name}:{self.version_label}"
@@ -1361,6 +1366,12 @@ def reference(self) -> str:
13611366
+ f":{self.version_label}-{self._release_suffix}"
13621367
)
13631368

1369+
@property
1370+
def pretty_reference(self) -> str:
1371+
return f"{self.registry}/{self._registry_prefix}/{self.name}:" + (
1372+
"latest" if self.is_latest else self.version_label
1373+
)
1374+
13641375
@property
13651376
def build_version(self) -> str | None:
13661377
build_ver = super().build_version
@@ -1441,6 +1452,10 @@ def build_tags(self) -> list[str]:
14411452
def reference(self) -> str:
14421453
return f"{self.registry}/{self._registry_prefix}/bci-{self.name}:{self.version_label}"
14431454

1455+
@property
1456+
def pretty_reference(self) -> str:
1457+
return f"{self.registry}/{self._registry_prefix}/bci-{self.name}:%OS_VERSION_ID_SP%"
1458+
14441459

14451460
def generate_disk_size_constraints(size_gb: int) -> str:
14461461
"""Creates the contents of a :file:`_constraints` file for OBS to require

0 commit comments

Comments
 (0)