Opened 13 years ago

Closed 12 years ago

#2223 enhancement closed fixed (fixed)

DeferredSemaphore should be marked "stable"

Reported by: spiv Owned by:
Priority: highest Milestone:
Component: core Keywords:
Cc: Branch:
Author:

Description

DeferredSemaphore is fairly widely used, clearly useful, and seems to have a pretty good API to me. I think it should say "API stability: stable", rather than "unstable".

Change History (7)

comment:1 Changed 13 years ago by Stephen Thorne

Keywords: review added
Priority: normalhighest
Index: defer.py
===================================================================
--- defer.py    (revision 18490)
+++ defer.py    (working copy)
@@ -745,7 +745,7 @@
 class DeferredSemaphore(_ConcurrencyPrimitive):
     """A semaphore for event driven systems.

-    API stability: Unstable
+    API stability: stable
     """

     def __init__(self, tokens):

comment:2 Changed 13 years ago by Jean-Paul Calderone

Keywords: review removed
Owner: changed from Glyph to Stephen Thorne

defer.py has an API stability marker, stable. I should think removing the one on DeferredSemaphore would be better than duplicating the declaration.

What about DeferredLock and DeferredQueue? One could make the case that DeferredQueue is different, but if DeferredSemaphore is going to be stable, DeferredLock certainly should be as well.

Overall, I am -0 on this change alone. I think these classes need more documentation on their proper usage before they are fit for mass consumption. I believe I have only ever seen them misused.

comment:3 Changed 13 years ago by Stephen Thorne

Keywords: review added
Owner: changed from Stephen Thorne to Glyph

Hey, this looks a bit nicer now. check out defer-stability-2223

comment:4 Changed 13 years ago by Jean-Paul Calderone

Two points:

  • This ticket is only about declaring DeferredSemaphore as stable
  • The branch for this ticket incompatibly changes DeferredSemaphore's API

comment:5 Changed 13 years ago by Glyph

Keywords: review removed
Owner: changed from Glyph to Stephen Thorne

I've never used DeferredSemaphore myself, so I'm not sure I understand what it means - but right now I am, like, -inf on incompatible changes. If the API is changing, then a "stable" declaration hardly seems fitting.

comment:6 Changed 12 years ago by Jean-Paul Calderone

Resolution: fixed
Status: newclosed

All API stability markers are gone.

comment:7 Changed 9 years ago by <automation>

Owner: Stephen Thorne deleted
Note: See TracTickets for help on using tickets.