zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add quotes to type annotation

Browse Source 
Signed-off-by: Todd Gamblin <tgamblin@llnl.gov>
This commit is contained in:
Todd Gamblin 2025-02-10 22:04:34 -08:00 committed by Gregory Becker
parent 4a153a185b
commit 8d0923f29e
No known key found for this signature in database
GPG Key ID: 2362541F6D14ED84
1 changed files with 33 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
lib/spack/spack/installer.py
View File

@ -75,6 +75,7 @@
_fail_fast_err = "Terminating after first install failure" _fail_fast_err = "Terminating after first install failure"
class BuildStatus(enum.Enum): class BuildStatus(enum.Enum):
"""Different build (task) states.""" """Different build (task) states."""
@ -119,10 +120,11 @@ class ExecuteResult(enum.Enum):
FAILED = enum.auto() FAILED = enum.auto()
# Task is missing build spec and will be requeued # Task is missing build spec and will be requeued
MISSING_BUILD_SPEC = enum.auto() MISSING_BUILD_SPEC = enum.auto()
# Task is installed upstream/external or # Task is installed upstream/external or
# task is not ready for installation (locked by another process) # task is not ready for installation (locked by another process)
NO_OP = enum.auto() NO_OP = enum.auto()
class InstallAction(enum.Enum): class InstallAction(enum.Enum):
#: Don't perform an install #: Don't perform an install
NONE = enum.auto() NONE = enum.auto()
@ -1067,7 +1069,6 @@ def flag_installed(self, installed: List[str]) -> None:
level=2, level=2,
) )
def _setup_install_dir(self, pkg: "spack.package_base.PackageBase") -> None: def _setup_install_dir(self, pkg: "spack.package_base.PackageBase") -> None:
""" """
Create and ensure proper access controls for the install directory. Create and ensure proper access controls for the install directory.
@ -1100,7 +1101,7 @@ def _setup_install_dir(self, pkg: "spack.package_base.PackageBase") -> None:
# Always write host environment - we assume this can change # Always write host environment - we assume this can change
spack.store.STORE.layout.write_host_environment(pkg.spec) spack.store.STORE.layout.write_host_environment(pkg.spec)
@property @property
def install_action(self: "Task") -> InstallAction: def install_action(self: "Task") -> InstallAction:
""" """
@ -1117,7 +1118,7 @@ def install_action(self: "Task") -> InstallAction:
# If it's not installed, do a normal install as well # If it's not installed, do a normal install as well
rec, installed = check_db(self.pkg.spec) rec, installed = check_db(self.pkg.spec)
if not installed: if not installed:
return InstallAction.INSTALL return InstallAction.INSTALL
@ -1182,9 +1183,8 @@ def priority(self):
"""The priority is based on the remaining uninstalled dependencies.""" """The priority is based on the remaining uninstalled dependencies."""
return len(self.uninstalled_deps) return len(self.uninstalled_deps)
def check_db(
spec: "spack.spec.Spec" def check_db(spec: "spack.spec.Spec") -> Tuple[Optional[spack.database.InstallRecord], bool]:
) -> Tuple[Optional[spack.database.InstallRecord], bool]:
"""Determine if the spec is flagged as installed in the database """Determine if the spec is flagged as installed in the database
Args: Args:
@ -1204,10 +1204,11 @@ def check_db(
installed_in_db = False installed_in_db = False
return rec, installed_in_db return rec, installed_in_db
class BuildTask(Task): class BuildTask(Task):
"""Class for representing a build task for a package.""" """Class for representing a build task for a package."""
process_handle: spack.build_environment.ProcessHandle = None process_handle: "spack.build_environment.ProcessHandle" = None
started: bool = False started: bool = False
no_op: bool = False no_op: bool = False
@ -1240,9 +1241,9 @@ def start(self):
else: else:
tty.msg(f"No binary for {pkg_id} found: installing from source") tty.msg(f"No binary for {pkg_id} found: installing from source")
# if there's an error result, don't start a new process, and leave # if there's an error result, don't start a new process, and leave
if self.error_result is not None: if self.error_result is not None:
return return
# Create stage object now and let it be serialized for the child process. That # Create stage object now and let it be serialized for the child process. That
# way monkeypatch in tests works correctly. # way monkeypatch in tests works correctly.
@ -1251,7 +1252,7 @@ def start(self):
# Create a child process to do the actual installation. # Create a child process to do the actual installation.
child_process = overwrite_process if action == InstallAction.OVERWRITE else build_process child_process = overwrite_process if action == InstallAction.OVERWRITE else build_process
self.process_handle = spack.build_environment.start_build_process( self.process_handle = spack.build_environment.start_build_process(
self.pkg, child_process, self.request.install_args self.pkg, child_process, self.request.install_args
) )
@ -1262,7 +1263,9 @@ def start(self):
def poll(self): def poll(self):
"""Check if task has successfully executed, caused an InstallError, """Check if task has successfully executed, caused an InstallError,
or the child process has information ready to receive.""" or the child process has information ready to receive."""
assert self.started or self.no_op, "Can't call `poll()` before `start()` or identified no-operation task" assert (
self.started or self.no_op
), "Can't call `poll()` before `start()` or identified no-operation task"
return self.no_op or self.success_result or self.error_result or self.process_handle.poll() return self.no_op or self.success_result or self.error_result or self.process_handle.poll()
def complete(self): def complete(self):
@ -1270,7 +1273,9 @@ def complete(self):
Complete the installation of the requested spec and/or dependency Complete the installation of the requested spec and/or dependency
represented by the build task. represented by the build task.
""" """
assert self.started or self.no_op, "Can't call `complete()` before `start()` or identified no-operation task" assert (
self.started or self.no_op
), "Can't call `complete()` before `start()` or identified no-operation task"
# seeing if I can get rid of that assertion because in some cases we will need to # seeing if I can get rid of that assertion because in some cases we will need to
# complete the task so that we can raise the errors even though a process was never # complete the task so that we can raise the errors even though a process was never
# started because saving the error made it exit the function before a process could be started # started because saving the error made it exit the function before a process could be started
@ -1281,7 +1286,7 @@ def complete(self):
self.status = BuildStatus.INSTALLING self.status = BuildStatus.INSTALLING
pkg.run_tests = tests is True or tests and pkg.name in tests pkg.run_tests = tests is True or tests and pkg.name in tests
# If task has been identified as a no operation, # If task has been identified as a no operation,
# return ExecuteResult.NOOP # return ExecuteResult.NOOP
if self.no_op: if self.no_op:
@ -1296,7 +1301,7 @@ def complete(self):
# raise spack.error.InstallError # raise spack.error.InstallError
if self.error_result is not None: if self.error_result is not None:
raise self.error_result raise self.error_result
# hook that allows tests to inspect the Package before installation # hook that allows tests to inspect the Package before installation
# see unit_test_check() docs. # see unit_test_check() docs.
if not pkg.unit_test_check(): if not pkg.unit_test_check():
@ -1518,7 +1523,6 @@ def _add_init_task(
self._push_task(task) self._push_task(task)
def _check_deps_status(self, request: BuildRequest) -> None: def _check_deps_status(self, request: BuildRequest) -> None:
"""Check the install status of the requested package """Check the install status of the requested package
@ -1872,7 +1876,7 @@ def _complete_task(self, task: Task, install_status: InstallStatus) -> None:
rc = task.complete() rc = task.complete()
if rc == ExecuteResult.MISSING_BUILD_SPEC: if rc == ExecuteResult.MISSING_BUILD_SPEC:
self._requeue_with_build_spec_tasks(task) self._requeue_with_build_spec_tasks(task)
elif rc == ExecuteResult.NO_OP: elif rc == ExecuteResult.NO_OP:
pass pass
else: # if rc == ExecuteResult.SUCCESS or rc == ExecuteResult.FAILED else: # if rc == ExecuteResult.SUCCESS or rc == ExecuteResult.FAILED
self._update_installed(task) self._update_installed(task)
@ -2116,8 +2120,9 @@ def _init_queue(self) -> None:
task.add_dependent(dependent_id) task.add_dependent(dependent_id)
self.all_dependencies = all_dependencies self.all_dependencies = all_dependencies
def start_task(
def start_task(self, task: Task, install_status: InstallStatus, term_status: TermStatusLine) -> None: self, task: Task, install_status: InstallStatus, term_status: TermStatusLine
) -> None:
"""Attempts to start a package installation.""" """Attempts to start a package installation."""
pkg, pkg_id, spec = task.pkg, task.pkg_id, task.pkg.spec pkg, pkg_id, spec = task.pkg, task.pkg_id, task.pkg.spec
install_status.next_pkg(pkg) install_status.next_pkg(pkg)
@ -2230,7 +2235,7 @@ def complete_task(self, task: Task, install_status: InstallStatus) -> Optional[T
action = task.install_action action = task.install_action
try: try:
self._complete_task(task, install_status) self._complete_task(task, install_status)
# If we installed then we should keep the prefix # If we installed then we should keep the prefix
stop_before_phase = getattr(pkg, "stop_before_phase", None) stop_before_phase = getattr(pkg, "stop_before_phase", None)
last_phase = getattr(pkg, "last_phase", None) last_phase = getattr(pkg, "last_phase", None)
@ -2263,13 +2268,13 @@ def complete_task(self, task: Task, install_status: InstallStatus) -> Optional[T
self.database.remove(task.pkg.spec) self.database.remove(task.pkg.spec)
tty.error( tty.error(
f"Recovery of install dir of {task.pkg.name} failed due to " f"Recovery of install dir of {task.pkg.name} failed due to "
f"{e.outer_exception.__class__.__name__}: {str(e.outer_exception)}. " f"{e.outer_exception.__class__.__name__}: {str(e.outer_exception)}. "
"The spec is now uninstalled." "The spec is now uninstalled."
) )
# Unwrap the actual installation exception. # Unwrap the actual installation exception.
raise e.inner_exception raise e.inner_exception
except (Exception, SystemExit) as exc: except (Exception, SystemExit) as exc:
self._update_failed(task, True, exc) self._update_failed(task, True, exc)
@ -2281,21 +2286,18 @@ def complete_task(self, task: Task, install_status: InstallStatus) -> Optional[T
# lower levels -- skip printing if already printed. # lower levels -- skip printing if already printed.
# TODO: sort out this and SpackError.print_context() # TODO: sort out this and SpackError.print_context()
tty.error( tty.error(
f"Failed to install {pkg.name} due to " f"Failed to install {pkg.name} due to " f"{exc.__class__.__name__}: {str(exc)}"
f"{exc.__class__.__name__}: {str(exc)}"
) )
# Terminate if requested to do so on the first failure. # Terminate if requested to do so on the first failure.
if self.fail_fast: if self.fail_fast:
raise spack.error.InstallError( raise spack.error.InstallError(f"{_fail_fast_err}: {str(exc)}", pkg=pkg) from exc
f"{_fail_fast_err}: {str(exc)}", pkg=pkg
) from exc
# Terminate when a single build request has failed, or summarize errors later. # Terminate when a single build request has failed, or summarize errors later.
if task.is_build_request: if task.is_build_request:
if len(self.build_requests) == 1: if len(self.build_requests) == 1:
raise raise
return (pkg, pkg_id, str(exc)) return (pkg, pkg_id, str(exc))
finally: finally:
# Remove the install prefix if anything went wrong during # Remove the install prefix if anything went wrong during
# install. # install.
@ -2357,7 +2359,6 @@ def install(self) -> None:
finally: finally:
active_tasks.remove(task) active_tasks.remove(task)
self._clear_removed_tasks() self._clear_removed_tasks()
if self.build_pq: if self.build_pq:
task = self._pop_task() task = self._pop_task()
@ -2640,6 +2641,7 @@ def build_process(pkg: "spack.package_base.PackageBase", install_args: dict) ->
with spack.util.path.filter_padding(): with spack.util.path.filter_padding():
return installer.run() return installer.run()
def overwrite_process(pkg: "spack.package_base.PackageBase", install_args: dict) -> bool: def overwrite_process(pkg: "spack.package_base.PackageBase", install_args: dict) -> bool:
# TODO:I don't know if this comment accurately reflects what's going on anymore # TODO:I don't know if this comment accurately reflects what's going on anymore
# TODO: think it should move to the error handling # TODO: think it should move to the error handling
@ -2650,6 +2652,7 @@ def overwrite_process(pkg: "spack.package_base.PackageBase", install_args: dict)
with fs.replace_directory_transaction(pkg.prefix): with fs.replace_directory_transaction(pkg.prefix):
return build_process(pkg, install_args) return build_process(pkg, install_args)
def deprecate(spec: "spack.spec.Spec", deprecator: "spack.spec.Spec", link_fn) -> None: def deprecate(spec: "spack.spec.Spec", deprecator: "spack.spec.Spec", link_fn) -> None:
"""Deprecate this package in favor of deprecator spec""" """Deprecate this package in favor of deprecator spec"""
# Here we assume we don't deprecate across different stores, and that same hash # Here we assume we don't deprecate across different stores, and that same hash