get_cache method should be documented as part of move to CACHES

[abdelazer@…]

While the move to CACHES is explained in docs/topics/cache.txt, it is not clear that this allows the declaration and access of multiple caches.

An example with more than one (a non-'default') cache should be included.

An explanation of how to use get_cache should be included, perhaps just a minor rewording of the docstring?

    Function to load a cache backend dynamically. This is flexible by design
    to allow different use cases:

    To load a backend with the old URI-based notation::

        cache = get_cache('locmem://')

    To load a backend that is pre-defined in the settings::

        cache = get_cache('default')

    To load a backend with its dotted import path,
    including arbitrary options::

        cache = get_cache('django.core.cache.backends.memcached.MemcachedCache', **{
            'LOCATION': '127.0.0.1:11211', 'TIMEOUT': 30,
        })

[Aymeric Augustin]

I think this ticket understates the problem.

Contrary to what the release notes for 1.3 say, the fact that Django supports several caches is not documented at all.

The syntax of settings.CACHES suggests that several caches could be defined, by analogy with settings.DATABASES, but there is nothing about how to use them.

[jedie]

Before making get_cache() "public" it should IMHO changed a little bit. Because try this:

cache = get_cache('not_existing_cache')

You will get a strange traceback:

  File "./django/core/cache/__init__.py", line 173, in get_cache
    backend, location, params = parse_backend_conf(backend, **kwargs)
  File "./django/core/cache/__init__.py", line 131, in parse_backend_conf
    mod_path, cls_name = backend.rsplit('.', 1)
ValueError: need more than 1 value to unpack

Should i open a new ticket for this?

[Jannis Leidel]

Replying to jedie:

Before making get_cache() "public" it should IMHO changed a little bit. Because try this:

cache = get_cache('not_existing_cache')

You will get a strange traceback:

  File "./django/core/cache/__init__.py", line 173, in get_cache
    backend, location, params = parse_backend_conf(backend, **kwargs)
  File "./django/core/cache/__init__.py", line 131, in parse_backend_conf
    mod_path, cls_name = backend.rsplit('.', 1)
ValueError: need more than 1 value to unpack

Should i open a new ticket for this?

Yes, please.

[jedie]

Replying to jezdez:

Replying to jedie:

Should i open a new ticket for this?

Yes, please.

done -> #16410

[Ian Clelland]

I've written up a quick paragraph about this; it's available in github at ​https://github.com/clelland/django/tree/ticket_15269.

Pull request forthcoming.

[Tim Graham <timograham@…>]

In e758ecc628bb1d8960d0a59a140a43d7103e89e4:

Merge pull request #386 from clelland/ticket_15269

Fixed #15269 - Added documentation for get_caches function