Source code for scitex_pd._ignore_SettingWithCopyWarning

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Time-stamp: "2024-11-05 07:35:30 (ywatanabe)"
# File: ./scitex_repo/src/scitex/pd/_ignore_.py

import warnings
from contextlib import contextmanager




@contextmanager
def ignore_setting_with_copy_warning():
    """
    Context manager to temporarily ignore pandas SettingWithCopyWarning.

    Example
    -------
    >>> with ignore_SettingWithCopyWarning():
    ...     df['column'] = new_values  # No warning will be shown
    """
    SettingWithCopyWarning = None
    try:
        from pandas.errors import SettingWithCopyWarning  # pandas <2.2
    except ImportError:
        try:
            from pandas.core.common import SettingWithCopyWarning  # pandas <2.0
        except ImportError:
            SettingWithCopyWarning = None  # pandas >=2.2 removed this warning class

    # Save current warning filters
    with warnings.catch_warnings():
        if SettingWithCopyWarning is not None:
            warnings.simplefilter(action="ignore", category=SettingWithCopyWarning)
        else:
            # In pandas >=2.2 the warning was removed; nothing to suppress.
            pass
        yield



# Backward compatibility
ignore_SettingWithCopyWarning = ignore_setting_with_copy_warning  # Deprecated

# EOF