Use f-strings, rename variables, add doc strings

Author: Alexandre Feblot

README.md

@@ -14,7 +14,7 @@
 <div align="center">
   <h1 align="center">Kubernetes Resource Recommendations Based on Historical Data</h1>
   <h2 align="center">Get recommendations based on your existing data in Prometheus/Coralogix/Thanos/Mimir and more!</h2>
-  <p align="center">    
+  <p align="center">
     <a href="#installation"><strong>Installation</strong></a>
     .
     <a href="#how-krr-works"><strong>How KRR works</strong></a>
@@ -202,7 +202,7 @@ Apart from running KRR as a CLI tool you can also run KRR inside your cluster. W
 
 <img src="./images/ui_recommendation.png">
 
-You can also run KRR in-cluster as a Kubernetes Job, if you don't want to view results easily in a <a href="https://platform.robusta.dev/signup/?benefits=krr&utm_source=github&utm_medium=krr-readme&utm_content=in-cluster-ui">UI</a>. 
+You can also run KRR in-cluster as a Kubernetes Job, if you don't want to view results easily in a <a href="https://platform.robusta.dev/signup/?benefits=krr&utm_source=github&utm_medium=krr-readme&utm_content=in-cluster-ui">UI</a>.
 
 ```
 kubectl apply -f https://raw.githubusercontent.com/robusta-dev/krr/refs/heads/main/docs/krr-in-cluster/krr-in-cluster-job.yaml
@@ -403,12 +403,12 @@ If you need help, contact us on Slack, email, or by opening a GitHub issue.
 <details>
   <summary>VCluster</summary>
 
-KRR Support VCluster software when Prometheus is outside of the VCluster (on physical cluster or centralized). Because of VCluster pod renamming, you need to provide :
+KRR supports VCluster software when Prometheus is outside of the VCluster (on physical cluster or centralized). Because of VCluster pod renaming, you need to provide :
 
 - `vcluster-namespace` : The namespace on physical cluster where VCluster is
 - `vcluster-name` : The name of your VCluster (set during VCluster deployment)
-  
-Other parameter like namespace selector, pod selector etc work as expected. 
+
+Other parameters like namespace selector, pod selector etc work as expected.
 
 ```sh
 krr simple --vcluster-name my-vcluster-name --vcluster-namespace my-vcluster-namespace

requirements.txt

@@ -54,4 +54,3 @@ urllib3==1.26.19 ; python_version >= "3.9" and python_full_version < "3.13"
 websocket-client==1.7.0 ; python_version >= "3.9" and python_full_version < "3.13"
 zipp==3.19.2 ; python_version >= "3.9" and python_version < "3.13"
 tenacity==9.0.0 ; python_version >= "3.9" and python_version < "3.13"
-hashlib

robusta_krr/core/integrations/prometheus/metrics/base.py

@@ -4,6 +4,7 @@
 import asyncio
 import datetime
 import enum
+import hashlib
 from concurrent.futures import ThreadPoolExecutor
 from functools import reduce
 from typing import Any, Optional, TypedDict
@@ -18,7 +19,6 @@
 from robusta_krr.core.models.config import settings
 from robusta_krr.core.models.objects import K8sObjectData
 
-import hashlib
 
 class PrometheusSeries(TypedDict):
     metric: dict[str, Any]
@@ -261,24 +261,42 @@ def combine_batches(self, results: list[PodsTimeData]) -> PodsTimeData:
 
         return reduce(lambda x, y: x | y, results, {})
 
-    ## Vcluster 
-    def get_vcluster_pod_real_name(self, vcluster_pod_name, vcluster_pod_namespace) -> str:
+    ## Vcluster
+    def get_vcluster_pod_real_name(self, pod_name: str, pod_namespace: str) -> str:
+        """
+        Returns the pod name on the (host) cluster, which is different from the pod name in the VCluster.
+        When not in a VCluster, just returns the pod name as is.
+
+        Args:
+        pod_name (string): The pod name in the cluster krr connected to
+        pod_namespace (string): The pod namespace in the cluster krr connected to
+
+        Returns:
+        string: the pod name in the host cluster.
+        """
+
         if settings.vcluster_name is None:
-            return vcluster_pod_name
+            return pod_name
         else:
-            x = '-x-'
-            new_name = vcluster_pod_name + x + vcluster_pod_namespace + x + settings.vcluster_name
-            result_sha256 = hashlib.sha256(new_name.encode()).hexdigest()
-            
-            if len(new_name) > 63:
-                shortened_name = new_name[:52] + '-' + result_sha256[:10]
-                return shortened_name
-            else:
-                return new_name
-        
-
-    def get_pod_namespace(self, object_namespace) -> str:
+            host_pod_name = f"{pod_name}-x-{pod_namespace}-x-{settings.vcluster_name}"
+            if len(host_pod_name) > 63:
+                host_pod_name_sha256 = hashlib.sha256(host_pod_name.encode()).hexdigest()
+                host_pod_name = f"{host_pod_name[:52]}-{host_pod_name_sha256[:10]}"
+            return host_pod_name
+
+    def get_pod_namespace(self, pod_namespace: str) -> str:
+        """
+        Returns the pod namespace on the (host) cluster, which is different from the pod namespace in the VCluster.
+        When not in a VCluster, just returns the pod namespace as is.
+
+        Args:
+        pod_namespace (string): The pod namespace in the cluster krr connected to
+
+        Returns:
+        string: the pod namepace in the host cluster.
+        """
+
         if settings.vcluster_namespace is None:
-            return object_namespace
+            return pod_namespace
         else:
-            return settings.vcluster_namespace
+            return settings.vcluster_namespace