Upload folder using huggingface_hub (part 4)

9b0e299 verified about 1 month ago

4.99 kB

"""Deprecation tooling for Python functions and classes.
This package provides a simple decorator-based approach to deprecate functions,
methods, and classes while automatically forwarding calls to their replacements.
Main Features:
    - Automatic call forwarding to new implementations
    - Argument mapping and renaming between old and new APIs
    - Customizable warning messages and output streams
    - Per-function and per-argument warning tracking to prevent log spam
    - Support for multiple deprecation levels via decorator stacking
    - Audit tools for CI pipelines: wrapper validation, expiry enforcement, chain detection
    - Testing utilities for writing deterministic tests
Core Components:
**Main Decorator** (:mod:`deprecate.deprecation`):
    - :func:`~deprecate.deprecation.deprecated`: Decorator for marking functions/methods as deprecated
    - :func:`~deprecate.utils.void`: Silences IDE and mypy warnings about unused parameters in deprecated stubs
**Audit** (:mod:`deprecate.audit`):
    - :func:`~deprecate.audit.validate_deprecation_wrapper`: Validate a single wrapper's configuration
    - :func:`~deprecate.audit.find_deprecation_wrappers`: Scan a package for all deprecated wrappers
    - :func:`~deprecate.audit.generate_deprecation_table`: Build compact or matrix markdown deprecation tables
    - :func:`~deprecate.audit.validate_deprecation_expiry`: Detect wrappers that outlived their ``remove_in`` deadline
    - :func:`~deprecate.audit.validate_deprecation_chains`: Detect deprecated wrappers chaining to
      other deprecated wrappers
    - :class:`~deprecate.audit.DeprecationWrapperInfo`: Structured result returned by the audit functions
    - :class:`~deprecate.audit.ChainType`: Enum describing the kind of deprecation chain detected
**Proxy** (:mod:`deprecate.proxy`):
    - :func:`~deprecate.proxy.deprecated_instance`: Wrap any object with deprecation warnings
    - :func:`~deprecate.proxy.deprecated_class`: Decorator for deprecating Enum/dataclass definitions
**Testing** (:mod:`deprecate.utils`):
    - :func:`~deprecate.utils.assert_no_warnings`: Context manager asserting that no warnings are raised
Quick Example:
    >>> from deprecate import deprecated
    >>>
    >>> def new_function(x: int) -> int:
    ...     '''New implementation.'''
    ...     return x * 2
    >>>
    >>> @deprecated(target=new_function, deprecated_in="1.0", remove_in="2.0")
    ... def old_function(x: int) -> int:
    ...     '''Old implementation - calls forwarded automatically.'''
    ...     pass
    >>>
    >>> result = old_function(5)  # Shows warning, returns 10
    >>> print(result)
    10
Complete Documentation:
    For detailed examples and use cases, see:
    https://borda.github.io/pyDeprecate
    Topics covered:
    - Simple function forwarding
    - Advanced argument mapping
    - Warning-only deprecation (``TargetMode.NOTIFY``)
    - Self-deprecation (``TargetMode.ARGS_REMAP``)
    - Multiple deprecation levels
    - Conditional skip (skip_if parameter)
    - Class deprecation
    - Automatic docstring updates
    - Auditing: wrapper configuration, expiry enforcement, chain detection
    - Testing deprecated code
"""

from deprecate.__about__ import *  # noqa: F403
from deprecate._types import TargetMode
from deprecate.audit import (
    ChainType,
    DeprecatedCallableInfo,  # noqa: F401 # backward-compat alias for DeprecationWrapperInfo
    DeprecationStatus,
    DeprecationWrapperInfo,
    TableStyle,
    find_deprecated_callables,  # noqa: F401 # deprecated since 0.6, use find_deprecation_wrappers
    find_deprecation_wrappers,
    generate_deprecation_table,
    validate_deprecated_callable,  # noqa: F401 # deprecated since 0.6, use validate_deprecation_wrapper
    validate_deprecation_chains,
    validate_deprecation_expiry,
    validate_deprecation_wrapper,
    validate_mapping_compatibility,
)

# Opt-in strict ``property`` replacement: ``from deprecate import property`` shadows the builtin
# in the importing module only, rejecting inner-order ``@property @deprecated`` at class-body time.
from deprecate.deprecation import (
    _StrictProperty as property,  # noqa: F401 # intentional: explicit-import only; excluded from __all__ to prevent star-import from silently enabling strict mode
)
from deprecate.deprecation import deprecated
from deprecate.proxy import deprecated_class, deprecated_instance
from deprecate.utils import (
    assert_no_warnings,
    no_warning_call,  # noqa: F401 # deprecated since 0.6, use assert_no_warnings
    void,
)

__all__ = [
    "ChainType",
    "DeprecationStatus",
    "DeprecationWrapperInfo",
    "TableStyle",
    "TargetMode",
    "assert_no_warnings",
    "deprecated",
    "deprecated_class",
    "deprecated_instance",
    "find_deprecation_wrappers",
    "generate_deprecation_table",
    "validate_deprecation_chains",
    "validate_deprecation_expiry",
    "validate_deprecation_wrapper",
    "validate_mapping_compatibility",
    "void",
]

	"""Deprecation tooling for Python functions and classes.

	This package provides a simple decorator-based approach to deprecate functions,
	methods, and classes while automatically forwarding calls to their replacements.

	Main Features:
	- Automatic call forwarding to new implementations
	- Argument mapping and renaming between old and new APIs
	- Customizable warning messages and output streams
	- Per-function and per-argument warning tracking to prevent log spam
	- Support for multiple deprecation levels via decorator stacking
	- Audit tools for CI pipelines: wrapper validation, expiry enforcement, chain detection
	- Testing utilities for writing deterministic tests

	Core Components:

	Main Decorator (:mod:`deprecate.deprecation`):
	- :func:`~deprecate.deprecation.deprecated`: Decorator for marking functions/methods as deprecated
	- :func:`~deprecate.utils.void`: Silences IDE and mypy warnings about unused parameters in deprecated stubs

	Audit (:mod:`deprecate.audit`):
	- :func:`~deprecate.audit.validate_deprecation_wrapper`: Validate a single wrapper's configuration
	- :func:`~deprecate.audit.find_deprecation_wrappers`: Scan a package for all deprecated wrappers
	- :func:`~deprecate.audit.generate_deprecation_table`: Build compact or matrix markdown deprecation tables
	- :func:`~deprecate.audit.validate_deprecation_expiry`: Detect wrappers that outlived their ``remove_in`` deadline
	- :func:`~deprecate.audit.validate_deprecation_chains`: Detect deprecated wrappers chaining to
	other deprecated wrappers
	- :class:`~deprecate.audit.DeprecationWrapperInfo`: Structured result returned by the audit functions
	- :class:`~deprecate.audit.ChainType`: Enum describing the kind of deprecation chain detected

	Proxy (:mod:`deprecate.proxy`):
	- :func:`~deprecate.proxy.deprecated_instance`: Wrap any object with deprecation warnings
	- :func:`~deprecate.proxy.deprecated_class`: Decorator for deprecating Enum/dataclass definitions

	Testing (:mod:`deprecate.utils`):
	- :func:`~deprecate.utils.assert_no_warnings`: Context manager asserting that no warnings are raised

	Quick Example:
	>>> from deprecate import deprecated
	>>>
	>>> def new_function(x: int) -> int:
	... '''New implementation.'''
	... return x * 2
	>>>
	>>> @deprecated(target=new_function, deprecated_in="1.0", remove_in="2.0")
	... def old_function(x: int) -> int:
	... '''Old implementation - calls forwarded automatically.'''
	... pass
	>>>
	>>> result = old_function(5) # Shows warning, returns 10
	>>> print(result)
	10

	Complete Documentation:
	For detailed examples and use cases, see:
	https://borda.github.io/pyDeprecate

	Topics covered:
	- Simple function forwarding
	- Advanced argument mapping
	- Warning-only deprecation (``TargetMode.NOTIFY``)
	- Self-deprecation (``TargetMode.ARGS_REMAP``)
	- Multiple deprecation levels
	- Conditional skip (skip_if parameter)
	- Class deprecation
	- Automatic docstring updates
	- Auditing: wrapper configuration, expiry enforcement, chain detection
	- Testing deprecated code

	"""

	from deprecate.__about__ import * # noqa: F403
	from deprecate._types import TargetMode
	from deprecate.audit import (
	ChainType,
	DeprecatedCallableInfo, # noqa: F401 # backward-compat alias for DeprecationWrapperInfo
	DeprecationStatus,
	DeprecationWrapperInfo,
	TableStyle,
	find_deprecated_callables, # noqa: F401 # deprecated since 0.6, use find_deprecation_wrappers
	find_deprecation_wrappers,
	generate_deprecation_table,
	validate_deprecated_callable, # noqa: F401 # deprecated since 0.6, use validate_deprecation_wrapper
	validate_deprecation_chains,
	validate_deprecation_expiry,
	validate_deprecation_wrapper,
	validate_mapping_compatibility,
	)

	# Opt-in strict ``property`` replacement: ``from deprecate import property`` shadows the builtin
	# in the importing module only, rejecting inner-order ``@property @deprecated`` at class-body time.
	from deprecate.deprecation import (
	_StrictProperty as property, # noqa: F401 # intentional: explicit-import only; excluded from __all__ to prevent star-import from silently enabling strict mode
	)
	from deprecate.deprecation import deprecated
	from deprecate.proxy import deprecated_class, deprecated_instance
	from deprecate.utils import (
	assert_no_warnings,
	no_warning_call, # noqa: F401 # deprecated since 0.6, use assert_no_warnings
	void,
	)

	__all__ = [
	"ChainType",
	"DeprecationStatus",
	"DeprecationWrapperInfo",
	"TableStyle",
	"TargetMode",
	"assert_no_warnings",
	"deprecated",
	"deprecated_class",
	"deprecated_instance",
	"find_deprecation_wrappers",
	"generate_deprecation_table",
	"validate_deprecation_chains",
	"validate_deprecation_expiry",
	"validate_deprecation_wrapper",
	"validate_mapping_compatibility",
	"void",
	]