Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.

pypm install z3ext.lucene

How to install z3ext.lucene

  1. Download and install ActivePython
  2. Open Command Prompt
  3. Type pypm install z3ext.lucene
 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
1.1.4 Available View build log
Windows (64-bit)
1.1.4 Available View build log
Mac OS X (10.5+)
1.1.4 Available View build log
Linux (32-bit)
1.1.4 Available View build log
Linux (64-bit)
1.1.4 Available View build log
ZPL 2.1
Lastest release
version 1.1.4 on Jan 5th, 2011

Lucene Text index

Apache Lucene index for zope3. Jython is required.

For configure default settings, add following code to zope.conf

<product-config z3ext.lucene> server1 testing server,8981,/path-to-lucene/Zope3/var/luceneindex </product-config>

First server record, then parameters seperated by ',' First title of lucene server also this title is using for utility name, port, directory where lucene should create it's data

We need temporary directory

>>> import tempfile
>>> lucene_dir = tempfile.mkdtemp()

We'll try emulate <product-config z3ext.lucene>

>>> from z3ext.lucene.tests import JYTHON
>>> from zope.app.appsetup import product
>>> product._configs['z3ext.lucene'] = {'server1': \
...  'testing server,56999,%s'%lucene_dir, 'jython': JYTHON}

Let's check this

>>> product.getProductConfiguration('z3ext.lucene')
{'jython': '...jython', 'server1': 'testing server,56999,...'}

Usually startLucene() function is colled during IDatabaseOpenedEvent event, we simply call it directly:

>>> from z3ext.lucene.server.subscribers import startLucene
>>> startLucene(None)

Lucene server registers in system as ILucene with name.

>>> from zope.component import getUtility
>>> from z3ext.lucene.server.interfaces import ILucene
>>> server = getUtility(ILucene, 'testing server')
>>> print server
LuceneServer<testing server,port=56999>

We need give some time to lucene server to start

>>> import time
>>> time.sleep(5)

Now we need catalog index

>>> from z3ext.lucene.index import LuceneTextIndex
>>> index = LuceneTextIndex('testing server')
>>> from zope import interface
>>> from zope.index.text.interfaces import ISearchableText

Indexed document you have ISearchableText adapter to get indexed. We will create simple object that implements ISearchableText

>>> class Document(object):
...    interface.implements(ISearchableText)
...    def __init__(self, text):
...       self.text = text
...    def getSearchableText(self):
...       return self.text
>>> doc1 = Document(\
...   "A utility is registered to provide an interface with a "\
...   "name. If a component provides only one interface, then the"\
...   "provides argument can be omitted and the provided interface"\
...   "will be used. (In this case, provides argument can still be"\
...   "provided to provide a less specific interface.)")
>>> doc2 = Document(\
...   "Return a list of adapters that match. If an adapter is named, "\
...   "only the most specific adapter of a given name is returned." \
...   "If context is None, an application-defined policy is used to choose "\
...   "an appropriate service manager from which to get an 'Adapters' service.")

Let's index documents

>>> index.index_doc('1', doc1)
>>> index.index_doc('2', doc2)

Now we can search text

>>> list(index.apply('component provides'))
>>> list(index.apply('service manager'))
>>> list(index.apply('name'))
[1, 2]


>>> index.documentCount(), index.wordCount()
(2, 0)

We can use any number of Luxene indexes with one lucene server

>>> index2 = LuceneTextIndex('testing server')
>>> list(index2.apply('component provides'))
>>> list(index2.apply('service manager'))
>>> list(index2.apply('name'))
ZEO setup

With zeo setup we should run only one copy of Lucene Server. So we can start lucene server on one zope instance (or by using z3ext/lucene/server/server.sh script we can run lucene server anywhere) and on other instances we can use LuceneClient

Configuration for zope.conf

<product-config z3ext.lucene> client1 lucene client, </product-config>

>>> from zope.component import provideUtility
>>> from z3ext.lucene.server.client import LuceneClient
>>> client = LuceneClient('lucene client', '')
>>> provideUtility(client, ILucene, 'lucene client')
>>> index.utility = 'lucene client'
>>> list(index.apply('component provides'))
>>> list(index.apply('service manager'))
>>> list(index.apply('name'))
[1, 2]
>>> index.unindex_doc('2')
>>> list(index.apply('service manager'))
>>> index.clear()


1.1.4 (2008-10-09)
  • Fixed error in unindexObject
1.1.3 (2008-09-18)
  • Fixed LookupError
1.1.2 (2008-03-25)
  • fix: don't split query if it is string
  • code moved to svn.zope.org
1.1.1 (2008-02-21)
  • Use z3ext.layoutform for product configuration
  • Catch exception during server startup and indexing
1.1.0 (2008-02-01)
  • Added support for z3ext.product
1.0.0 (2007-12-08)
  • Initial release.

Subscribe to package updates

Last updated Jan 5th, 2011

Download Stats

Last month:6

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.