lsst.base  22.0.1+01bcf6a671
LSST Data Management Base Package
Classes | Functions | Variables
lsst.base.packages Namespace Reference

Classes

class  Packages
 

Functions

def getVersionFromPythonModule (module)
 
def getPythonPackages ()
 
def getEnvironmentPackages ()
 
def getCondaPackages ()
 
def pkg_representer (dumper, data)
 
def pkg_constructor (loader, node)
 

Variables

 log = logging.getLogger(__name__)
 
 BUILDTIME = set(["boost", "eigen", "tmv"])
 
 PYTHON = set(["galsim"])
 
 ENVIRONMENT = set(["astrometry_net", "astrometry_net_data", "minuit2", "xpa"])
 
 pkg_constructor
 
 Loader
 

Function Documentation

◆ getCondaPackages()

def lsst.base.packages.getCondaPackages ( )
Get products and their versions from the conda environment.

Returns
-------
packages : `dict`
    Keys (type `str`) are product names; values (type `str`) are their
    versions.

Notes
-----
Returns empty result if a conda environment is not in use or can not
be queried.

Definition at line 223 of file packages.py.

◆ getEnvironmentPackages()

def lsst.base.packages.getEnvironmentPackages ( )
Get products and their versions from the environment.

Returns
-------
packages : `dict`
    Keys (type `str`) are product names; values (type `str`) are their
    versions.

Notes
-----
We use EUPS to determine the version of certain products (those that don't
provide a means to determine the version any other way) and to check if
uninstalled packages are being used. We only report the product/version
for these packages.

Definition at line 154 of file packages.py.

◆ getPythonPackages()

def lsst.base.packages.getPythonPackages ( )
Get imported python packages and their versions.

Returns
-------
packages : `dict`
    Keys (type `str`) are package names; values (type `str`) are their
    versions.

Notes
-----
We wade through `sys.modules` and attempt to determine the version for each
module.  Note, therefore, that we can only report on modules that have
*already* been imported.

We don't include any module for which we cannot determine a version.

Definition at line 92 of file packages.py.

◆ getVersionFromPythonModule()

def lsst.base.packages.getVersionFromPythonModule (   module)
Determine the version of a python module.

Parameters
----------
module : `module`
    Module for which to get version.

Returns
-------
version : `str`

Raises
------
AttributeError
    Raised if __version__ attribute is not set.

Notes
-----
We supplement the version with information from the
``__dependency_versions__`` (a specific variable set by LSST's
`~lsst.sconsUtils` at build time) only for packages that are typically
used only at build-time.

Definition at line 57 of file packages.py.

◆ pkg_constructor()

def lsst.base.packages.pkg_constructor (   loader,
  node 
)

Definition at line 527 of file packages.py.

◆ pkg_representer()

def lsst.base.packages.pkg_representer (   dumper,
  data 
)
Represent Packages as a simple dict

Definition at line 518 of file packages.py.

Variable Documentation

◆ BUILDTIME

lsst.base.packages.BUILDTIME = set(["boost", "eigen", "tmv"])

Definition at line 45 of file packages.py.

◆ ENVIRONMENT

lsst.base.packages.ENVIRONMENT = set(["astrometry_net", "astrometry_net_data", "minuit2", "xpa"])

Definition at line 54 of file packages.py.

◆ Loader

lsst.base.packages.Loader

Definition at line 532 of file packages.py.

◆ log

lsst.base.packages.log = logging.getLogger(__name__)

Definition at line 38 of file packages.py.

◆ pkg_constructor

lsst.base.packages.pkg_constructor

Definition at line 532 of file packages.py.

◆ PYTHON

lsst.base.packages.PYTHON = set(["galsim"])

Definition at line 50 of file packages.py.