[Checkins] SVN: z3c.indexer/trunk/ Remove the IIndexValue thing.
Dan Korostelev
nadako at gmail.com
Sun Jan 4 12:14:31 EST 2009
Log message for revision 94502:
Remove the IIndexValue thing.
Whitespace and typo fixes.
Docstring fixes.
Changed:
U z3c.indexer/trunk/CHANGES.txt
U z3c.indexer/trunk/src/z3c/indexer/README.txt
U z3c.indexer/trunk/src/z3c/indexer/_bbb.py
U z3c.indexer/trunk/src/z3c/indexer/index.py
U z3c.indexer/trunk/src/z3c/indexer/indexer.py
U z3c.indexer/trunk/src/z3c/indexer/interfaces.py
U z3c.indexer/trunk/src/z3c/indexer/query.py
U z3c.indexer/trunk/src/z3c/indexer/sample.txt
U z3c.indexer/trunk/src/z3c/indexer/search.py
D z3c.indexer/trunk/src/z3c/indexer/value.py
-=-
Modified: z3c.indexer/trunk/CHANGES.txt
===================================================================
--- z3c.indexer/trunk/CHANGES.txt 2009-01-04 16:56:31 UTC (rev 94501)
+++ z3c.indexer/trunk/CHANGES.txt 2009-01-04 17:14:31 UTC (rev 94502)
@@ -18,6 +18,11 @@
- Added the "subscriber.zcml" file that contains ZCML-based intid subscriber
registrations for easy including in projects that use event-based indexing.
+- The IIndexValue interface and all its mentions in code and documentation
+ is removed, because it's not an actual part of concept and wasn't ever
+ used/implemented in this package. It's easy to implement it in custom
+ project, so we believe that it's not a problem.
+
- Reworded package description to make it nicer. Fix little docstring typos.
0.5.1 (2008-12-11)
Modified: z3c.indexer/trunk/src/z3c/indexer/README.txt
===================================================================
--- z3c.indexer/trunk/src/z3c/indexer/README.txt 2009-01-04 16:56:31 UTC (rev 94501)
+++ z3c.indexer/trunk/src/z3c/indexer/README.txt 2009-01-04 17:14:31 UTC (rev 94502)
@@ -53,8 +53,8 @@
incredibly speedup your search query because it compares combined queries
against each other and not against all available objects.
-Performeance
-------------
+Performance
+-----------
See also the performance test located in this package. The interesting part is
the speedup different for a larger amount of indexes. Here is a sample output
@@ -182,12 +182,6 @@
- The IIndexer can index objects in one or more index.
-- The default IIndexer adapter will lookup a IIndexValue multi adapter for each
- (object, index) tuple and get the right value from this adapter. You can
- register custom IIndexer adapters for your objects if you like to avoid this
- additional adapter call. (XXX: This is not actually true, is this pattern
- deprecated?)
-
- Everything is explicit. This means that there's no default actions on
the IntIdAddedEvent by. But you can easily write your own subscriber if
you need to use it. This package provides ready-to-use event handlers
@@ -1131,7 +1125,7 @@
>>> valueIndexer.value
Traceback (most recent call last):
...
- NotImplementedError: Subclass must implement value property.
+ NotImplementedError: Subclass must implement the value property.
Another use case which we didn't test is that a applyIn can contain the
same object twice with different values. Let's test the built in union
Modified: z3c.indexer/trunk/src/z3c/indexer/_bbb.py
===================================================================
--- z3c.indexer/trunk/src/z3c/indexer/_bbb.py 2009-01-04 16:56:31 UTC (rev 94501)
+++ z3c.indexer/trunk/src/z3c/indexer/_bbb.py 2009-01-04 17:14:31 UTC (rev 94502)
@@ -84,4 +84,3 @@
"""Can be used as base for index a object in more then one index."""
zope.interface.implements(interfaces.IMultiAutoIndexer)
-
Modified: z3c.indexer/trunk/src/z3c/indexer/index.py
===================================================================
--- z3c.indexer/trunk/src/z3c/indexer/index.py 2009-01-04 16:56:31 UTC (rev 94501)
+++ z3c.indexer/trunk/src/z3c/indexer/index.py 2009-01-04 17:14:31 UTC (rev 94502)
@@ -153,4 +153,4 @@
return self.apply({'any': extent})
def applyExtentNone(self, extent):
- return self.apply({'none': extent})
\ No newline at end of file
+ return self.apply({'none': extent})
Modified: z3c.indexer/trunk/src/z3c/indexer/indexer.py
===================================================================
--- z3c.indexer/trunk/src/z3c/indexer/indexer.py 2009-01-04 16:56:31 UTC (rev 94501)
+++ z3c.indexer/trunk/src/z3c/indexer/indexer.py 2009-01-04 17:14:31 UTC (rev 94502)
@@ -113,7 +113,7 @@
@property
def value(self):
"""Get the index value for the adapted context and relevant index."""
- raise NotImplementedError("Subclass must implement value property.")
+ raise NotImplementedError("Subclass must implement the value property.")
def doIndex(self):
self.index.doIndex(self.oid, self.value)
Modified: z3c.indexer/trunk/src/z3c/indexer/interfaces.py
===================================================================
--- z3c.indexer/trunk/src/z3c/indexer/interfaces.py 2009-01-04 16:56:31 UTC (rev 94501)
+++ z3c.indexer/trunk/src/z3c/indexer/interfaces.py 2009-01-04 17:14:31 UTC (rev 94502)
@@ -312,12 +312,6 @@
"""Query signature."""
-class IIndexValue(zope.interface.Interface):
- """Knows how to lookup index values."""
-
- value = zope.interface.Attribute("""Index value of context.""")
-
-
# transaction based indexing concept
class IIndexerCollector(IDataManager):
"""Collects IIndexer which get processed at the end of the transaction."""
Modified: z3c.indexer/trunk/src/z3c/indexer/query.py
===================================================================
--- z3c.indexer/trunk/src/z3c/indexer/query.py 2009-01-04 16:56:31 UTC (rev 94501)
+++ z3c.indexer/trunk/src/z3c/indexer/query.py 2009-01-04 17:14:31 UTC (rev 94502)
@@ -92,7 +92,7 @@
class Ge(QueryMixin):
- """Between query."""
+ """Greater (or equal) query."""
zope.interface.implements(interfaces.IGeQuery)
@@ -106,7 +106,7 @@
class Le(QueryMixin):
- """Between query."""
+ """Less (or equal) query."""
zope.interface.implements(interfaces.ILeQuery)
Modified: z3c.indexer/trunk/src/z3c/indexer/sample.txt
===================================================================
--- z3c.indexer/trunk/src/z3c/indexer/sample.txt 2009-01-04 16:56:31 UTC (rev 94501)
+++ z3c.indexer/trunk/src/z3c/indexer/sample.txt 2009-01-04 17:14:31 UTC (rev 94502)
@@ -2,7 +2,7 @@
Sample
======
-Sample for an index and unindex story dring the mypypi package development. As
+Sample for an index and unindex story during the mypypi package development. As
you can see below, many objects (containers) get index more then one time.
E.g. the z3c.formdemo MirrorPackage get indexed 15 times. That's very bad and
just overhead.
Modified: z3c.indexer/trunk/src/z3c/indexer/search.py
===================================================================
--- z3c.indexer/trunk/src/z3c/indexer/search.py 2009-01-04 16:56:31 UTC (rev 94501)
+++ z3c.indexer/trunk/src/z3c/indexer/search.py 2009-01-04 17:14:31 UTC (rev 94502)
@@ -59,7 +59,7 @@
yield obj
def __repr__(self):
- return '<%s len: %s>' %(self.__class__.__name__, len(self.uids))
+ return '<%s len: %s>' % (self.__class__.__name__, len(self.uids))
class SearchQuery(object):
Deleted: z3c.indexer/trunk/src/z3c/indexer/value.py
===================================================================
--- z3c.indexer/trunk/src/z3c/indexer/value.py 2009-01-04 16:56:31 UTC (rev 94501)
+++ z3c.indexer/trunk/src/z3c/indexer/value.py 2009-01-04 17:14:31 UTC (rev 94502)
@@ -1,34 +0,0 @@
-##############################################################################
-#
-# Copyright (c) 2008 Zope Foundation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
-# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-# FOR A PARTICULAR PURPOSE.
-#
-##############################################################################
-"""
-$Id:$
-"""
-__docformat__ = "reStructuredText"
-
-import zope.interface
-from z3c.indexer import interfaces
-
-
-class IIndexValue(object):
- """Index value adapter"""
-
- zope.interface.implements(interfaces.IIndexValue)
-
- def __init__self(self, context, index):
- self.context = context
- self.index = index
-
- @property
- def value(self):
- raise NotImplementedError('Sub class must implement value attribute')
More information about the Checkins
mailing list