/usr/share/pyshared/zope.catalog-3.8.2.egg-info/PKG-INFO is in python-zope.catalog 3.8.2-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 | Metadata-Version: 1.0
Name: zope.catalog
Version: 3.8.2
Summary: Cataloging and Indexing Framework for the Zope Toolkit
Home-page: http://pypi.python.org/pypi/zope.catalog
Author: Zope Corporation and Contributors
Author-email: zope-dev@zope.org
License: ZPL 2.1
Description: Catalogs provide management of collections of related indexes with a basic
search algorithm.
Detailed Documentation
**********************
Catalogs
========
Catalogs provide management of collections of related indexes with a
basic search algorithm. Let's look at an example:
>>> from zope.catalog.catalog import Catalog
>>> cat = Catalog()
We can add catalog indexes to catalogs. A catalog index is, among
other things, an attribute index. It indexes attributes of objects. To
see how this works, we'll create a demonstration attribute index. Our
attribute index will simply keep track of objects that have a given
attribute value. The `catalog` package provides an attribute-index
mix-in class that is meant to work with a base indexing class. First,
we'll write the base index class:
>>> import persistent, BTrees.OOBTree, BTrees.IFBTree, BTrees.IOBTree
>>> import zope.interface, zope.index.interfaces
>>> class BaseIndex(persistent.Persistent):
... zope.interface.implements(
... zope.index.interfaces.IInjection,
... zope.index.interfaces.IIndexSearch,
... zope.index.interfaces.IIndexSort,
... )
...
... def clear(self):
... self.forward = BTrees.OOBTree.OOBTree()
... self.backward = BTrees.IOBTree.IOBTree()
...
... __init__ = clear
...
... def index_doc(self, docid, value):
... if docid in self.backward:
... self.unindex_doc(docid)
... self.backward[docid] = value
...
... set = self.forward.get(value)
... if set is None:
... set = BTrees.IFBTree.IFTreeSet()
... self.forward[value] = set
... set.insert(docid)
...
... def unindex_doc(self, docid):
... value = self.backward.get(docid)
... if value is None:
... return
... self.forward[value].remove(docid)
... del self.backward[docid]
...
... def apply(self, value):
... set = self.forward.get(value)
... if set is None:
... set = BTrees.IFBTree.IFTreeSet()
... return set
...
... def sort(self, docids, limit=None, reverse=False):
... for i, docid in enumerate(sorted(docids, key=self.backward.get, reverse=reverse)):
... yield docid
... if limit and i >= (limit - 1):
... break
The class implements `IInjection` to allow values to be indexed and
unindexed and `IIndexSearch` to support searching via the `apply`
method.
Now, we can use the AttributeIndex mixin to make this an attribute
index:
>>> import zope.catalog.attribute
>>> import zope.catalog.interfaces
>>> import zope.container.contained
>>> class Index(zope.catalog.attribute.AttributeIndex,
... BaseIndex,
... zope.container.contained.Contained,
... ):
... zope.interface.implements(zope.catalog.interfaces.ICatalogIndex)
Unfortunately, because of the way we currently handle containment
constraints, we have to provide `ICatalogIndex`, which extends
`IContained`. We subclass `Contained` to get an implementation for
`IContained`.
Now let's add some of these indexes to our catalog. Let's create some
indexes. First we'll define some interfaces providing data to index:
>>> class IFavoriteColor(zope.interface.Interface):
... color = zope.interface.Attribute("Favorite color")
>>> class IPerson(zope.interface.Interface):
... def age():
... """Return the person's age, in years"""
We'll create color and age indexes:
>>> cat['color'] = Index('color', IFavoriteColor)
>>> cat['age'] = Index('age', IPerson, True)
>>> cat['size'] = Index('sz')
The indexes are created with:
- the name of the of the attribute to index
- the interface defining the attribute, and
- a flag indicating whether the attribute should be called, which
defaults to false.
If an interface is provided, then we'll only be able to index an
object if it can be adapted to the interface, otherwise, we'll simply
try to get the attribute from the object. If the attribute isn't
present, then we'll ignore the object.
Now, let's create some objects and index them:
>>> class Person:
... zope.interface.implements(IPerson)
... def __init__(self, age):
... self._age = age
... def age(self):
... return self._age
>>> class Discriminating:
... zope.interface.implements(IFavoriteColor)
... def __init__(self, color):
... self.color = color
>>> class DiscriminatingPerson(Discriminating, Person):
... def __init__(self, age, color):
... Discriminating.__init__(self, color)
... Person.__init__(self, age)
>>> class Whatever:
... def __init__(self, **kw):
... self.__dict__.update(kw)
>>> o1 = Person(10)
>>> o2 = DiscriminatingPerson(20, 'red')
>>> o3 = Discriminating('blue')
>>> o4 = Whatever(a=10, c='blue', sz=5)
>>> o5 = Whatever(a=20, c='red', sz=6)
>>> o6 = DiscriminatingPerson(10, 'blue')
>>> cat.index_doc(1, o1)
>>> cat.index_doc(2, o2)
>>> cat.index_doc(3, o3)
>>> cat.index_doc(4, o4)
>>> cat.index_doc(5, o5)
>>> cat.index_doc(6, o6)
We search by providing query mapping objects that have a key for every
index we want to use:
>>> list(cat.apply({'age': 10}))
[1, 6]
>>> list(cat.apply({'age': 10, 'color': 'blue'}))
[6]
>>> list(cat.apply({'age': 10, 'color': 'blue', 'size': 5}))
[]
>>> list(cat.apply({'size': 5}))
[4]
We can unindex objects:
>>> cat.unindex_doc(4)
>>> list(cat.apply({'size': 5}))
[]
and reindex objects:
>>> o5.sz = 5
>>> cat.index_doc(5, o5)
>>> list(cat.apply({'size': 5}))
[5]
If we clear the catalog, we'll clear all of the indexes:
>>> cat.clear()
>>> [len(index.forward) for index in cat.values()]
[0, 0, 0]
Note that you don't have to use the catalog's search methods. You can
access its indexes directly, since the catalog is a mapping:
>>> [(name, cat[name].field_name) for name in cat]
[(u'age', 'age'), (u'color', 'color'), (u'size', 'sz')]
Catalogs work with int-id utilities, which are responsible for
maintaining id <-> object mappings. To see how this works, we'll
create a utility to work with our catalog:
>>> import zope.intid.interfaces
>>> class Ids:
... zope.interface.implements(zope.intid.interfaces.IIntIds)
... def __init__(self, data):
... self.data = data
... def getObject(self, id):
... return self.data[id]
... def __iter__(self):
... return self.data.iterkeys()
>>> ids = Ids({1: o1, 2: o2, 3: o3, 4: o4, 5: o5, 6: o6})
>>> from zope.component import provideUtility
>>> provideUtility(ids, zope.intid.interfaces.IIntIds)
With this utility in place, catalogs can recompute indexes:
>>> cat.updateIndex(cat['size'])
>>> list(cat.apply({'size': 5}))
[4, 5]
Of course, that only updates *that* index:
>>> list(cat.apply({'age': 10}))
[]
We can update all of the indexes:
>>> cat.updateIndexes()
>>> list(cat.apply({'age': 10}))
[1, 6]
>>> list(cat.apply({'color': 'red'}))
[2]
There's an alternate search interface that returns "result sets".
Result sets provide access to objects, rather than object ids:
>>> result = cat.searchResults(size=5)
>>> len(result)
2
>>> list(result) == [o4, o5]
True
The searchResults method also provides a way to sort, limit and reverse
results.
When not using sorting, limiting and reversing are done by simple slicing
and list reversing.
>>> list(cat.searchResults(size=5, _reverse=True)) == [o5, o4]
True
>>> list(cat.searchResults(size=5, _limit=1)) == [o4]
True
>>> list(cat.searchResults(size=5, _limit=1, _reverse=True)) == [o5]
True
However, when using sorting by index, the limit and reverse parameters
are passed to the index ``sort`` method so it can do it efficiently.
Let's index more objects to work with:
>>> o7 = DiscriminatingPerson(7, 'blue')
>>> o8 = DiscriminatingPerson(3, 'blue')
>>> o9 = DiscriminatingPerson(14, 'blue')
>>> o10 = DiscriminatingPerson(1, 'blue')
>>> ids.data.update({7: o7, 8: o8, 9: o9, 10: o10})
>>> cat.index_doc(7, o7)
>>> cat.index_doc(8, o8)
>>> cat.index_doc(9, o9)
>>> cat.index_doc(10, o10)
Now we can search all people who like blue, ordered by age:
>>> results = list(cat.searchResults(color='blue', _sort_index='age'))
>>> results == [o3, o10, o8, o7, o6, o9]
True
>>> results = list(cat.searchResults(color='blue', _sort_index='age', _limit=3))
>>> results == [o3, o10, o8]
True
>>> results = list(cat.searchResults(color='blue', _sort_index='age', _reverse=True))
>>> results == [o9, o6, o7, o8, o10, o3]
True
>>> results = list(cat.searchResults(color='blue', _sort_index='age', _reverse=True, _limit=4))
>>> results == [o9, o6, o7, o8]
True
The index example we looked at didn't provide document scores. Simple
indexes normally don't, but more complex indexes might give results
scores, according to how closely a document matches a query. Let's
create a new index, a "keyword index" that indexes sequences of
values:
>>> class BaseKeywordIndex(persistent.Persistent):
... zope.interface.implements(
... zope.index.interfaces.IInjection,
... zope.index.interfaces.IIndexSearch,
... )
...
... def clear(self):
... self.forward = BTrees.OOBTree.OOBTree()
... self.backward = BTrees.IOBTree.IOBTree()
...
... __init__ = clear
...
... def index_doc(self, docid, values):
... if docid in self.backward:
... self.unindex_doc(docid)
... self.backward[docid] = values
...
... for value in values:
... set = self.forward.get(value)
... if set is None:
... set = BTrees.IFBTree.IFTreeSet()
... self.forward[value] = set
... set.insert(docid)
...
... def unindex_doc(self, docid):
... values = self.backward.get(docid)
... if values is None:
... return
... for value in values:
... self.forward[value].remove(docid)
... del self.backward[docid]
...
... def apply(self, values):
... result = BTrees.IFBTree.IFBucket()
... for value in values:
... set = self.forward.get(value)
... if set is not None:
... _, result = BTrees.IFBTree.weightedUnion(result, set)
... return result
>>> class KeywordIndex(zope.catalog.attribute.AttributeIndex,
... BaseKeywordIndex,
... zope.container.contained.Contained,
... ):
... zope.interface.implements(zope.catalog.interfaces.ICatalogIndex)
Now, we'll add a hobbies index:
>>> cat['hobbies'] = KeywordIndex('hobbies')
>>> o1.hobbies = 'camping', 'music'
>>> o2.hobbies = 'hacking', 'sailing'
>>> o3.hobbies = 'music', 'camping', 'sailing'
>>> o6.hobbies = 'cooking', 'dancing'
>>> cat.updateIndexes()
When we apply the catalog:
>>> cat.apply({'hobbies': ['music', 'camping', 'sailing']})
BTrees.IFBTree.IFBucket([(1, 2.0), (2, 1.0), (3, 3.0)])
We found objects 1-3, because they each contained at least some of the
words in the query. The scores represent the number of words that
matched. If we also include age:
>>> cat.apply({'hobbies': ['music', 'camping', 'sailing'], 'age': 10})
BTrees.IFBTree.IFBucket([(1, 3.0)])
The score increased because we used an additional index. If an index
doesn't provide scores, scores of 1.0 are assumed.
==============================
Automatic indexing with events
==============================
In order to automatically keep the catalog up-to-date any objects that
are added to a intid utility are indexed automatically. Also when an
object gets modified it is reindexed by listening to IObjectModified
events.
Let us create a fake catalog to demonstrate this behaviour. We only
need to implement the index_doc method for this test.
>>> from zope.catalog.interfaces import ICatalog
>>> from zope import interface, component
>>> class FakeCatalog(object):
... indexed = []
... interface.implements(ICatalog)
... def index_doc(self, docid, obj):
... self.indexed.append((docid, obj))
>>> cat = FakeCatalog()
>>> component.provideUtility(cat)
We also need an intid util and a keyreference adapter.
>>> from zope.intid import IntIds
>>> from zope.intid.interfaces import IIntIds
>>> intids = IntIds()
>>> component.provideUtility(intids, IIntIds)
>>> from zope.keyreference.testing import SimpleKeyReference
>>> component.provideAdapter(SimpleKeyReference)
>>> from zope.container.contained import Contained
>>> class Dummy(Contained):
... def __init__(self, name):
... self.__name__ = name
... def __repr__(self):
... return '<Dummy %r>' % self.__name__
We have a subscriber to IIntidAddedEvent.
>>> from zope.catalog import catalog
>>> from zope.intid.interfaces import IntIdAddedEvent
>>> d1 = Dummy(u'one')
>>> id1 = intids.register(d1)
>>> catalog.indexDocSubscriber(IntIdAddedEvent(d1, None))
Now we have indexed the object.
>>> cat.indexed.pop()
(..., <Dummy u'one'>)
When an object is modified an objectmodified event should be fired by
the application. Here is the handler for such an event.
>>> from zope.lifecycleevent import ObjectModifiedEvent
>>> catalog.reindexDocSubscriber(ObjectModifiedEvent(d1))
>>> len(cat.indexed)
1
>>> cat.indexed.pop()
(..., <Dummy u'one'>)
Preventing automatic indexing
=============================
Sometimes it is not accurate to automatically index an object. For
example when a lot of indexes are in the catalog and only
specific indexes needs to be updated. There are marker interfaces to
achieve this.
>>> from zope.catalog.interfaces import INoAutoIndex
If an object provides this interface it is not automatically indexed.
>>> interface.alsoProvides(d1, INoAutoIndex)
>>> catalog.indexDocSubscriber(IntIdAddedEvent(d1, None))
>>> len(cat.indexed)
0
>>> from zope.catalog.interfaces import INoAutoReindex
If an object provides this interface it is not automatically reindexed.
>>> interface.alsoProvides(d1, INoAutoReindex)
>>> catalog.reindexDocSubscriber(ObjectModifiedEvent(d1))
>>> len(cat.indexed)
0
=======
CHANGES
=======
3.8.2 (2011-11-29)
------------------
- Conform to repository policy.
3.8.1 (2009-12-27)
------------------
- Removed ``zope.app.testing`` dependency.
3.8.0 (2009-02-01)
------------------
- Move core functionality from ``zope.app.catalog`` to this package.
The ``zope.app.catalog`` package now only contains ZMI-related browser
views and backward-compatibility imports.
Keywords: zope3 catalog index
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Zope Public License
Classifier: Programming Language :: Python
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Framework :: Zope3
|