Ѯh @s%dZddlmZmZmZddlZejeZddl m Z m Z ddl Z ddl mZddlmZddd d d d gZGd ddeZGdddeZdd ZGdd d eZddddddddd Zddddddd ZdS)z7 passlib.utils.decor -- helper decorators & properties )absolute_importdivisionprint_functionN)wrapsupdate_wrapper)warn)PY3 classproperty hybrid_methodmemoize_single_valuememoized_propertydeprecated_functiondeprecated_methodc@s@eZdZdZddZddZeddZdS) r zjFunction decorator which acts like a combination of classmethod+property (limited to read-only properties)cCs ||_dS)N)im_func)selffuncr../../passlib/utils/decor.py__init__#szclassproperty.__init__cCs |j|S)N)r)robjclsrrr__get__&szclassproperty.__get__cCs|jS)zpy3 compatible alias)r)rrrr__func__)szclassproperty.__func__N)__name__ __module__ __qualname____doc__rrpropertyrrrrrr s   c@s.eZdZdZddZddZdS)r z decorator which invokes function with class if called as class method, and with object if called at instance level. cCs||_t||dS)N)rr)rrrrrr4s zhybrid_method.__init__cCsE|dkr|}tr+tj|j|Stj|j||SdS)N)rtypes MethodTyper)rrrrrrr8s  zhybrid_method.__get__N)rrrrrrrrrrr .s  csFitfdd}fdd}||_|S)z decorator for function which takes no args, and memoizes result. exposes a ``.clear_cache`` method to clear the cached value. c s6y dSWntk r YnX}d<|S)NT)KeyError)value)cacherrrwrapperLs   z%memoize_single_value..wrappercsjdddS)NT)popr)r"rr clear_cacheUsz)memoize_single_value..clear_cache)rr%)rr#r%r)r"rrr Ds !  c@saeZdZdZddZddZesBeddZdd Z d d d Z d S) r zM decorator which invokes method once, then replaces attr with result cCs%||_|j|_|j|_dS)N)rrr)rrrrrr_s  zmemoized_property.__init__cCs6|dkr|S|j|}t||j||S)N)rsetattrr)rrrr!rrrrds  zmemoized_property.__get__cCs|jS)z py2 alias)r)rrrrrmszmemoized_property.im_funccCs|jj|jddS)z class-level helper to clear stored value (if any). usage: :samp:`type(self).{attr}.clear_cache(self)` N)__dict__r$r)rrrrrr%rszmemoized_property.clear_cacheNcCs|jj|j|S)z class-level helper to peek at stored value usage: :samp:`value = type(self).{attr}.clear_cache(self)` )r'getr)rrdefaultrrr peek_cachezszmemoized_property.peek_cache) rrrrrrrrrr%r*rrrrr [s    TFcsdkr_rdndr1d7rAd7rUd7d7fdd }|S) abdecorator to deprecate a function. :arg msg: optional msg, default chosen if omitted :kwd deprecated: version when function was first deprecated :kwd removed: version when function will be removed :kwd replacement: alternate name / instructions for replacing this function. :kwd updoc: add notice to docstring (default ``True``) Nz5the method %(mod)s.%(klass)s.%(name)s() is deprecatedz-the function %(mod)s.%(name)s() is deprecatedz as of Passlib %(deprecated)sz,, and will be removed in Passlib %(removed)sz, use %s instead.c sottr0jdtjtdpBjdjddrfdd}nfdd}t| r~sr~|j r~d|j kr~pd }s r>|d 7}r|d f7} r4r&|d 7}|d 7}|d7}|j j dj dsh|j d7_ |j d|f7_ rt|}|S)Nmodname deprecatedremovedcsij}r|dn |dj}|jd|jd|jt|tdd||S)Nrklassr, stacklevel)copy __class__updaterrrDeprecationWarning)argskwdstmpr0)ris_classmethodmsgoptsrrr#s  z3deprecated_function..build..wrappercs ttdd||S)Nr1r2)rr6)r7r8)rtextrrr#sz.. deprecated::z z!and will be removed in version %sz, zuse %s insteadr+  z .. deprecated:: %s ) isinstance classmethodrtyperdictrrrrstripendswith)rr#Ztxt) _is_methodr. func_moduler;r/ replacementupdoc)rr:r<r=rbuilds>          z"deprecated_function..buildr)r;r.r/rJrIrGrHrKr)rGr.rHr;r/rIrJrr s     $*cCst|||||ddS)aZdecorator to deprecate a method. :arg msg: optional msg, default chosen if omitted :kwd deprecated: version when method was first deprecated :kwd removed: version when method will be removed :kwd replacement: alternate name / instructions for replacing this method. :kwd updoc: add notice to docstring (default ``True``) rGT)r )r;r.r/rJrIrrrrs )r __future__rrrlogging getLoggerrlog functoolsrrrwarningsrpasslib.utils.compatr__all__objectr r r r r rrrrrs,    < A