chore: add a utility method for generating unique names

jaycee-li · copybara-github · commit 9d137addf1ff · 2022-12-13T13:47:12.000-08:00
PiperOrigin-RevId: 495116428
diff --git a/google/cloud/aiplatform/utils/__init__.py b/google/cloud/aiplatform/utils/__init__.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright 2020 Google LLC
+# Copyright 2022 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@
 import logging
 import re
 from typing import Any, Callable, Dict, Optional, Type, TypeVar, Tuple
+import uuid
 
 from google.protobuf import timestamp_pb2
 
@@ -718,3 +719,14 @@ def get_timestamp_proto(
     timestamp_proto.FromDatetime(time)
 
     return timestamp_proto
+
+
+def timestamped_unique_name() -> str:
+    """Composes a timestamped unique name.
+
+    Returns:
+        A string representing a unique name.
+    """
+    timestamp = datetime.datetime.now().strftime("%Y-%m-%d-%H-%M-%S")
+    unique_id = uuid.uuid4().hex[0:5]
+    return f"{timestamp}-{unique_id}"
diff --git a/tests/unit/aiplatform/test_utils.py b/tests/unit/aiplatform/test_utils.py
@@ -20,6 +20,7 @@
 import importlib
 import json
 import os
+import re
 import textwrap
 from typing import Callable, Dict, Optional, Tuple
 from unittest import mock
@@ -452,6 +453,11 @@ def test_get_timestamp_proto(
     assert true_timestamp_proto == utils.get_timestamp_proto(time)
 
 
+def test_timestamped_unique_name():
+    name = utils.timestamped_unique_name()
+    assert re.match(r"\d{4}-\d{2}-\d{2}-\d{2}-\d{2}-\d{2}-.{5}", name)
+
+
 class TestPipelineUtils:
     SAMPLE_JOB_SPEC = {
         "pipelineSpec": {
