7Gi$dZddlZddlZddlmZddlmZddlmZm Z m Z m Z de de e ee effdZd e ej de e eeffd Zedd e eed e edefd ZdededefdZy)aUtility functions and helpers for deprecation management. This module provides supporting utilities for the deprecation system, including: - Function introspection helpers - Testing utilities for deprecated code - Warning management tools Key Functions: - get_func_arguments_types_defaults(): Extract function signature details - no_warning_call(): Context manager for testing code without warnings - void(): Helper to silence IDE warnings about unused parameters Copyright (C) 2020-2023 Jiri Borovec <...> N) Generator)contextmanager)AnyCallableOptionalUnionfuncreturnctj|j}g}|D]4}||j}||j}|j |||f6|S)aParse function arguments, types and default values. Args: func: a function to be examined Returns: List of tuples, one per argument, each containing: - str: argument name - type: argument type annotation (or inspect._empty if no annotation) - Any: default value (or inspect._empty if no default) Example: >>> def example_func(x: int, y: str = "hello", z=42) -> None: ... pass >>> result = get_func_arguments_types_defaults(example_func) >>> for name, type_hint, default in result: ... print(f"{name}: type={type_hint}, default={default}") x: type=, default= y: type=, default=hello z: type=, default=42 >>> # Example with the function itself >>> get_func_arguments_types_defaults(get_func_arguments_types_defaults) [('func', typing.Callable, )] )inspect signature parameters annotationdefaultappend)r func_default_paramsfunc_arg_type_valargarg_type arg_defaults _/home/nelsen/Projects/HRI/fr-in-the-cloud/.venv/lib/python3.12/site-packages/deprecate/utils.py!get_func_arguments_types_defaultsrsm6"++D1<<"?&s+66)#.66   #x!=>? warnsc@|Dcgc]}|jc}Scc}w)zConvert list of warning messages to their string representations. Args: warns: List of warning message objects captured during execution Returns: List of warning messages as strings or Warning objects )message)rws r _warns_reprr;s % %!AII %% %s warning_typematchc #NKtjd5}tjdd|s dddy|stdt ||Dcgc]}t |j |s|}}|s dddy|s$td|jdt ||Dcgc]!}||jjvs |#}}|r'td|jd|d t | dddycc}wcc}w#1swYyxYww) aYContext manager to assert that no warnings are raised. This is useful for testing that new/replacement functions don't trigger deprecation warnings, or that code paths properly avoid deprecated functionality. Args: warning_type: The type of warning to catch (e.g., FutureWarning, DeprecationWarning). If None, catches all warning types. match: If specified, only fail if warning message contains this string. If None, fails on any warning of the specified type. Raises: AssertionError: If a warning of the specified type (and optionally matching the message pattern) was raised during the context. Example: >>> # Basic usage >>> import warnings >>> def new_func(x: int) -> int: ... return x * 2 >>> # Test passes only if no FutureWarning is raised >>> with no_warning_call(FutureWarning): ... result = new_func(42) >>> result 84 >>> # Only fails if warning contains "deprecated" >>> def some_function(): ... warnings.warn("deprecated feature", FutureWarning) >>> with no_warning_call(FutureWarning, match="other"): # doesn't match, so passes ... some_function() >>> # Fails if ANY warning is raised >>> def clean_function(): ... pass >>> with no_warning_call(): ... clean_function() .. note: This is the inverse of ``pytest.warns()`` - it ensures warnings are NOT raised. Useful for testing that refactored code properly uses new APIs. T)recordalwaysNz/While catching all warnings, these were found: zWhile catching `z` warnings, these were found: z` warnings with "z", these were found: ) warningscatch_warnings simplefilterAssertionErrorr issubclasscategory__name__r__str__)rr calledrrfounds rno_warning_callr.HsJZ   -h'   #RS^_eSfRg!hi i"Kqj\&JKK  "<#8#8"99WXcdiXjWkl "BqUaii.?.?.A%ABB  "<#8#8"99J5'R&&1%&8%9;  )LC's\D%D D%DD8D<D D% *D4!DD+D D% DD"D%argskwrgsc||c}}y)a Empty function that accepts any arguments and returns None. This helper function is used to silence IDE warnings about unused parameters in deprecated functions where the body is never executed (calls are forwarded to a target function). Args: *args: Any positional arguments (ignored) **kwrgs: Any keyword arguments (ignored) Returns: None Example: >>> from deprecate import deprecated, void >>> >>> def new_func(x: int) -> int: ... return x * 2 >>> >>> @deprecated(target=new_func, deprecated_in="1.0", remove_in="2.0") ... def old_func(x: int) -> int: ... void(x) # Silences IDE warning about unused 'x' ... # This line is never reached - call forwarded to new_func >>> >>> old_func(5) # Returns 10 10 .. note: This function has no runtime effect - it's purely for developer convenience to avoid IDE warnings. You can also use ``pass`` or just a docstring instead. N)r/r0_s rvoidr4sB DAqr)NN)__doc__r r$collections.abcr contextlibrtypingrrrrlisttuplestrrWarningMessageWarningrtyper.r4r2rrr?s %%11!H!eCPSO>T9U!H &tH334 &eGSL>Q9R &D(4="9DRUDbkDDN!!c!c!r