lsst.base  16.0-1-g928b041+1
LSST Data Management Base Package
Public Member Functions | List of all members
lsst.base.packages.Packages Class Reference
Inheritance diagram for lsst.base.packages.Packages:

Public Member Functions

def __init__ (self, packages)
 
def fromSystem (cls)
 
def read (cls, filename)
 
def write (self, filename)
 
def __len__ (self)
 
def __str__ (self)
 
def __repr__ (self)
 
def __contains__ (self, pkg)
 
def __iter__ (self)
 
def update (self, other)
 
def extra (self, other)
 
def missing (self, other)
 
def difference (self, other)
 

Detailed Description

A table of packages and their versions.

Parameters
----------
packages : `dict`
    A mapping {package: version} where both keys and values are type `str`.

Notes
-----
This is essentially a wrapper around a dict with some conveniences.

Definition at line 237 of file packages.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.base.packages.Packages.__init__ (   self,
  packages 
)

Definition at line 250 of file packages.py.

Member Function Documentation

◆ __contains__()

def lsst.base.packages.Packages.__contains__ (   self,
  pkg 
)

Definition at line 312 of file packages.py.

◆ __iter__()

def lsst.base.packages.Packages.__iter__ (   self)

Definition at line 315 of file packages.py.

◆ __len__()

def lsst.base.packages.Packages.__len__ (   self)

Definition at line 298 of file packages.py.

◆ __repr__()

def lsst.base.packages.Packages.__repr__ (   self)

Definition at line 309 of file packages.py.

◆ __str__()

def lsst.base.packages.Packages.__str__ (   self)

Definition at line 301 of file packages.py.

◆ difference()

def lsst.base.packages.Packages.difference (   self,
  other 
)
Get packages in symmetric difference of self and another `Packages` object.

Parameters
----------
other : `Packages`
    Other packages to compare against.

Returns
-------
difference : `dict`
    Packages in symmetric difference.
    Keys (type `str`) are package names; values (type `str`) are their versions.

Definition at line 365 of file packages.py.

◆ extra()

def lsst.base.packages.Packages.extra (   self,
  other 
)
Get packages in self but not in another `Packages` object.

Parameters
----------
other : `Packages`
    Other packages to compare against.

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

Definition at line 333 of file packages.py.

◆ fromSystem()

def lsst.base.packages.Packages.fromSystem (   cls)
Construct a `Packages` by examining the system.

Determine packages by examining python's sys.modules, runtime libraries and EUPS.

Returns
-------
packages : `Packages`

Definition at line 256 of file packages.py.

◆ missing()

def lsst.base.packages.Packages.missing (   self,
  other 
)
Get packages in another `Packages` object but missing from self.

Parameters
----------
other : `Packages`
    Other packages to compare against.

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

Definition at line 349 of file packages.py.

◆ read()

def lsst.base.packages.Packages.read (   cls,
  filename 
)
Read packages from filename.

Parameters
----------
filename : `str`
    Filename from which to read.

Returns
-------
packages : `Packages`

Definition at line 272 of file packages.py.

◆ update()

def lsst.base.packages.Packages.update (   self,
  other 
)
Update packages with contents of another set of packages.

Parameters
----------
other : `Packages`
    Other packages to merge with self.

Notes
-----
No check is made to see if we're clobbering anything.

Definition at line 318 of file packages.py.

◆ write()

def lsst.base.packages.Packages.write (   self,
  filename 
)
Write to file.

Parameters
----------
filename : `str`
    Filename to which to write.

Definition at line 287 of file packages.py.


The documentation for this class was generated from the following file: