Coverage for cuda / pathfinder / __init__.py: 100.00%

1# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 

2# SPDX-License-Identifier: Apache-2.0 

3 

4"""cuda.pathfinder public APIs""" 

5 

6from cuda.pathfinder._binaries.find_nvidia_binary_utility import ( (empty)

7 find_nvidia_binary_utility as find_nvidia_binary_utility, 

8) 

9from cuda.pathfinder._binaries.supported_nvidia_binaries import SUPPORTED_BINARIES as _SUPPORTED_BINARIES (empty)

10from cuda.pathfinder._dynamic_libs.load_dl_common import ( (empty)

11 DynamicLibNotAvailableError as DynamicLibNotAvailableError, 

12) 

13from cuda.pathfinder._dynamic_libs.load_dl_common import DynamicLibNotFoundError as DynamicLibNotFoundError (empty)

14from cuda.pathfinder._dynamic_libs.load_dl_common import ( (empty)

15 DynamicLibUnknownError as DynamicLibUnknownError, 

16) 

17from cuda.pathfinder._dynamic_libs.load_dl_common import LoadedDL as LoadedDL (empty)

18from cuda.pathfinder._dynamic_libs.load_nvidia_dynamic_lib import load_nvidia_dynamic_lib as load_nvidia_dynamic_lib (empty)

19from cuda.pathfinder._dynamic_libs.supported_nvidia_libs import ( (empty)

20 SUPPORTED_LIBNAMES as SUPPORTED_NVIDIA_LIBNAMES, 

21) 

22from cuda.pathfinder._headers.find_nvidia_headers import LocatedHeaderDir as LocatedHeaderDir (empty)

23from cuda.pathfinder._headers.find_nvidia_headers import find_nvidia_header_directory as find_nvidia_header_directory (empty)

24from cuda.pathfinder._headers.find_nvidia_headers import ( (empty)

25 locate_nvidia_header_directory as locate_nvidia_header_directory, 

26) 

27from cuda.pathfinder._headers.supported_nvidia_headers import SUPPORTED_HEADERS_CTK as _SUPPORTED_HEADERS_CTK (empty)

28from cuda.pathfinder._optional_cuda_import import optional_cuda_import as optional_cuda_import (empty)

29from cuda.pathfinder._static_libs.find_bitcode_lib import ( (empty)

30 SUPPORTED_BITCODE_LIBS as _SUPPORTED_BITCODE_LIBS, 

31) 

32from cuda.pathfinder._static_libs.find_bitcode_lib import ( (empty)

33 BitcodeLibNotFoundError as BitcodeLibNotFoundError, 

34) 

35from cuda.pathfinder._static_libs.find_bitcode_lib import ( (empty)

36 LocatedBitcodeLib as LocatedBitcodeLib, 

37) 

38from cuda.pathfinder._static_libs.find_bitcode_lib import ( (empty)

39 find_bitcode_lib as find_bitcode_lib, 

40) 

41from cuda.pathfinder._static_libs.find_bitcode_lib import ( (empty)

42 locate_bitcode_lib as locate_bitcode_lib, 

43) 

44from cuda.pathfinder._static_libs.find_static_lib import ( (empty)

45 SUPPORTED_STATIC_LIBS as _SUPPORTED_STATIC_LIBS, 

46) 

47from cuda.pathfinder._static_libs.find_static_lib import ( (empty)

48 LocatedStaticLib as LocatedStaticLib, 

49) 

50from cuda.pathfinder._static_libs.find_static_lib import ( (empty)

51 StaticLibNotFoundError as StaticLibNotFoundError, 

52) 

53from cuda.pathfinder._static_libs.find_static_lib import ( (empty)

54 find_static_lib as find_static_lib, 

55) 

56from cuda.pathfinder._static_libs.find_static_lib import ( (empty)

57 locate_static_lib as locate_static_lib, 

58) 

59 

60from cuda.pathfinder._version import __version__ # isort: skip (empty)

61 

62# Indirections to help Sphinx find the docstrings. 

63#: Mapping from short CUDA Toolkit (CTK) library names to their canonical 

64#: header basenames (used to validate a discovered include directory). 

65#: Example: ``"cublas" → "cublas.h"``. The key set is platform-aware 

66#: (e.g., ``"cufile"`` may be Linux-only). 

67SUPPORTED_HEADERS_CTK = _SUPPORTED_HEADERS_CTK (empty)

68 

69#: Tuple of supported CUDA binary utility names that can be located 

70#: via ``find_nvidia_binary_utility()``. Platform-aware (e.g., some 

71#: utilities may be available only on Linux or Windows). 

72#: Example utilities: ``"nvdisasm"``, ``"cuobjdump"``, ``"nvcc"``. 

73SUPPORTED_BINARY_UTILITIES = _SUPPORTED_BINARIES (empty)

74 

75#: Tuple of supported bitcode library names that can be resolved 

76#: via ``locate_bitcode_lib()`` and ``find_bitcode_lib()``. 

77#: Example value: ``"device"``. 

78SUPPORTED_BITCODE_LIBS = _SUPPORTED_BITCODE_LIBS (empty)

79 

80#: Tuple of supported static library names that can be resolved 

81#: via ``locate_static_lib()`` and ``find_static_lib()``. 

82#: Example value: ``"cudadevrt"``. 

83SUPPORTED_STATIC_LIBS = _SUPPORTED_STATIC_LIBS (empty)

84 

85# Backward compatibility: _find_nvidia_header_directory was added in release 1.2.2. 

86# It will be removed in release 1.2.4. 

87_find_nvidia_header_directory = find_nvidia_header_directory (empty)