feat(memcached): add a memcached extra and deprecate memcache - #203
Merged
Merged
Conversation
The extra that installs pymemcache was named memcache, which does not match MemcachedBackend or the docs' own wording. Add memcached as the canonical name and keep memcache as a deprecated alias until 0.4.0 (#202), so existing installs keep pulling in pymemcache. Switch tox, the release workflow and the docs to the new name, and point the ImportError message at fastapi-cachex[memcached]. Closes #201
allen0099
added
enhancement
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #201
Summary
memcached = ["pymemcache"]as the canonical extra forMemcachedBackend.memcacheas a deprecated alias with the same dependency; removal is tracked in Remove the deprecated memcache extra #202 (0.4.0).tox.iniandrelease.ymlto--extra memcached.docs/BACKENDS.md,docs/DEVELOPMENT.mdand the zh-TW docs; drop the "note:memcache, notmemcached" remarks and explain the deprecation.ImportErrormessage now points atpip install 'fastapi-cachex[memcached]'.memcached, Deprecated entry formemcache.Why not just rename
pip and uv only warn about an unknown extra and install the package without it, so removing
memcacheoutright would silently droppymemcachefor existing users. Keeping both names makes this release non-breaking.Verification
.[memcached]and.[memcache]into fresh venvs; both importpymemcache.uv lock --check, ruff,mypy --strictpass.CACHEX_REQUIRE_LIVE_SERVERS=1): 857 passed.