U Dv f3@sHdZddlmZddlmZmZddlZdaddZddZ d d Z dS) z=Register functions as methods of Pandas DataFrame and Series.)wraps)register_series_accessorregister_dataframe_accessorNc Cst|j||~}|dkr*||f||}nRt|gt|}||j|||\}} |dd}| }||f||}|||W5QRSQRXdS)aHandle pandas extension call. This function is called when the user calls a pandas DataFrame object's method. The pandas extension mechanism passes args and kwargs of the original method call as it is applied to obj. Our implementation uses the global variable `method_call_ctx_factory`. `method_call_ctx_factory` can be either None or an abstract class. When `method_call_ctx_factory` is None, the implementation calls the registered method with unmodified args and kwargs and returns underlying method result. When `method_call_ctx_factory` is not None, `method_call_ctx_factory` is expected to refer to the function to create the context object. The context object will be used to process inputs and outputs of `method` calls. It is also possible that the context object method `handle_start_method_call` will modify original args and kwargs before `method` call. `method_call_ctx_factory` is a function that should have the following signature: `f(method_name: str, args: list, kwargs: dict) -> MethodCallCtx` MethodCallCtx is an abstract class: class MethodCallCtx(abc.ABC): @abstractmethod def __enter__(self) -> None: raise NotImplemented @abstractmethod def __exit__(self, exc_type, exc_value, traceback) -> None: raise NotImplemented @abstractmethod def handle_start_method_call(self, method_name: str, method_signature: inspect.Signature, method_args: list, method_kwargs: dict) -> tuple(list, dict): raise NotImplemented @abstractmethod def handle_end_method_call(self, ret: object) -> None: raise NotImplemented Args: method (callable): method object as registered by decorator register_dataframe_method (or register_series_method) method_signature: signature of method as returned by inspect.signature obj: Dataframe or Series args: The arguments to pass to the registered method. kwargs: The keyword arguments to pass to the registered method. Returns: object`: The result of calling of the method. N)method_call_ctx_factory__name__tuplelistZhandle_start_method_callZhandle_end_method_call) methodmethod_signatureobjargskwargsZmethod_call_ctxretZall_argsnew_argsZ new_kwargsr:/tmp/pip-unpacked-wheel-c6c42brj/pandas_flavor/register.pyhandle_pandas_extension_call s.@  rcstfdd}|S)apRegister a function as a method attached to the Pandas DataFrame. Example: @register_dataframe_method def print_column(df, col): '''Print the dataframe column given''' print(df[col]) Args: method (callable): callable to register as a dataframe method. Returns: callable: The original method. cs(Gfdddt}tj|S)avInner function to register the method. This function is called when the user decorates a function with register_dataframe_method. Args: *args: The arguments to pass to the registered method. **kwargs: The keyword arguments to pass to the registered method. Returns: method: The original method. cs.eZdZdZddZefddZdS)z@register_dataframe_method..inner..AccessorMethodz DataFrame Accessor method class.cSs ||_dS)zInitialize the accessor method class. Args: pandas_obj (pandas.DataFrame): The pandas DataFrame object. N_objselfZ pandas_objrrr__init__szIregister_dataframe_method..inner..AccessorMethod.__init__cs,tdkr|jf||St|j||SaUCall the accessor method. Args: *args: The arguments to pass to the registered method. **kwargs: The keyword arguments to pass to the registered method. Returns: object: The result of calling of the method. Nrrrrr rr r rr__call__s zIregister_dataframe_method..inner..AccessorMethod.__call__Nr __module__ __qualname____doc__rrrrrrrAccessorMethodsr")objectrrr rr"rrrinnervsz(register_dataframe_method..innerinspect signaturer r%rrrregister_dataframe_methodcs 1r*cstfdd}|S)zRegister a function as a method attached to the Pandas Series. Args: method (callable): callable to register as a series method. Returns: callable: The original method. cs(Gfdddt}tj|S)a Inner function to register the method. Args: *args: The arguments to pass to the registered method. **kwargs: The keyword arguments to pass to the registered method. Returns: method: The original method. cs4eZdZdZjZddZefddZdS)z=register_series_method..inner..AccessorMethodzSeries Accessor method class.cSs ||_dS)zInitialize the accessor method class. Args: pandas_obj (pandas.Series): The pandas Series object. NrrrrrrszFregister_series_method..inner..AccessorMethod.__init__cs,tdkr|jf||St|j||Srrrrrrrs zFregister_series_method..inner..AccessorMethod.__call__Nrrrrrr"s r")r#rrr$rrrr%s !z%register_series_method..innerr&r)rrrregister_series_methods 0r+) r! functoolsrZpandas.api.extensionsrrr'rrr*r+rrrrs WG