a oe:@s.ddlZddlZddlZddlZddlZddlZddlZddlZddl m Z m Z e de de fdZ ddZdd Zd d Zefe e e ge fe d d dZddZddZddZddZddZGdddZddZddddfd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zddd,d-d.Z dS)/N)CallableTypeVar CallableT.)boundcGsdd}t||S)a; Compose any number of unary functions into a single unary function. >>> import textwrap >>> expected = str.strip(textwrap.dedent(compose.__doc__)) >>> strip_and_dedent = compose(str.strip, textwrap.dedent) >>> strip_and_dedent(compose.__doc__) == expected True Compose also allows the innermost function to take arbitrary arguments. >>> round_three = lambda x: round(x, ndigits=3) >>> f = compose(round_three, int.__truediv__) >>> [f(3*x, x+1) for x in range(1,10)] [1.5, 2.0, 2.25, 2.4, 2.5, 2.571, 2.625, 2.667, 2.7] csfddS)Ncs|i|SNargskwargsf1f2rGC:\Program Files\Certbot\pkgs\pkg_resources\_vendor\jaraco\functools.py$z.compose..compose_two..rr rr r compose_two#szcompose..compose_two) functoolsreduce)Zfuncsrrrrcomposesrcsfdd}|S)z Return a function that will call a named method on the target object with optional positional and keyword arguments. >>> lower = method_caller('lower') >>> lower('MyString') 'mystring' cst|}|iSr)getattr)targetfuncr r method_namerr call_method4s z"method_caller..call_methodr)rr r rrrr method_caller)s rcs*tfddfdd_S)ad Decorate func so it's only ever called the first time. This decorator can ensure that an expensive or non-idempotent function will not be expensive on subsequent calls and is idempotent. >>> add_three = once(lambda a: a+3) >>> add_three(3) 6 >>> add_three(9) 6 >>> add_three('12') 6 To reset the stored value, simply clear the property ``saved_result``. >>> del add_three.saved_result >>> add_three(9) 12 >>> add_three(8) 12 Or invoke 'reset()' on it. >>> add_three.reset() >>> add_three(-3) 0 >>> add_three(0) 0 cs tds|i|_jSN saved_result)hasattrrrrwrapperrrr [s zonce..wrappercstdSr)vars __delitem__r)r rrrarzonce..)rwrapsresetrrrronce;s r&)method cache_wrapperreturncs2ttttdfdd }dd|_tp0|S)aV Wrap lru_cache to support storing the cache data in the object instances. Abstracts the common paradigm where the method explicitly saves an underscore-prefixed protected property on first call and returns that subsequently. >>> class MyClass: ... calls = 0 ... ... @method_cache ... def method(self, value): ... self.calls += 1 ... return value >>> a = MyClass() >>> a.method(3) 3 >>> for x in range(75): ... res = a.method(x) >>> a.calls 75 Note that the apparent behavior will be exactly like that of lru_cache except that the cache is stored on each instance, so values in one instance will not flush values from another, and when an instance is deleted, so are the cached values for that instance. >>> b = MyClass() >>> for x in range(35): ... res = b.method(x) >>> b.calls 35 >>> a.method(0) 0 >>> a.calls 75 Note that if method had been decorated with ``functools.lru_cache()``, a.calls would have been 76 (due to the cached value of 0 having been flushed by the 'b' instance). Clear the cache with ``.cache_clear()`` >>> a.method.cache_clear() Same for a method that hasn't yet been called. >>> c = MyClass() >>> c.method.cache_clear() Another cache wrapper may be supplied: >>> cache = functools.lru_cache(maxsize=2) >>> MyClass.method2 = method_cache(lambda self: 3, cache_wrapper=cache) >>> a = MyClass() >>> a.method2() 3 Caution - do not subsequently wrap the method with another decorator, such as ``@property``, which changes the semantics of the function. See also http://code.activestate.com/recipes/577452-a-memoize-decorator-for-instance-methods/ for another implementation and additional justification. )selfr r r)cs0t|}|}t|j|||i|Sr)types MethodTypesetattr__name__)r*r r Z bound_methodZ cached_methodr(r'rrr s zmethod_cache..wrappercSsdSrrrrrrrrzmethod_cache..)object cache_clear_special_method_cache)r'r(r rr/r method_cacheesI  r3cs2j}d}||vrdSd|fdd}|S)a: Because Python treats special methods differently, it's not possible to use instance attributes to implement the cached methods. Instead, install the wrapper method under a different name and return a simple proxy to that wrapper. https://github.com/jaraco/jaraco.functools/issues/5 ) __getattr__ __getitem__NZ__cachedcsFt|vr.t|}|}t||n t|}||i|Sr)r!r+r,r-r)r*r r rcacher(r'Z wrapper_namerrproxys    z$_special_method_cache..proxy)r.)r'r(nameZ special_namesr8rr7rr2s  r2csfdd}|S)ab Decorate a function with a transform function that is invoked on results returned from the decorated function. >>> @apply(reversed) ... def get_numbers(start): ... "doc for get_numbers" ... return range(start, start+3) >>> list(get_numbers(4)) [6, 5, 4] >>> get_numbers.__doc__ 'doc for get_numbers' cst|t|Sr)rr#rr% transformrrwrapszapply..wrapr)r;r<rr:rapplys r=csfdd}|S)a@ Decorate a function with an action function that is invoked on the results returned from the decorated function (for its side-effect), then return the original result. >>> @result_invoke(print) ... def add_two(a, b): ... return a + b >>> x = add_two(2, 3) 5 >>> x 5 cstfdd}|S)Ncs|i|}||Srr)r r result)actionrrrr sz,result_invoke..wrap..wrapperrr#rr?r%rr<szresult_invoke..wrapr)r?r<rrAr result_invokes rBcOs||i||S)a Call a function for its side effect after initialization. The benefit of using the decorator instead of simply invoking a function after defining it is that it makes explicit the author's intent for the function to be called immediately. Whereas if one simply calls the function immediately, it's less obvious if that was intentional or incidental. It also avoids repeating the name - the two actions, defining the function and calling it immediately are modeled separately, but linked by the decorator construct. The benefit of having a function construct (opposed to just invoking some behavior inline) is to serve as a scope in which the behavior occurs. It avoids polluting the global namespace with local variables, provides an anchor on which to attach documentation (docstring), keeps the behavior logically separated (instead of conceptually separated or not separated at all), and provides potential to re-use the behavior for testing or other purposes. This function is named as a pithy way to communicate, "call this function primarily for its side effect", or "while defining this function, also take it aside and call it". It exists because there's no Python construct for "define and call" (nor should there be, as decorators serve this need just fine). The behavior happens immediately and synchronously. >>> @invoke ... def func(): print("called") called >>> func() called Use functools.partial to pass parameters to the initial call >>> @functools.partial(invoke, name='bingo') ... def func(name): print("called with", name) called with bingo r)fr r rrrinvokes&rDcOstdtt|i|S)z% Deprecated name for invoke. z$call_aside is deprecated, use invoke)warningswarnDeprecationWarningrDrrrr call_aside8s rHc@sBeZdZdZedfddZddZddZd d Zdd d Z d S) Throttlerz3 Rate-limit a function (or other callable) ZInfcCs(t|tr|j}||_||_|dSr) isinstancerIrmax_rater$)r*rrKrrr__init__Es  zThrottler.__init__cCs d|_dS)Nr) last_called)r*rrrr$LszThrottler.resetcOs||j|i|Sr)_waitr)r*r r rrr__call__OszThrottler.__call__cCs:t|j}d|j|}ttd|t|_dS)z1ensure at least 1/max_rate seconds from last callrN)timerMrKsleepmax)r*elapsedZ must_waitrrrrNSszThrottler._waitNcCst|jt|j|Sr) first_invokerNrpartialr)r*objtyperrr__get__ZszThrottler.__get__)N) r. __module__ __qualname____doc__floatrLr$rOrNrYrrrrrI@s rIcsfdd}|S)z Return a function that when invoked will invoke func1 without any parameters (for its side-effect) and then invoke func2 with whatever parameters were passed, returning its result. cs|i|Srrrfunc1func2rrr eszfirst_invoke..wrapperr)r_r`r rr^rrU^srUcCsdSrrrrrrrlrrrc CsR|tdkrtnt|}|D]*}z |WS|yH|Yq 0q |S)z Given a callable func, trap the indicated exceptions for up to 'retries' times, invoking cleanup on the exception. On the final attempt, allow any exceptions to propagate. inf)r] itertoolscountrange)rZcleanupZretriesZtrapZattemptsZattemptrrr retry_callls  recsfdd}|S)a7 Decorator wrapper for retry_call. Accepts arguments to retry_call except func and then returns a decorator for the decorated function. Ex: >>> @retry(retries=3) ... def my_func(a, b): ... "this is my funk" ... print(a, b) >>> my_func.__doc__ 'this is my funk' cstfdd}|S)Ncs.tjg|Ri|}t|gRiSr)rrVre)Zf_argsZf_kwargsr)rr_argsr_kwargsrrr sz(retry..decorate..wrapperr@rrfrgr%rdecorateszretry..decorater)rfrgrirrhrretry}srjcCs(ttt}ttj||}t||S)z Convert a generator into a function that prints all yielded elements >>> @print_yielded ... def x(): ... yield 3; yield None >>> x() 3 None )rrVmapprintrZmore_itertoolsZconsumer#)rZ print_allZ print_resultsrrr print_yieldeds rmcstfdd}|S)z Wrap func so it's not called if its first param is None >>> print_text = pass_none(print) >>> print_text('text') text >>> print_text(None) cs"|dur|g|Ri|SdSrr)Zparamr r r%rrr szpass_none..wrapperr@rrr%r pass_nones rncs8t|}|j}fdd|D}tj|fi|S)a Assign parameters from namespace where func solicits. >>> def func(x, y=3): ... print(x, y) >>> assigned = assign_params(func, dict(x=2, z=4)) >>> assigned() 2 3 The usual errors are raised if a function doesn't receive its required parameters: >>> assigned = assign_params(func, dict(y=3, z=4)) >>> assigned() Traceback (most recent call last): TypeError: func() ...argument... It even works on methods: >>> class Handler: ... def meth(self, arg): ... print(arg) >>> assign_params(Handler().meth, dict(arg='crystal', foo='clear'))() crystal csi|]}|vr||qSrr).0k namespacerr rz!assign_params..)inspectZ signature parameterskeysrrV)rrrZsigparamsZcall_nsrrqr assign_paramss  rxcs(tddtfdd}|S)a& Wrap a method such that when it is called, the args and kwargs are saved on the method. >>> class MyClass: ... @save_method_args ... def method(self, a, b): ... print(a, b) >>> my_ob = MyClass() >>> my_ob.method(1, 2) 1 2 >>> my_ob._saved_method.args (1, 2) >>> my_ob._saved_method.kwargs {} >>> my_ob.method(a=3, b='foo') 3 foo >>> my_ob._saved_method.args () >>> my_ob._saved_method.kwargs == dict(a=3, b='foo') True The arguments are stored on the instance, allowing for different instance to save different args. >>> your_ob = MyClass() >>> your_ob.method({str('x'): 3}, b=[4]) {'x': 3} [4] >>> your_ob._saved_method.args ({'x': 3},) >>> my_ob._saved_method.args () args_and_kwargsz args kwargscs6dj}||}t||||g|Ri|S)NZ_saved_)r.r-)r*r r Z attr_nameattrryr'rrr s   z!save_method_args..wrapper) collections namedtuplerr#)r'r rr{rsave_method_argss" r~)replaceusecsfdd}|S)a- Replace the indicated exceptions, if raised, with the indicated literal replacement or evaluated expression (if present). >>> safe_int = except_(ValueError)(int) >>> safe_int('five') >>> safe_int('5') 5 Specify a literal replacement with ``replace``. >>> safe_int_r = except_(ValueError, replace=0)(int) >>> safe_int_r('five') 0 Provide an expression to ``use`` to pass through particular parameters. >>> safe_int_pt = except_(ValueError, use='args[0]')(int) >>> safe_int_pt('five') 'five' cs tfdd}|S)Nc sRz|i|WSyLztWYStyFYYS0Yn0dSr)eval TypeErrorr) exceptionsrrrrrr s  z*except_..decorate..wrapperr@rrrrr%rris zexcept_..decorater)rrrrirrrexcept_s r)!rrQrtr|r+rbrEZ#pkg_resources.extern.more_itertoolsZ pkg_resourcestypingrrr0rrrr& lru_cacher3r2r=rBrDrHrIrUrerjrmrnrxr~rrrrrsD. Z* .