retire AsyncDictionary

groove-x · Oct 26, 2020 · f884cf8 · f884cf8
1 parent cd8f273
commit f884cf8
Show file tree

Hide file tree

Showing 7 changed files with 5 additions and 101 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,11 @@
 - `@trio_async_generator` is a decorator which adapts a generator containing
   Trio constructs for safe use.  (Normally, it's not allowed to yield from a
   nursery or cancel scope when implementing async generators.)
+### Removed
+- `AsyncDictionary` has been removed.  It didn't work well for the advertised
+  use case of multiplexing a network connection, and trying to address that
+  while keeping the regular dict interface (itself of unproven value) seemed to
+  result in an overly complex API.  See [discussion](https://github.com/groove-x/trio-util/issues/4).
 
 ## trio-util 0.2.0 (2020-09-09)
 ### Added

diff --git a/README.md b/README.md
@@ -11,7 +11,6 @@ including:
   * `wait_any`, `wait_all` - avoid nursery blocks for simple cases
   * `AsyncBool`, `AsyncValue` - value wrappers with the ability to wait for
     a specific value or transition
-  * `AsyncDictionary` - dictionary with waitable get and pop
   * `periodic` - periodic loop which accounts for its own execution
     time
   * `@trio_async_generator` - decorator which adapts a generator containing

diff --git a/docs/index.rst b/docs/index.rst
@@ -44,15 +44,6 @@ This can be achieved without resorting to polling by employing the
 .. autofunction:: compose_values
     :async-with: composed
 
-collections
------------
-:class:`AsyncDictionary` has many uses, such as multiplexing a networking
-connection among tasks.
-
-.. autoclass:: AsyncDictionary
-    :show-inheritance:
-    :members:
-
 repeated events
 ---------------
 :class:`trio.Event` does not offer a clear() method, so it can't be

diff --git a/setup.py b/setup.py
@@ -18,7 +18,6 @@
   * wait_any, wait_all - avoid nursery blocks for simple cases
   * AsyncBool, AsyncValue - value wrappers with the ability to wait for
     a specific value or transition
-  * AsyncDictionary - dictionary with waitable get and pop
   * periodic - periodic loop which accounts for its own execution
     time
   * @trio_async_generator - decorator which adapts a generator containing

diff --git a/src/trio_util/__init__.py b/src/trio_util/__init__.py
@@ -1,6 +1,5 @@
 from ._version import __version__
 from ._async_bool import AsyncBool
-from ._async_dictionary import AsyncDictionary
 from ._async_itertools import azip, azip_longest
 from ._async_value import AsyncValue, compose_values
 from ._awaitables import wait_all, wait_any

diff --git a/src/trio_util/_async_dictionary.py b/src/trio_util/_async_dictionary.py
diff --git a/tests/test_async_dictionary.py b/tests/test_async_dictionary.py