Allow parsing of arguments for cached_function and cached_method

[tscrim]

Because it will be handy to normalize and/or ignore arguments for these functions and method. See #1314 for an example.

CC: @simon-king-jena

Component: misc

Keywords: cached method function

Author: Julian Rueth

Branch: 2f19ea5

Reviewer: Travis Scrimshaw

Issue created by migration from https://trac.sagemath.org/ticket/15657

[nathanncohen]

comment:1

(curious)

[saraedum]

Branch: u/saraedum/ticket/15657

[saraedum]

comment:4

I implemented this for cached_function. I am working on something similar for cached_method.

---

New commits:

99be4c6	Added decorator_keywords decorator to simplify writing decorators with optional keyword arguments
b74edaa	Added key_normalizer for cached_function

[saraedum]

Commit: b74edaa

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

faf771b	Renamed key_normalizer to create_key for cached_function to be consistent with UniqueFactory
fe7a01a	Add create_key parameter for cached_method

[sagetrac-git]

Changed commit from b74edaa to fe7a01a

[tscrim]

Changed commit from fe7a01a to 275f2e1

[tscrim]

Changed branch from u/saraedum/ticket/15657 to public/structure/cached_args-15657

[tscrim]

comment:7

I've changed create_key into key to match with python's sorted (and it makes more sense to me). I've also moved a good part of the doc up to our current standards.

Here are some timings:

With patch:

sage: @cached_function
....: def foo():
....:     return 5
....: 
sage: %timeit foo()
1000000 loops, best of 3: 343 ns per loop

sage: class Foo:
....:     @cached_method
....:     def bar(self):
....:         return 5
....:     
sage: F = Foo()
sage: %timeit F.bar()
1000000 loops, best of 3: 235 ns per loop

sage: class FooArgs:
....:     @cached_method
....:     def bar(self, x):
....:         return x
....:     
sage: FA = FooArgs()
sage: %timeit FA.bar(5)
1000000 loops, best of 3: 1.55 µs per loop

Before:

sage: %timeit foo()
1000000 loops, best of 3: 335 ns per loop

sage: %timeit F.bar()
1000000 loops, best of 3: 250 ns per loop

sage: %timeit FA.bar(5)
1000000 loops, best of 3: 1.47 µs per loop

So there does not appear to be any (statistically) significant speed regression (I did multiple runs of each as well).

If you're happy with my changes, then positive review.

PS - I also added the key option for the cache to file.

---

New commits:

ec8dbf1	Initial addition of a 'key' argument to cached functions.
c5e837b	Merge branch 'develop' into public/structure/cached_args-15657
8d78b1b	Merge branch 'develop' into public/structure/cached_args-15657
5872e55	Merge branch 'develop' into public/structure/cached_args-15657
9374110	Merge branch 'develop' into public/structure/cached_args-15657
03ac296	Merge branch 'u/saraedum/ticket/15657' of trac.sagemath.org:sage into public/structure/cached_args-15657
275f2e1	Fixes due to my bad merging skills.

[saraedum]

comment:8

Sage does not start anymore for me:

ImportError: No module named terminal.interactiveshell

Somehow your merge has really gone wrong. Do you want me to fix this for you?

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

2c2bed9

Merge branch 'develop' into public/structure/cached_args-15657

[sagetrac-git]

Changed commit from 275f2e1 to 2c2bed9

[tscrim]

comment:10

Started just fine for me with 6.2.beta5, and here's my current 6.2.beta6 version (which also starts up without error).

[saraedum]

comment:11

Ok. I had to make. Now it works again. I agree with your changes.

[tscrim]

Author: Julian Rueth

[tscrim]

Reviewer: Travis Scrimshaw

[tscrim]

comment:12

Thanks.

[vbraun]

comment:13

sage -t --long src/doc/en/thematic_tutorials/coercion_and_categories.rst  # 2 doctests failed
sage -t --long src/sage/misc/dev_tools.py  # 1 doctest failed

[sagetrac-git]

Changed commit from 2c2bed9 to 2f19ea5

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. New commits:

37f1797	Merge branch 'public/structure/cached_args-15657' of trac.sagemath.org:sage into public/structure/cached_args-15657
2f19ea5	Fixed doctests.

[tscrim]

comment:15

Fixed.

[vbraun]

Changed branch from public/structure/cached_args-15657 to 2f19ea5

[saraedum]

Changed commit from 2f19ea5 to none

[saraedum]

comment:17

Actually using the key parameter I found a few small bugs, this is #16337.

[nathanncohen]

comment:18

Hello guys !!

With designs I would like to have some new parameter for cached methods, but I wonder if it would be a good idea of slow something that we want to be fast...

Here is the thing : I would like to only cache the return values corresponding to "some" inputs of the cached function. More precisely, if some parameter is set to True I want to cache the result, otherwise I don't want to.

Do you know if it can be useful to you, or if it can be obtained by a trick with the current features of cached methods ?

Thaaaaaaanks !

Nathann