lsst.utils¶
The lsst.utils module provides common code for tests, interfacing between C++ and Python, and debugging.
Contributing¶
lsst.utils is developed at https://github.com/lsst/utils.
You can find Jira issues for this module under the utils component.
Python API reference¶
lsst.utils Package¶
Functions¶
| continueClass(cls) | Re-open the decorated class, adding any new definitions into the original. | 
| demangleType(arg0) | |
| deprecate_pybind11(func, reason[, category]) | Deprecate a pybind11-wrapped C++ interface function or method. | 
| doImport(importable) | Import a python object given an importable string and return it. | 
| getPackageDir(arg0) | |
| get_caller_name([skip]) | Get the name of the caller method. | 
| inClass(cls[, name]) | Add the decorated function to the given class as a method. | 
Classes¶
| TemplateMeta | A metaclass for abstract base classes that tie together wrapped C++ template types. | 
Class Inheritance Diagram¶
lsst.utils.tests Module¶
Functions¶
| init() | Initialize the memory tester and file descriptor leak tester. | 
| run(suite[, exit]) | Run a test suite and report the test return status to caller or shell. | 
| getTempFilePath(ext[, expectOutput]) | Return a path suitable for a temporary file and try to delete the file on success | 
| assertFloatsAlmostEqual(testCase, lhs, rhs) | Highly-configurable floating point comparisons for scalars and arrays. | 
| assertFloatsNotEqual(testCase, lhs, rhs, **kwds) | Fail a test if the given floating point values are equal to within the given tolerances. | 
| assertFloatsEqual(testCase, lhs, rhs, **kwargs) | Assert that lhs == rhs (both numeric types, whether scalar or array). | 
Classes¶
| MemoryTestCase([methodName]) | Check for memory leaks since memId0 was allocated | 
| ExecutablesTestCase([methodName]) | Test that executables can be run and return good status. | 
| TestCase([methodName]) | Subclass of unittest.TestCase that adds some custom assertions for convenience. |