lsst.daf.persistence g17e5ecfddb+42b2f4d84e
Classes | Functions | Variables
lsst.daf.persistence.deprecation Namespace Reference

Classes

class  Deprecator
 

Functions

def deprecateGen2 (component=None)
 
def deprecate_class (cls)
 

Variables

bool always_warn = False
 

Function Documentation

◆ deprecate_class()

def lsst.daf.persistence.deprecation.deprecate_class (   cls)

Definition at line 151 of file deprecation.py.

◆ deprecateGen2()

def lsst.daf.persistence.deprecation.deprecateGen2 (   component = None)
Issue deprecation warning for Butler.

Parameters
----------
component : `str`, optional
    Name of component to warn about. If `None` will only issue a warning
    if no other warnings have been issued.

Notes
-----
The package variable `lsst.daf.persistence.deprecation.always_warn` can be
set to `True` to always issue a warning rather than only issuing
on first encounter. If set to `None` only a single message will ever
be issued.

Definition at line 52 of file deprecation.py.

Variable Documentation

◆ always_warn

bool lsst.daf.persistence.deprecation.always_warn = False

Definition at line 29 of file deprecation.py.