B \ @sLddlZddlZddlZddgZGdddeZddZGdddeZdS)N deprecatedDeprecationDictc@s:eZdZdZdddZddZddZd d Zd d Zd S)raDecorator to mark a function or class as deprecated. Issue a warning when the function is called/the class is instantiated and adds a warning to the docstring. The optional extra argument will be appended to the deprecation message and the docstring. Note: to use this with the default value for extra, put in an empty of parentheses: >>> from sklearn.utils import deprecated >>> deprecated() # doctest: +ELLIPSIS >>> @deprecated() ... def some_function(): pass Parameters ---------- extra : string to be added to the deprecation messages cCs ||_dS)N)extra)selfrr8lib/python3.7/site-packages/sklearn/utils/deprecation.py__init__"szdeprecated.__init__cCs"t|tr||S||SdS)zPCall method Parameters ---------- obj : object N) isinstancetype_decorate_class _decorate_fun)robjrrr__call__%s  zdeprecated.__call__csVd|j|jrd|j7|jfdd}||_d|_|j|_|_|S)NzClass %s is deprecatedz; %scstjtd||S)N)category)warningswarnDeprecationWarning)argskwargs)initmsgrrwrapped9sz+deprecated._decorate_class..wrappedr )__name__rr _update_doc__doc__Zdeprecated_original)rclsrr)rrrr 1s zdeprecated._decorate_classcsNdj|jrd|j7tfdd}||j|_|_|S)zDecorate function funzFunction %s is deprecatedz; %scstjtd||S)N)r)rrr)rr)funrrrrKsz)deprecated._decorate_fun..wrapped)rr functoolswrapsrr __wrapped__)rrrr)rrrr Ds zdeprecated._decorate_funcCs,d}|jrd||jf}|r(d||f}|S)NZ DEPRECATEDz%s: %sz%s %s)r)rZolddocZnewdocrrrrWs  zdeprecated._update_docN)r) r __module__ __qualname__rr rr r rrrrrrs   cCsFtjdkrtdt|dg}|dkr*g}dddd|Dk}|S) z=Helper to check if func is wraped by our deprecated decorator)z-This is only available for python3.5 or above __closure__NrrcSsg|]}t|jtr|jqSr)r cell_contentsstr).0crrr hsz"_is_deprecated..)sys version_infoNotImplementedErrorgetattrjoin)funcZclosuresZ is_deprecatedrrr_is_deprecated`s    r1cs>eZdZdZfddZfddZd ddZd d ZZS) rzA dict which raises a warning when some keys are looked up Note, this does not raise a warning for __contains__ and iteration. It also will raise a warning even after the key has been manually set by the user. csi|_tt|j||dS)N) _deprecationssuperrr )rrr) __class__rrr vszDeprecationDict.__init__cs4||jkr$|j|\}}tj||tt||S)N)r2rrr3r __getitem__)rkeyZ warn_argsZ warn_kwargs)r4rrr5zs  zDeprecationDict.__getitem__NcCs"y||Stk r|SXdS)zReturn the value corresponding to key, else default. Parameters ---------- key : any hashable object The key default : object, optional The default returned when key is not in dict N)KeyError)rr6defaultrrrgets zDeprecationDict.getcOs||f|j|<dS)zAdd a warning to be triggered when the specified key is read Parameters ---------- key : any hashable object The key N)r2)rr6rrrrr add_warningszDeprecationDict.add_warning)N) rr!r"rr r5r9r: __classcell__rr)r4rrns    ) r+rr__all__objectrr1dictrrrrrs X