From fd5cf345e10a5fd0b7f1984a887cfcedba4ca644 Mon Sep 17 00:00:00 2001
From: Todd Gamblin <tgamblin@llnl.gov>
Date: Fri, 30 Dec 2022 12:54:05 -0800
Subject: [PATCH] refactor: Move `spack.util.string` to `llnl.util.string`

---
 lib/spack/llnl/util/lock.py                                   | 4 ++--
 lib/spack/{spack => llnl}/util/string.py                      | 0
 lib/spack/spack/build_environment.py                          | 2 +-
 lib/spack/spack/cmd/__init__.py                               | 4 ++--
 lib/spack/spack/cmd/buildcache.py                             | 2 +-
 lib/spack/spack/cmd/env.py                                    | 2 +-
 lib/spack/spack/cmd/tags.py                                   | 3 ++-
 lib/spack/spack/fetch_strategy.py                             | 2 +-
 lib/spack/spack/spec.py                                       | 4 ++--
 .../spack/test/{util/util_string.py => llnl/util/string.py}   | 2 +-
 lib/spack/spack/util/classes.py                               | 2 +-
 lib/spack/spack/util/naming.py                                | 1 -
 lib/spack/spack/variant.py                                    | 2 +-
 13 files changed, 15 insertions(+), 15 deletions(-)
 rename lib/spack/{spack => llnl}/util/string.py (100%)
 rename lib/spack/spack/test/{util/util_string.py => llnl/util/string.py} (92%)

diff --git a/lib/spack/llnl/util/lock.py b/lib/spack/llnl/util/lock.py
index cefaa8c2534..12777947196 100644
--- a/lib/spack/llnl/util/lock.py
+++ b/lib/spack/llnl/util/lock.py
@@ -10,10 +10,10 @@
 import time
 from datetime import datetime
 
+import llnl.util.string
 import llnl.util.tty as tty
 from llnl.util.lang import pretty_seconds
 
-import spack.util.string
 
 if sys.platform != "win32":
     import fcntl
@@ -165,7 +165,7 @@ def _attempts_str(wait_time, nattempts):
     if nattempts <= 1:
         return ""
 
-    attempts = spack.util.string.plural(nattempts, "attempt")
+    attempts = llnl.util.string.plural(nattempts, "attempt")
     return " after {} and {}".format(pretty_seconds(wait_time), attempts)
 
 
diff --git a/lib/spack/spack/util/string.py b/lib/spack/llnl/util/string.py
similarity index 100%
rename from lib/spack/spack/util/string.py
rename to lib/spack/llnl/util/string.py
diff --git a/lib/spack/spack/build_environment.py b/lib/spack/spack/build_environment.py
index d609fd1aa74..d621f5bdff7 100644
--- a/lib/spack/spack/build_environment.py
+++ b/lib/spack/spack/build_environment.py
@@ -44,6 +44,7 @@
 
 import llnl.util.tty as tty
 from llnl.util.lang import dedupe
+from llnl.util.string import plural
 from llnl.util.symlink import symlink
 from llnl.util.tty.color import cescape, colorize
 from llnl.util.tty.log import MultiProcessFd
@@ -81,7 +82,6 @@
 from spack.util.executable import Executable
 from spack.util.log_parse import make_log_context, parse_log_events
 from spack.util.module_cmd import load_module, module, path_from_modules
-from spack.util.string import plural
 
 #
 # This can be set by the user to globally disable parallel builds.
diff --git a/lib/spack/spack/cmd/__init__.py b/lib/spack/spack/cmd/__init__.py
index 268fa3c7abf..20841910404 100644
--- a/lib/spack/spack/cmd/__init__.py
+++ b/lib/spack/spack/cmd/__init__.py
@@ -16,6 +16,7 @@
 import ruamel.yaml as yaml
 from ruamel.yaml.error import MarkedYAMLError
 
+import llnl.util.string
 import llnl.util.tty as tty
 from llnl.util.filesystem import join_path
 from llnl.util.lang import attr_setdefault, index_by
@@ -33,7 +34,6 @@
 import spack.traverse as traverse
 import spack.user_environment as uenv
 import spack.util.spack_json as sjson
-import spack.util.string
 
 # cmd has a submodule called "list" so preserve the python list module
 python_list = list
@@ -523,7 +523,7 @@ def print_how_many_pkgs(specs, pkg_type=""):
             category, e.g. if pkg_type is "installed" then the message
             would be "3 installed packages"
     """
-    tty.msg("%s" % spack.util.string.plural(len(specs), pkg_type + " package"))
+    tty.msg("%s" % llnl.util.string.plural(len(specs), pkg_type + " package"))
 
 
 def spack_is_git_repo():
diff --git a/lib/spack/spack/cmd/buildcache.py b/lib/spack/spack/cmd/buildcache.py
index 53fe50c64ab..51e68835d1d 100644
--- a/lib/spack/spack/cmd/buildcache.py
+++ b/lib/spack/spack/cmd/buildcache.py
@@ -11,6 +11,7 @@
 import urllib.parse
 
 import llnl.util.tty as tty
+from llnl.util.string import plural
 
 import spack.binary_distribution as bindist
 import spack.cmd
@@ -30,7 +31,6 @@
 from spack.error import SpecError
 from spack.spec import Spec, save_dependency_specfiles
 from spack.stage import Stage
-from spack.util.string import plural
 
 description = "create, download and install binary packages"
 section = "packaging"
diff --git a/lib/spack/spack/cmd/env.py b/lib/spack/spack/cmd/env.py
index e4c62758c4d..81e6a62cb5d 100644
--- a/lib/spack/spack/cmd/env.py
+++ b/lib/spack/spack/cmd/env.py
@@ -11,6 +11,7 @@
 import tempfile
 
 import llnl.util.filesystem as fs
+import llnl.util.string as string
 import llnl.util.tty as tty
 from llnl.util.tty.colify import colify
 from llnl.util.tty.color import colorize
@@ -28,7 +29,6 @@
 import spack.schema.env
 import spack.tengine
 import spack.traverse as traverse
-import spack.util.string as string
 from spack.util.environment import EnvironmentModifications
 
 description = "manage virtual environments"
diff --git a/lib/spack/spack/cmd/tags.py b/lib/spack/spack/cmd/tags.py
index b720055a15e..12c4f5102b9 100644
--- a/lib/spack/spack/cmd/tags.py
+++ b/lib/spack/spack/cmd/tags.py
@@ -5,6 +5,7 @@
 import io
 import sys
 
+import llnl.util.string
 import llnl.util.tty as tty
 import llnl.util.tty.colify as colify
 
@@ -24,7 +25,7 @@ def report_tags(category, tags):
     if isatty:
         num = len(tags)
         fmt = "{0} package tag".format(category)
-        buffer.write("{0}:\n".format(spack.util.string.plural(num, fmt)))
+        buffer.write("{0}:\n".format(llnl.util.string.plural(num, fmt)))
 
     if tags:
         colify.colify(tags, output=buffer, tty=isatty, indent=4)
diff --git a/lib/spack/spack/fetch_strategy.py b/lib/spack/spack/fetch_strategy.py
index d061321d430..81074367e85 100644
--- a/lib/spack/spack/fetch_strategy.py
+++ b/lib/spack/spack/fetch_strategy.py
@@ -43,6 +43,7 @@
     working_dir,
 )
 from llnl.util.symlink import symlink
+from llnl.util.string import comma_and, quote
 
 import spack.config
 import spack.error
@@ -55,7 +56,6 @@
 import spack.version
 from spack.util.compression import decompressor_for, extension_from_path
 from spack.util.executable import CommandNotFoundError, which
-from spack.util.string import comma_and, quote
 
 #: List of all fetch strategies, created by FetchStrategy metaclass.
 all_strategies = []
diff --git a/lib/spack/spack/spec.py b/lib/spack/spack/spec.py
index 85cfa70ca34..ab8a0ce8cbe 100644
--- a/lib/spack/spack/spec.py
+++ b/lib/spack/spack/spec.py
@@ -59,6 +59,7 @@
 
 import ruamel.yaml as yaml
 
+import llnl.util.string
 import llnl.util.filesystem as fs
 import llnl.util.lang as lang
 import llnl.util.tty as tty
@@ -86,7 +87,6 @@
 import spack.util.prefix
 import spack.util.spack_json as sjson
 import spack.util.spack_yaml as syaml
-import spack.util.string
 import spack.variant as vt
 import spack.version as vn
 
@@ -5041,7 +5041,7 @@ class InvalidDependencyError(spack.error.SpecError):
     def __init__(self, pkg, deps):
         self.invalid_deps = deps
         super(InvalidDependencyError, self).__init__(
-            "Package {0} does not depend on {1}".format(pkg, spack.util.string.comma_or(deps))
+            "Package {0} does not depend on {1}".format(pkg, llnl.util.string.comma_or(deps))
         )
 
 
diff --git a/lib/spack/spack/test/util/util_string.py b/lib/spack/spack/test/llnl/util/string.py
similarity index 92%
rename from lib/spack/spack/test/util/util_string.py
rename to lib/spack/spack/test/llnl/util/string.py
index a1f58600b6b..abe1791a45e 100644
--- a/lib/spack/spack/test/util/util_string.py
+++ b/lib/spack/spack/test/llnl/util/string.py
@@ -3,7 +3,7 @@
 #
 # SPDX-License-Identifier: (Apache-2.0 OR MIT)
 
-from spack.util.string import plural
+from llnl.util.string import plural
 
 
 def test_plural():
diff --git a/lib/spack/spack/util/classes.py b/lib/spack/spack/util/classes.py
index cad2de2c48e..16615ae7f6b 100644
--- a/lib/spack/spack/util/classes.py
+++ b/lib/spack/spack/util/classes.py
@@ -3,7 +3,7 @@
 #
 # SPDX-License-Identifier: (Apache-2.0 OR MIT)
 
-# Need this because of spack.util.string
+# Keeping this because of vestigial spack.util.string
 from __future__ import absolute_import
 
 import inspect
diff --git a/lib/spack/spack/util/naming.py b/lib/spack/spack/util/naming.py
index b0a693738e8..d7b259a7e74 100644
--- a/lib/spack/spack/util/naming.py
+++ b/lib/spack/spack/util/naming.py
@@ -3,7 +3,6 @@
 #
 # SPDX-License-Identifier: (Apache-2.0 OR MIT)
 
-# Need this because of spack.util.string
 from __future__ import absolute_import
 
 import io
diff --git a/lib/spack/spack/variant.py b/lib/spack/spack/variant.py
index 1e646fa3b4b..b64fb221ea1 100644
--- a/lib/spack/spack/variant.py
+++ b/lib/spack/spack/variant.py
@@ -15,10 +15,10 @@
 
 import llnl.util.lang as lang
 import llnl.util.tty.color
+from llnl.util.string import comma_or
 
 import spack.directives
 import spack.error as error
-from spack.util.string import comma_or
 
 special_variant_values = [None, "none", "*"]