Make objects actually implement interfaces and update interface definitions #159
Conversation
| including, index2. | ||
| """ | ||
| # Backwards compatibility alias. To be removed in 5.0 | ||
| IReadSequence = IMinimalSequence |
There was a problem hiding this comment.
Should the scheduled removal use a deprecation warning to inform users to update their code?
There was a problem hiding this comment.
Great question!
In theory, yes, it probably should. That would require adding a dependency on zope.deprecation, which this package currently does not have. This package has the extremely minimal requirements of just persistent and zope.interface, and it seems desirable to me to keep the requirements minimal as this is such a low-level package.
So, I'm hoping we can get away with just docs-deprecation. From a practical/pragmatic standpoint, since nothing actually implemented any of these interfaces, there would be little incentive to use them. Searching GitHub finds essentially no references to "BTrees.Interfaces" or "IReadSequence" outside of copies of this package (there's a handful of references no the the BTreesConflictError defined here, but that seems to be it).
What do you think?
There was a problem hiding this comment.
Thank you for the research on the usage of these interfaces. I am okay with deprecating only in the documentation.
- Make the BTree objects (BTree, TreeSet, Set, Bucket) of each module actually provide the interfaces defined in BTrees.Interfaces. Previously, they provided no interfaces. - Update the definitions of ISized and IReadSequence to simply be zope.interface.common.collections.ISized and zope.interface.common.sequence.IMinimalSequence respectively. - Remove the __nonzero__ interface method from ICollection. No objects actually implemented such a method; instead, the boolean value is typically taken from __len__. Fixes #138
Fixes a bunch of warnings importing this package with ZOPE_INTERFACE_LOG_CHANGED_IRO set.
Strengthen the documentation added about the interface changes, and fix the links to IMinimalSequence. With the extent versions of Sphink and repoze.sphinx.autointerface, you can only link as a module, not as the class.
|
Thank you! |
Make the BTree objects (BTree, TreeSet, Set, Bucket) of each module actually provide the interfaces defined in BTrees.Interfaces. Previously, they provided no interfaces.
Update the definitions of
ISizedandIReadSequenceto simply bezope.interface.common.collections.ISizedandzope.interface.common.sequence.IMinimalSequencerespectively.Remove the
__nonzero__interface method from ICollection. No objects actually implemented such a method; instead, the boolean value is typically taken from__len__.Fixes #138
(Currently based on #156 to avoid a conflict; only the last commit is relevant here.)