Code cleanup

Signed-off-by: Tobias Wolf <wolf@b1-systems.de>
On-behalf-of: SAP <tobias.wolf@sap.com>

Author: NotTheEvilOne

src/gardenlinux/oci/image.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-OCI podman
+OCI podman image
 """
 
 import logging

src/gardenlinux/oci/image_manifest.py

@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
 
+"""
+OCI image manifest
+"""
+
 import json
 from copy import deepcopy
 from os import PathLike
@@ -12,8 +16,8 @@
 from ..features import CName
 from .layer import Layer
 from .manifest import Manifest
-from .platform import NewPlatform
-from .schemas import EmptyManifestMetadata
+from .platform import new_platform
+from .schemas import empty_manifest_metadata
 
 
 class ImageManifest(Manifest):
@@ -282,12 +286,12 @@ def write_metadata_file(self, manifest_file_path_name: PathLike[str] | str) -> N
             "feature_set": self.feature_set,
         }
 
-        metadata = deepcopy(EmptyManifestMetadata)
+        metadata = deepcopy(empty_manifest_metadata)
         metadata["mediaType"] = "application/vnd.oci.image.manifest.v1+json"
         metadata["digest"] = self.digest
         metadata["size"] = self.size
         metadata["annotations"] = metadata_annotations
-        metadata["platform"] = NewPlatform(self.arch, self.version)
+        metadata["platform"] = new_platform(self.arch, self.version)
 
         with open(manifest_file_path_name, "w") as fp:
             fp.write(json.dumps(metadata))

src/gardenlinux/oci/index.py

@@ -1,10 +1,14 @@
 # -*- coding: utf-8 -*-
 
+"""
+OCI image index
+"""
+
 import json
 from copy import deepcopy
 from typing import Any, Dict
 
-from .schemas import EmptyIndex
+from .schemas import empty_index
 
 
 class Index(dict):  # type: ignore[type-arg]
@@ -29,7 +33,7 @@ def __init__(self, *args: Any, **kwargs: Any):
 
         dict.__init__(self)
 
-        self.update(deepcopy(EmptyIndex))
+        self.update(deepcopy(empty_index))
         self.update(*args)
         self.update(**kwargs)
 

src/gardenlinux/oci/layer.py

@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
 
+"""
+OCI image layer
+"""
+
 from collections.abc import Mapping
 from os import PathLike
 from pathlib import Path

src/gardenlinux/oci/manifest.py

@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
 
+"""
+OCI manifest
+"""
+
 import json
 from copy import deepcopy
 from hashlib import sha256
@@ -11,7 +15,7 @@
 
 class Manifest(dict):  # type: ignore[type-arg]
     """
-    OCI image manifest
+    OCI manifest
 
     :author:     Garden Linux Maintainers
     :copyright:  Copyright 2024 SAP SE

src/gardenlinux/oci/platform.py

@@ -3,11 +3,21 @@
 from copy import deepcopy
 from typing import Any, Dict
 
-from .schemas import EmptyPlatform
+from .schemas import empty_platform
 
 
-def NewPlatform(architecture: str, version: str) -> Dict[str, Any]:
-    platform = deepcopy(EmptyPlatform)
+def new_platform(architecture: str, version: str) -> Dict[str, Any]:
+    """
+    Create an OCI image platform for the architecture and version given.
+
+    :param architecture: OCI image architecture
+    :param manifest_file_path_name: OCI image version
+
+    :return: (object) OCI image platform
+    :since:  1.0.0
+    """
+
+    platform = deepcopy(empty_platform)
     platform["architecture"] = architecture
     platform["os.version"] = version
 

src/gardenlinux/oci/podman_object_context.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-OCI podman context
+OCI podman object context
 """
 
 import logging

src/gardenlinux/oci/schemas.py

@@ -7,23 +7,23 @@
 
 schema_url = "http://json-schema.org/draft-07/schema"
 
-platformProperties = {
+platform_properties = {
     "architecture": {"type": "string"},
     "os": {"type": "string"},
     "os.version": {"type": "string"},
     "variant": {"type": "string"},
 }
 
-manifestMetaProperties = {
+manifest_meta_properties = {
     "mediaType": {"type": "string"},
-    "platform": {"type": "object", "properties": platformProperties},
+    "platform": {"type": "object", "properties": platform_properties},
 }
 
-indexProperties = {
+index_properties = {
     "schemaVersion": {"type": "number"},
     "mediaType": {"type": "string"},
     "subject": {"type": ["null", "object"]},
-    "manifests": {"type": "array", "items": manifestMetaProperties},
+    "manifests": {"type": "array", "items": manifest_meta_properties},
     "annotations": {"type": ["object", "null", "array"]},
 }
 
@@ -37,24 +37,24 @@
         "manifests",
         "mediaType",
     ],
-    "properties": indexProperties,
+    "properties": index_properties,
     "additionalProperties": True,
 }
 
-EmptyPlatform = {
+empty_platform = {
     "architecture": "",
     "os": "gardenlinux",
     "os.version": "experimental",
 }
 
-EmptyManifestMetadata = {
+empty_manifest_metadata = {
     "mediaType": "application/vnd.oci.image.manifest.v1+json",
     "digest": "",
     "size": 0,
     "annotations": {},
 }
 
-EmptyIndex = {
+empty_index = {
     "schemaVersion": 2,
     "mediaType": "application/vnd.oci.image.index.v1+json",
     "manifests": [],