Source code for geefcc

"""
geefcc: Forest cover change from Google Earth Engine.
https://ecology.ghislainv.fr/geefcc/
"""

# Standard library imports
import logging
import warnings
from typing import TYPE_CHECKING

# Module-level dunder names
# https://peps.python.org/pep-0008/#module-level-dunder-names
__author__ = "Ghislain Vieilledent and Thomas Arsouze"
__email__ = "ghislain.vieilledent@cirad.fr, thomas.arsouze@cirad.fr"
__version__ = "0.1.8"
__license__ = "GPL-3.0"
__all__ = [
    "ee_initialize",
    "get_fcc_loss_gain",
    "get_fcc_loss",
    "get_fcc",
    "sum_raster_bands",
    "make_dir",
]

# Third-party imports
from osgeo import gdal

# Local imports
from .ee_initialize import ee_initialize
from .get_fcc_loss_gain import get_fcc_loss_gain
from .get_fcc_loss import get_fcc_loss
from .sum_raster_bands import sum_raster_bands
from .misc import make_dir

# ------------------------------------
# GDAL configuration
# ------------------------------------
# Suppress GDAL warnings/errors from STDERR
gdal.PushErrorHandler("CPLQuietErrorHandler")
# Raise Python exceptions for GDAL errors (warnings won't raise)
gdal.UseExceptions()

# ------------------------------------
# Logging configuration
# ------------------------------------
logging.getLogger(__name__).addHandler(logging.NullHandler())

# ------------------------------------
# Alias
# ------------------------------------

# Type hinting for IDEs and Mypy (Static analysis only)
if TYPE_CHECKING:
    # Tells IDEs that functions shares
    # the exact same type and signature
    get_fcc = get_fcc_loss

# Runtime execution (For Python and Sphinx documentation)
else:


    def get_fcc(*args, **kwargs):
        """
        .. deprecated:: 0.1.8
           Use :func:`get_fcc_loss` instead. This alias will be removed
        in a future release.
        """
        warnings.warn(
            "The alias 'get_fcc' is deprecated and will "
            "be removed in a future version. "
            "Please use 'get_fcc_loss' instead.",
            category=DeprecationWarning,
            stacklevel=2
        )
        return get_fcc_loss(*args, **kwargs)


    # Maintain original metadata for standard help() inspection
    get_fcc.__name__ = "get_fcc"
    get_fcc.__doc__ = (
        ".. deprecated:: 0.1.8\n"
        "   Use :func:`get_fcc_loss` instead.\n\n"
    ) + (get_fcc_loss.__doc__ or "")
    get_fcc.__wrapped__ = get_fcc_loss

# End