Skip to content

deprecated

deprecated(deprecated_in, removed_in, help_message=None)

Mark functions as deprecated.

Adding this will result in a warning being emitted when the function is used.

Source code in pyiceberg/utils/deprecated.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def deprecated(deprecated_in: str, removed_in: str, help_message: Optional[str] = None) -> Callable:  # type: ignore
    """Mark functions as deprecated.

    Adding this will result in a warning being emitted when the function is used.
    """
    if help_message is not None:
        help_message = f" {help_message}."

    def decorator(func: Callable):  # type: ignore
        @functools.wraps(func)
        def new_func(*args: Any, **kwargs: Any) -> Any:
            message = f"Call to {func.__name__}, deprecated in {deprecated_in}, will be removed in {removed_in}.{help_message}"

            _deprecation_warning(message)

            return func(*args, **kwargs)

        return new_func

    return decorator

deprecation_message(deprecated_in, removed_in, help_message)

Mark properties or behaviors as deprecated.

Adding this will result in a warning being emitted.

Source code in pyiceberg/utils/deprecated.py 
49
50
51
52
53
54
def deprecation_message(deprecated_in: str, removed_in: str, help_message: Optional[str]) -> None:
    """Mark properties or behaviors as deprecated.

    Adding this will result in a warning being emitted.
    """
    _deprecation_warning(deprecation_notice(deprecated_in, removed_in, help_message))

deprecation_notice(deprecated_in, removed_in, help_message)

Return a deprecation notice.

Source code in pyiceberg/utils/deprecated.py 
44
45
46
def deprecation_notice(deprecated_in: str, removed_in: str, help_message: Optional[str]) -> str:
    """Return a deprecation notice."""
    return f"Deprecated in {deprecated_in}, will be removed in {removed_in}. {help_message}"