Opened 5 years ago

Closed 2 years ago

#16785 closed New feature (fixed)

Document cache design in `misc/design-philosophies`

Reported by: jamesp Owned by: timo
Component: Documentation Version: 1.3
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no


I initially found the design of the cache backend classes confusing, especially with respect to references to Memcached in django.core.cache.backends.base.BaseCache.validate_key() . I found that this was added a year ago in ticket #6447, so I figured there was a good reason but it was not explained anywhere I could find.

I discussed this with a couple core developers and hopefully the attached patch will be suitable.

Attachments (1)

docs-misc-design-philosophies-cache.patch (1.2 KB) - added by jamesp 5 years ago.

Download all attachments as: .zip

Change History (4)

Changed 5 years ago by jamesp

comment:1 Changed 5 years ago by gabrielhurley

  • Needs documentation unset
  • Needs tests unset
  • Owner changed from nobody to gabrielhurley
  • Patch needs improvement set
  • Status changed from new to assigned
  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Uncategorized to New feature

Not having been privy to the discussion on the issue, I'm a little unclear on what problem the last section on Explicit vs. Implicit is trying to address. While I agree with the sentiment I'm left with the question "why would it be tempting to do the opposite?"

Otherwise the patch looks good. If you could say a few words on the meaning of that last section I'll wrap it up and commit it.

comment:2 Changed 2 years ago by timo

  • Owner changed from gabrielhurley to timo

Since we can't get clarification on the "explicit vs. implicit" section, I'm going to commit the rest of this.

comment:3 Changed 2 years ago by Tim Graham <timograham@…>

  • Resolution set to fixed
  • Status changed from assigned to closed

In dd98ccd4821f71543a5489d421ea2dee28901f17:

Fixed #16785 -- Documented some of the design decisions of the cache framework.

Thanks jamesp for the draft patch.

Note: See TracTickets for help on using tickets.
Back to Top