spack.llnl package

Subpackages

• spack.llnl.util package
  • Subpackages
    • spack.llnl.util.tty package
      • SuppressOutput
      • debug()
      • debug_level()
      • die()
      • error()
      • error_enabled()
      • get_timestamp()
      • get_yes_or_no()
      • hline()
      • info()
      • is_debug()
      • is_verbose()
      • msg()
      • msg_enabled()
      • output_filter()
      • process_stacktrace()
      • set_debug()
      • set_error_enabled()
      • set_msg_enabled()
      • set_stacktrace()
      • set_timestamp()
      • set_verbose()
      • set_warn_enabled()
      • show_pid()
      • verbose()
      • warn()
      • warn_enabled()
      • Submodules
      • spack.llnl.util.tty.colify module
      • spack.llnl.util.tty.color module
      • spack.llnl.util.tty.log module
  • Submodules
  • spack.llnl.util.argparsewriter module
    • ArgparseRstWriter
      • ArgparseRstWriter.begin_command()
      • ArgparseRstWriter.begin_optionals()
      • ArgparseRstWriter.begin_positionals()
      • ArgparseRstWriter.begin_subcommands()
      • ArgparseRstWriter.description()
      • ArgparseRstWriter.end_optionals()
      • ArgparseRstWriter.end_positionals()
      • ArgparseRstWriter.format()
      • ArgparseRstWriter.optional()
      • ArgparseRstWriter.positional()
      • ArgparseRstWriter.usage()
    • ArgparseWriter
      • ArgparseWriter.format()
      • ArgparseWriter.parse()
      • ArgparseWriter.write()
    • Command
  • spack.llnl.util.filesystem module
    • BaseDirectoryVisitor
      • BaseDirectoryVisitor.after_visit_dir()
      • BaseDirectoryVisitor.after_visit_symlinked_dir()
      • BaseDirectoryVisitor.before_visit_dir()
      • BaseDirectoryVisitor.before_visit_symlinked_dir()
      • BaseDirectoryVisitor.visit_file()
      • BaseDirectoryVisitor.visit_symlinked_file()
    • FileFilter
      • FileFilter.filter()
    • FileList
      • FileList.basenames
      • FileList.directories
      • FileList.joined()
    • HeaderList
      • HeaderList.add_macro()
      • HeaderList.cpp_flags
      • HeaderList.directories
      • HeaderList.headers
      • HeaderList.include_flags
      • HeaderList.include_regex
      • HeaderList.macro_definitions
      • HeaderList.names
    • LibraryList
      • LibraryList.ld_flags
      • LibraryList.libraries
      • LibraryList.link_flags
      • LibraryList.names
      • LibraryList.search_flags
    • ancestor()
    • can_access()
    • change_sed_delimiter()
    • chgrp()
    • chmod_x()
    • copy()
    • copy_mode()
    • copy_tree()
    • filter_file()
    • find()
    • find_all_headers()
    • find_first()
    • find_headers()
    • find_libraries()
    • find_system_libraries()
    • force_remove()
    • force_symlink()
    • getuid()
    • install()
    • install_tree()
    • is_exe()
    • join_path()
    • keep_modification_time()
    • library_extensions
    • mkdirp()
    • partition_path()
    • prefixes()
    • remove_dead_links()
    • remove_directory_contents()
    • remove_if_dead_link()
    • remove_linked_tree()
    • rename()
    • set_executable()
    • set_install_permissions()
    • touch()
    • touchp()
    • traverse_tree()
    • unset_executable_mode()
    • visit_directory_tree()
    • working_dir()
  • spack.llnl.util.lang module
    • ClassProperty
    • Const
      • Const.value
    • DeprecatedProperty
      • DeprecatedProperty.error_lvl
      • DeprecatedProperty.factory()
      • DeprecatedProperty.name
    • GroupedExceptionForwarder
    • GroupedExceptionHandler
      • GroupedExceptionHandler.exceptions
      • GroupedExceptionHandler.forward()
      • GroupedExceptionHandler.grouped_message()
    • HashableMap
      • HashableMap.dict
    • ObjectWrapper
    • PriorityOrderedMapping
      • PriorityOrderedMapping.add()
      • PriorityOrderedMapping.priority_values()
      • PriorityOrderedMapping.remove()
      • PriorityOrderedMapping.reversed_keys()
      • PriorityOrderedMapping.reversed_values()
    • Singleton
      • Singleton.instance
    • SingletonInstantiationError
    • TypedMutableSequence
      • TypedMutableSequence.insert()
    • UnhashableArguments
    • attr_setdefault()
    • classproperty
    • decorator_with_or_without_args()
    • dedupe()
    • done
    • elide_list()
    • ensure_last()
    • fnmatch_translate_multiple()
    • get_entry_points()
    • index_by()
    • key_ordering()
    • lazy_eq()
    • lazy_lexicographic_ordering()
    • lazy_lt()
    • list_modules()
    • load_module_from_file()
    • match_predicate()
    • memoized()
    • nullcontext()
    • pretty_date()
    • pretty_duration()
    • pretty_seconds()
    • pretty_seconds_formatter()
    • pretty_string_to_date()
    • stable_partition()
    • tuplify()
    • uniq()
  • spack.llnl.util.link_tree module
    • LinkTree
      • LinkTree.find_conflict()
      • LinkTree.find_dir_conflicts()
      • LinkTree.get_file_map()
      • LinkTree.merge()
      • LinkTree.merge_directories()
      • LinkTree.unmerge()
      • LinkTree.unmerge_directories()
  • spack.llnl.util.lock module
    • CantCreateLockError
    • Lock
      • Lock.acquire_read()
      • Lock.acquire_write()
      • Lock.cleanup()
      • Lock.downgrade_write_to_read()
      • Lock.is_write_locked()
      • Lock.release_read()
      • Lock.release_write()
      • Lock.try_acquire_read()
      • Lock.try_acquire_write()
      • Lock.upgrade_read_to_write()
    • LockDowngradeError
    • LockError
    • LockPermissionError
    • LockROFileError
    • LockTimeoutError
    • LockTransaction
    • LockUpgradeError
    • ReadTransaction
    • WriteTransaction
  • spack.llnl.util.symlink module

Submodules

spack.llnl.path module

Path primitives that just require Python standard library.

class spack.llnl.path.Path

Bases: object

Enum to identify the path-style.

platform_path: int

unix: int

windows: int

spack.llnl.path.convert_to_platform_path(path: str) → str

Converts the input path to the current platform’s native style.

spack.llnl.path.convert_to_posix_path(path: str) → str

Converts the input path to POSIX style.

spack.llnl.path.format_os_path(path: str, mode: int = Path.unix) → str

Formats the input path to use consistent, platform specific separators.

Absolute paths are converted between drive letters and a prepended / as per platform requirement.

Parameters:

• path – the path to be normalized, must be a string or expose the replace method.

• mode – the path file separator style to normalize the passed path to. Default is unix style, i.e. /

spack.llnl.path.path_to_os_path(*parameters: str) → List[str]

Takes an arbitrary number of positional parameters, converts each argument of type string to use a normalized filepath separator, and returns a list of all values.

spack.llnl.path.sanitize_win_longpath(path: str) → str

Strip Windows extended path prefix from strings Returns sanitized string. no-op if extended path prefix is not present

spack.llnl.path.system_path_filter(_func=None, arg_slice: slice | None = None)

spack.llnl.string module

String manipulation functions that do not have other dependencies than Python standard library

spack.llnl.string.comma_and(sequence: List[str]) → str

Return a string with all the elements of the input joined by comma, but the last one (which is joined by "and").

spack.llnl.string.comma_list(sequence: Sequence[str], article: str = '') → str

spack.llnl.string.comma_or(sequence: Sequence[str]) → str

Return a string with all the elements of the input joined by comma, but the last one (which is joined by "or").

spack.llnl.string.ordinal(number: int) → str

Return the ordinal representation (1st, 2nd, 3rd, etc.) for the provided number.

Parameters:

number – int to convert to ordinal number

Returns: number’s corresponding ordinal

spack.llnl.string.plural(n: int, singular: str, plural: str | None = None, show_n: bool = True) → str

Pluralize <singular> word by adding an s if n != 1.

Parameters:

• n – number of things there are

• singular – singular form of word

• plural – optional plural form, for when it’s not just singular + ‘s’

• show_n – whether to include n in the result string (default True)

Returns:

“1 thing” if n == 1 or “n things” if n != 1

spack.llnl.string.quote(sequence: List[str], q: str = "'") → List[str]

Quotes each item in the input list with the quote character passed as second argument.

spack.llnl.url module

URL primitives that just require Python standard library.

spack.llnl.url.allowed_archive(path_or_url: str) → bool

Returns true if the input is a valid archive, False otherwise.

spack.llnl.url.check_and_remove_ext(path: str, *, extension: str) → str

Returns the input path with the extension removed, if the extension is present in path. Otherwise, returns the input unchanged.

spack.llnl.url.compression_ext_from_compressed_archive(extension: str) → str | None

Returns compression extension for a compressed archive

spack.llnl.url.determine_url_file_extension(path: str) → str

This returns the type of archive a URL refers to. This is sometimes confusing because of URLs like:

1. https://github.com/petdance/ack/tarball/1.93_02

Where the URL doesn’t actually contain the filename. We need to know what type it is so that we can appropriately name files in mirrors.

spack.llnl.url.expand_contracted_extension(extension: str) → str

Returns the expanded version of a known contracted extension.

This function maps extensions like .tgz to .tar.gz. On unknown extensions, return the input unmodified.

spack.llnl.url.expand_contracted_extension_in_path(path_or_url: str, *, extension: str | None = None) → str

Returns the input path or URL with any contraction extension expanded.

Parameters:

• path_or_url – path or URL to be expanded

• extension – if specified, only attempt to expand that extension

spack.llnl.url.extension_from_path(path_or_url: str | None) → str | None

Tries to match an allowed archive extension to the input. Returns the first match, or None if no match was found.

Raises:

ValueError – if the input is None

spack.llnl.url.find_list_urls(url: str) → Set[str]

Find good list URLs for the supplied URL.

By default, returns the dirname of the archive path.

Provides special treatment for the following websites, which have a unique list URL different from the dirname of the download URL:

GitHub	https://github.com/<repo>/<name>/releases
GitLab	https://gitlab.\*/<repo>/<name>/tags
BitBucket	https://bitbucket.org/<repo>/<name>/downloads/?tab=tags
CRAN	https://\*.r-project.org/src/contrib/Archive/<name>
PyPI	https://pypi.org/simple/<name>/
LuaRocks	https://luarocks.org/modules/<repo>/<name>

Note: this function is called by spack versions, spack checksum, and spack create, but not by spack fetch or spack install.

Parameters:

url (str) – The download URL for the package

Returns:

One or more list URLs for the package

Return type:

set

spack.llnl.url.has_extension(path_or_url: str, ext: str) → bool

Returns true if the extension in input is present in path, false otherwise.

spack.llnl.url.remove_extension(path_or_url: str, *, extension: str) → str

Returns the input with the extension removed

spack.llnl.url.split_url_extension(url: str) → Tuple[str, ...]

Some URLs have a query string, e.g.:

1. https://github.com/losalamos/CLAMR/blob/packages/PowerParser_v2.0.7.tgz?raw=true

2. http://www.apache.org/dyn/closer.cgi?path=/cassandra/1.2.0/apache-cassandra-1.2.0-rc2-bin.tar.gz

3. https://gitlab.kitware.com/vtk/vtk/repository/archive.tar.bz2?ref=v7.0.0

In (1), the query string needs to be stripped to get at the extension, but in (2) & (3), the filename is IN a single final query argument.

This strips the URL into three pieces: prefix, ext, and suffix. The suffix contains anything that was stripped off the URL to get at the file extension. In (1), it will be '?raw=true', but in (2), it will be empty. In (3) the suffix is a parameter that follows after the file extension, e.g.:

1. ('https://github.com/losalamos/CLAMR/blob/packages/PowerParser_v2.0.7', '.tgz', '?raw=true')

2. ('http://www.apache.org/dyn/closer.cgi?path=/cassandra/1.2.0/apache-cassandra-1.2.0-rc2-bin', '.tar.gz', None)

3. ('https://gitlab.kitware.com/vtk/vtk/repository/archive', '.tar.bz2', '?ref=v7.0.0')

spack.llnl.url.split_url_on_sourceforge_suffix(url: str) → Tuple[str, ...]

If the input is a sourceforge URL, returns base URL and /download suffix. Otherwise, returns the input URL and an empty string.

spack.llnl.url.strip_compression_extension(path_or_url: str, ext: str | None = None) → str

Strips the compression extension from the input, and returns it. For instance, "foo.tgz" becomes "foo.tar".

If no extension is given, try a default list of extensions.

Parameters:

• path_or_url – input to be stripped

• ext – if given, extension to be stripped

spack.llnl.url.strip_extension(path_or_url: str, *, extension: str | None = None) → str

If a path contains the extension in input, returns the path stripped of the extension. Otherwise, returns the input path.

If extension is None, attempts to strip any allowed extension from path.

spack.llnl.url.strip_query_and_fragment(url: str) → Tuple[str, str]

Strips query and fragment from a url, then returns the base url and the suffix.

Parameters:

url – URL to be stripped

Raises:

ValueError – when there is any error parsing the URL

spack.llnl.url.strip_version_suffixes(path_or_url: str) → str

Some tarballs contain extraneous information after the version:

• bowtie2-2.2.5-source

• libevent-2.0.21-stable

• cuda_8.0.44_linux.run

These strings are not part of the version number and should be ignored. This function strips those suffixes off and returns the remaining string. The goal is that the version is always the last thing in path:

• bowtie2-2.2.5

• libevent-2.0.21

• cuda_8.0.44

Parameters:

path_or_url – The filename or URL for the package

Returns:

The path with any extraneous suffixes removed