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.

def deprecate_class(cls):
    return Deprecator()(cls)

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.

def 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.
    """
    global _issued
 
    if always_warn:
        # Sidestep all the logic and always issue the warning
        pass
    elif always_warn is None and _issued:
        # We have already issued so return immediately
        return
    else:
        # Either we've already issued a warning for this component
        # or it's a null component and we've issued something already.
        # In this situation we do not want to warn again.
        if _issued.get(component, False) or (component is None and _issued):
            return
 
    # Calculate a stacklevel that pops the warning out of daf_persistence
    # and into user code.
    stacklevel = 3  # Default to the caller's caller
    stack = traceback.extract_stack()
    for i, s in enumerate(reversed(stack)):
        if not ("python/lsst/daf/persistence" in s.filename or "python/lsst/obs/base" in s.filename):
            stacklevel = i + 1
            break
 
    label = ""
    if component is not None and always_warn is not None:
        label = f" ({component})"
 
    warnings.warn(_warning_msg.format(label=label), category=FutureWarning, stacklevel=stacklevel)
    _issued[component] = True
 
 

Variable Documentation

always_warn

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

Definition at line 29 of file deprecation.py.