[Checkins] SVN: z3c.etree/trunk/src/z Move the code over to
z3c.etree.
Michael Kerrin
michael.kerrin at openapp.ie
Wed May 2 13:50:09 EDT 2007
Log message for revision 75017:
Move the code over to z3c.etree.
Changed:
A z3c.etree/trunk/src/z3c/
U z3c.etree/trunk/src/z3c/etree/README.txt
U z3c.etree/trunk/src/z3c/etree/doctests.py
U z3c.etree/trunk/src/z3c/etree/testing.py
U z3c.etree/trunk/src/z3c/etree/tests.py
U z3c.etree/trunk/src/z3c/etree/zope.etree-configure.zcml
D z3c.etree/trunk/src/zope/
-=-
Copied: z3c.etree/trunk/src/z3c (from rev 75016, z3c.etree/trunk/src/zope)
Modified: z3c.etree/trunk/src/z3c/etree/README.txt
===================================================================
--- z3c.etree/trunk/src/zope/etree/README.txt 2007-05-02 17:39:36 UTC (rev 75016)
+++ z3c.etree/trunk/src/z3c/etree/README.txt 2007-05-02 17:50:08 UTC (rev 75017)
@@ -5,12 +5,12 @@
This package does not implement the ElementTree API but instead provides
proxy objects that wrap some of the more common ElementTree implementations.
Then one of these proxy objects is registered as a utility, providing the
-*zope.etree.interfaces.IEtree* interface, which can be looked up through
+*z3c.etree.interfaces.IEtree* interface, which can be looked up through
the Zope component architecture. Thus removing the hard dependency a Python
import statement introduces on any one ElementTree implementation.
This will allow anyone interested in just trying out a module developed using
-*zope.etree* to use a pure Python implementation of ElementTree (which is really
+*z3c.etree* to use a pure Python implementation of ElementTree (which is really
easy to install, but slow). While a developer who is in the final stages of
going live with a new site might want to configure the same module to use lxml
(which is *not* easy to install as it depends on libxml2 and libxslt but is
@@ -23,32 +23,32 @@
Installation and Configuration
==============================
-*zope.etree* is installed like any other Zope3 module. That is it should be
-copied verbatim into your Python path and the zope.etree-configure.zcml file
+*z3c.etree* is installed like any other Zope3 module. That is it should be
+copied verbatim into your Python path and the z3c.etree-configure.zcml file
should be copied to the package-includes directory for each instance of Zope
that requires this package. (Once I figure out how to, I will use Python eggs
for the installation process.)
-Now each of the zope.etree-configure.zcml files that exist in a instances
+Now each of the z3c.etree-configure.zcml files that exist in a instances
package-includes directory can be edited to configure which ElementTree
implementation to use within that instance.
To configure a particular ElementTree implementation for an instance the
-zope.etree-configure.zcml file should contain only one ZCML utility
+z3c.etree-configure.zcml file should contain only one ZCML utility
declaration. For example to configure an instance use lxml
-zope.etree-configure.zcml should contain the the following::
+z3c.etree-configure.zcml should contain the the following::
<utility
- factory="zope.etree.etree.LxmlEtree"
+ factory="z3c.etree.etree.LxmlEtree"
/>
-Where *zope.etree.etree.LxmlEtree* is the proxy object that wraps the lxml
+Where *z3c.etree.etree.LxmlEtree* is the proxy object that wraps the lxml
implementation. Currently the other implementations include:
-+ *zope.etree.etree.EtreeEtree* - proxy for the pure python *elementtree*
++ *z3c.etree.etree.EtreeEtree* - proxy for the pure python *elementtree*
module.
-+ *zope.etree.etree.EtreePy25* - proxy for the ElementTree implementation
++ *z3c.etree.etree.EtreePy25* - proxy for the ElementTree implementation
included in Python 2.5's standard library.
Tests setup
@@ -57,23 +57,23 @@
Some setup for the developers tests.
>>> from zope import component
- >>> import zope.etree.interfaces
+ >>> import z3c.etree.interfaces
This happens automatically during Zope startup.
- >>> from zope.etree.testing import etreeSetup, etreeTearDown
- >>> from zope.etree.testing import assertXMLEqual
+ >>> from z3c.etree.testing import etreeSetup, etreeTearDown
+ >>> from z3c.etree.testing import assertXMLEqual
>>> dummy = etreeSetup()
Developers
==========
-Here are some examples for how to use *zope.etree* with your own code.
+Here are some examples for how to use *z3c.etree* with your own code.
To generate a Element object with the tag *DAV:getcontenttype* all we have
to do is:
- >>> etree = component.getUtility(zope.etree.interfaces.IEtree)
+ >>> etree = component.getUtility(z3c.etree.interfaces.IEtree)
>>> elem = etree.Element("{DAV:}getcontenttype")
>>> assertXMLEqual(etree.tostring(elem), """
... <ns0:getcontenttype xmlns:ns0="DAV:"/>""")
@@ -89,16 +89,16 @@
=======
For developers who are writing unit tests for their code that uses
-*zope.etree*. They should call the method *zope.etree.testing.etreeSetup* in
+*z3c.etree*. They should call the method *z3c.etree.testing.etreeSetup* in
there tests setup code, in order to correctly register a ElementTree utility
for use within their tests. And similar, call the method
-*zope.etree.testing.etreeTearDown* in their teardown code. See the Setup
+*z3c.etree.testing.etreeTearDown* in their teardown code. See the Setup
and Teardown sections of this file.
-The *etreeSetup* method will load and parse the *zope.etree-configure.zcml*
-file from within the *zope.etree* module (NOT the file from the instance). So
+The *etreeSetup* method will load and parse the *z3c.etree-configure.zcml*
+file from within the *z3c.etree* module (NOT the file from the instance). So
if the default utility defined in this file, which is
-*zope.etree.etree.EtreeEtree*, doesn't apply to your system due to a missing
+*z3c.etree.etree.EtreeEtree*, doesn't apply to your system due to a missing
module for example, then this file should be edited to reflect this.
Teardown
Modified: z3c.etree/trunk/src/z3c/etree/doctests.py
===================================================================
--- z3c.etree/trunk/src/zope/etree/doctests.py 2007-05-02 17:39:36 UTC (rev 75016)
+++ z3c.etree/trunk/src/z3c/etree/doctests.py 2007-05-02 17:50:08 UTC (rev 75017)
@@ -1,6 +1,6 @@
import unittest
from zope.testing import doctest
-import zope.etree.testing
+import z3c.etree.testing
def test_suite():
@@ -8,9 +8,9 @@
suite.addTest(doctest.DocFileSuite(
"doctests.txt",
- checker = zope.etree.testing.xmlOutputChecker,
- setUp = zope.etree.testing.etreeSetup,
- tearDown = zope.etree.testing.etreeTearDown,
- optionflags = zope.etree.testing.XMLDATA))
+ checker = z3c.etree.testing.xmlOutputChecker,
+ setUp = z3c.etree.testing.etreeSetup,
+ tearDown = z3c.etree.testing.etreeTearDown,
+ optionflags = z3c.etree.testing.XMLDATA))
return suite
Modified: z3c.etree/trunk/src/z3c/etree/testing.py
===================================================================
--- z3c.etree/trunk/src/zope/etree/testing.py 2007-05-02 17:39:36 UTC (rev 75016)
+++ z3c.etree/trunk/src/z3c/etree/testing.py 2007-05-02 17:50:08 UTC (rev 75017)
@@ -21,8 +21,8 @@
import zope.component
from zope.testing import doctest
-import zope.etree
-import zope.etree.etree
+import z3c.etree
+import z3c.etree.etree
#
# Setup for Zope etree.
@@ -31,10 +31,10 @@
engine_env_key = "ELEMENTTREE_ENGINE"
known_engines = {
- "cElementTree": ("cElementTree", zope.etree.etree.CEtree),
- "elementtree": ("elementtree.ElemenTree", zope.etree.etree.EtreeEtree),
- "lxml": ("lxml.etree", zope.etree.etree.LxmlEtree),
- "py25": ("xml.etree", zope.etree.etree.EtreePy25),
+ "cElementTree": ("cElementTree", z3c.etree.etree.CEtree),
+ "elementtree": ("elementtree.ElemenTree", z3c.etree.etree.EtreeEtree),
+ "lxml": ("lxml.etree", z3c.etree.etree.LxmlEtree),
+ "py25": ("xml.etree", z3c.etree.etree.EtreePy25),
}
def etreeSetup(test = None):
@@ -68,7 +68,7 @@
# error in trying to teardown the engine. The getEngine method caches
# the utility lookup bypassing the need for the global site manger
# to know about the utility and thus not causing errors during tear down.
- engine = zope.etree.getEngine()
+ engine = z3c.etree.getEngine()
return engine
@@ -79,9 +79,9 @@
del test.globs["etree"]
del test.globs["assertXMLEqual"]
if etreeEngine is None:
- etreeEngine = zope.etree.getEngine()
+ etreeEngine = z3c.etree.getEngine()
zope.component.getGlobalSiteManager().unregisterUtility(etreeEngine)
- zope.etree._utility = None # clear the cache
+ z3c.etree._utility = None # clear the cache
#
# Handy methods for testing if two xml fragmenets are equal.
@@ -118,7 +118,7 @@
>>> _assertTextEqual("test", "nottest", XMLDATA)
(False, "''test' != 'nottest'' have different element content.")
- >>> etree = zope.etree.getEngine()
+ >>> etree = z3c.etree.getEngine()
>>> _assertTextEqual("test", etree.Element("test"), XMLDATA)
Traceback (most recent call last):
...
@@ -146,7 +146,7 @@
def _assertXMLElementEqual(want, got, optionflags):
# See assertXMLEqual for tests - it is easier to the tests with strings that
# get converted to element tree objects in assertXMLEqual.
- etree = zope.etree.getEngine()
+ etree = z3c.etree.getEngine()
if want.tag != got.tag:
return False, "%r != %r different tag name." %(want.tag, got.tag)
@@ -294,7 +294,7 @@
Test passing elementtree objects through the first arguement.
- >>> etree = zope.etree.getEngine()
+ >>> etree = z3c.etree.getEngine()
>>> elroot = etree.Element('test')
>>> eltree = etree.ElementTree(elroot)
@@ -307,7 +307,7 @@
>>> assertXMLEqual(elroot, '<test />')
"""
- etree = zope.etree.getEngine()
+ etree = z3c.etree.getEngine()
if isinstance(want, (str, unicode)):
want = etree.fromstring(want)
@@ -330,7 +330,7 @@
#
def _assertXMLElement(want, got, optionflags):
- etree = zope.etree.getEngine()
+ etree = z3c.etree.getEngine()
def clean_string(s):
if not isinstance(s, (str, unicode)):
Modified: z3c.etree/trunk/src/z3c/etree/tests.py
===================================================================
--- z3c.etree/trunk/src/zope/etree/tests.py 2007-05-02 17:39:36 UTC (rev 75016)
+++ z3c.etree/trunk/src/z3c/etree/tests.py 2007-05-02 17:50:08 UTC (rev 75017)
@@ -36,7 +36,7 @@
from zope.interface.verify import verifyObject
from zope.app.testing import placelesssetup
-import zope.etree.etree
+import z3c.etree.etree
from interfaces import IEtree
from testing import etreeSetup, etreeTearDown
@@ -98,7 +98,7 @@
class OrigElementTreeTestCase(BaseEtreeTestCase):
def setUp(self):
- from zope.etree.etree import EtreeEtree
+ from z3c.etree.etree import EtreeEtree
self.etree = EtreeEtree()
def tearDown(self):
@@ -108,7 +108,7 @@
class CElementTreeTestCase(BaseEtreeTestCase):
def setUp(self):
- from zope.etree.etree import CEtree
+ from z3c.etree.etree import CEtree
self.etree = CEtree()
def tearDown(self):
@@ -118,7 +118,7 @@
class LXMLElementTreeTestCase(BaseEtreeTestCase):
def setUp(self):
- from zope.etree.etree import LxmlEtree
+ from z3c.etree.etree import LxmlEtree
self.etree = LxmlEtree()
def tearDown(self):
@@ -147,7 +147,7 @@
class Python25ElementTreeTestCase(BaseEtreeTestCase):
def setUp(self):
- from zope.etree.etree import EtreePy25
+ from z3c.etree.etree import EtreePy25
self.etree = EtreePy25()
def tearDown(self):
@@ -160,7 +160,7 @@
def test_warn(self):
self.fail("""
- WARNING: zope.etree needs ElementTree installed in order to run.
+ WARNING: z3c.etree needs ElementTree installed in order to run.
""")
@@ -231,8 +231,8 @@
test.globs['old_configure_logging'] = testrunner.configure_logging
testrunner.configure_logging = lambda : None
test.globs['old_engine'] = os.environ.get(
- zope.etree.testing.engine_env_key)
- os.environ[zope.etree.testing.engine_env_key] = self.engine_key
+ z3c.etree.testing.engine_env_key)
+ os.environ[z3c.etree.testing.engine_env_key] = self.engine_key
def doctestsTearDown(test):
@@ -242,7 +242,7 @@
sys.modules.update(test.globs['saved-sys-info'][2])
testrunner.configure_logging = test.globs['old_configure_logging']
del test.globs['old_configure_logging']
- del os.environ[zope.etree.testing.engine_env_key]
+ del os.environ[z3c.etree.testing.engine_env_key]
del test.globs['old_engine']
@@ -273,21 +273,21 @@
import elementtree
suite.addTest(unittest.makeSuite(OrigElementTreeTestCase))
suite.addTest(doctest.DocTestSuite(
- "zope.etree.testing",
+ "z3c.etree.testing",
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
- setUp = setUp(zope.etree.etree.EtreeEtree()),
+ setUp = setUp(z3c.etree.etree.EtreeEtree()),
tearDown = tearDown))
suite.addTest(doctest.DocFileSuite(
- "doctesttests.txt", package = zope.etree,
+ "doctesttests.txt", package = z3c.etree,
checker = checker,
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
setUp = doctestsSetup("elementtree"),
tearDown = doctestsTearDown))
suite.addTest(doctest.DocFileSuite(
- "doctestssuccess.txt", package = zope.etree,
- checker = zope.etree.testing.xmlOutputChecker,
+ "doctestssuccess.txt", package = z3c.etree,
+ checker = z3c.etree.testing.xmlOutputChecker,
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
- setUp = setUp(zope.etree.etree.EtreeEtree()),
+ setUp = setUp(z3c.etree.etree.EtreeEtree()),
tearDown = tearDown))
foundetree = True
except ImportError:
@@ -297,21 +297,21 @@
import cElementTree
suite.addTest(unittest.makeSuite(CElementTreeTestCase))
suite.addTest(doctest.DocTestSuite(
- "zope.etree.testing",
+ "z3c.etree.testing",
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
- setUp = setUp(zope.etree.etree.CEtree()),
+ setUp = setUp(z3c.etree.etree.CEtree()),
tearDown = tearDown))
suite.addTest(doctest.DocFileSuite(
- "doctesttests.txt", package = zope.etree,
+ "doctesttests.txt", package = z3c.etree,
checker = checker,
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
setUp = doctestsSetup("cElementTree"),
tearDown = doctestsTearDown))
suite.addTest(doctest.DocFileSuite(
- "doctestssuccess.txt", package = zope.etree,
- checker = zope.etree.testing.xmlOutputChecker,
+ "doctestssuccess.txt", package = z3c.etree,
+ checker = z3c.etree.testing.xmlOutputChecker,
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
- setUp = setUp(zope.etree.etree.CEtree()),
+ setUp = setUp(z3c.etree.etree.CEtree()),
tearDown = tearDown))
foundetree = True
except ImportError:
@@ -321,21 +321,21 @@
import lxml.etree
suite.addTest(unittest.makeSuite(LXMLElementTreeTestCase))
suite.addTest(doctest.DocTestSuite(
- "zope.etree.testing",
+ "z3c.etree.testing",
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
- setUp = setUp(zope.etree.etree.LxmlEtree()),
+ setUp = setUp(z3c.etree.etree.LxmlEtree()),
tearDown = tearDown))
suite.addTest(doctest.DocFileSuite(
- "doctesttests.txt", package = zope.etree,
+ "doctesttests.txt", package = z3c.etree,
checker = checker,
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
setUp = doctestsSetup("lxml"),
tearDown = doctestsTearDown))
suite.addTest(doctest.DocFileSuite(
- "doctestssuccess.txt", package = zope.etree,
- checker = zope.etree.testing.xmlOutputChecker,
+ "doctestssuccess.txt", package = z3c.etree,
+ checker = z3c.etree.testing.xmlOutputChecker,
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
- setUp = setUp(zope.etree.etree.LxmlEtree()),
+ setUp = setUp(z3c.etree.etree.LxmlEtree()),
tearDown = tearDown))
foundetree = True
except ImportError:
@@ -345,21 +345,21 @@
import xml.etree
suite.addTest(unittest.makeSuite(Python25ElementTreeTestCase))
suite.addTest(doctest.DocTestSuite(
- "zope.etree.testing",
+ "z3c.etree.testing",
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
- setUp = setUp(zope.etree.etree.EtreePy25()),
+ setUp = setUp(z3c.etree.etree.EtreePy25()),
tearDown = tearDown))
suite.addTest(doctest.DocFileSuite(
- "doctesttests.txt", package = zope.etree,
+ "doctesttests.txt", package = z3c.etree,
checker = checker,
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
setUp = doctestsSetup("py25"),
tearDown = doctestsTearDown))
suite.addTest(doctest.DocFileSuite(
- "doctestssuccess.txt", package = zope.etree,
- checker = zope.etree.testing.xmlOutputChecker,
+ "doctestssuccess.txt", package = z3c.etree,
+ checker = z3c.etree.testing.xmlOutputChecker,
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
- setUp = setUp(zope.etree.etree.EtreePy25()),
+ setUp = setUp(z3c.etree.etree.EtreePy25()),
tearDown = tearDown))
foundetree = True
except ImportError:
@@ -370,14 +370,14 @@
else:
# rerun the current testing doctest using the default setUp
suite.addTest(doctest.DocTestSuite(
- "zope.etree.testing",
+ "z3c.etree.testing",
optionflags = doctest.ELLIPSIS + doctest.NORMALIZE_WHITESPACE,
setUp = etreeSetup,
tearDown = etreeTearDown))
# run the README tests to make the documentation does something
suite.addTest(doctest.DocFileSuite(
- "README.txt", package = "zope.etree"))
+ "README.txt", package = "z3c.etree"))
# test teardown
suite.addTest(unittest.makeSuite(UnusedEtree))
Modified: z3c.etree/trunk/src/z3c/etree/zope.etree-configure.zcml
===================================================================
--- z3c.etree/trunk/src/zope/etree/zope.etree-configure.zcml 2007-05-02 17:39:36 UTC (rev 75016)
+++ z3c.etree/trunk/src/z3c/etree/zope.etree-configure.zcml 2007-05-02 17:50:08 UTC (rev 75017)
@@ -4,14 +4,14 @@
ElementTree support for Zope (you probable what to edit this)
This file also configures which ElementTree engine to use for all the
- zope.etree unit tests also. See the README.txt file.
+ z3c.etree unit tests also. See the README.txt file.
-->
<!--
uses the *elementtree* module.
-->
<utility
- factory="zope.etree.etree.EtreeEtree"
+ factory="z3c.etree.etree.EtreeEtree"
/>
<!--
@@ -19,7 +19,7 @@
-->
<!--
<utility
- factory="zope.etree.etree.CEtree"
+ factory="z3c.etree.etree.CEtree"
/>
-->
@@ -28,7 +28,7 @@
-->
<!--
<utility
- factory="zope.etree.etree.LxmlEtree"
+ factory="z3c.etree.etree.LxmlEtree"
/>
-->
@@ -37,7 +37,7 @@
-->
<!--
<utility
- factory="zope.etree.etree.EtreePy25"
+ factory="z3c.etree.etree.EtreePy25"
/>
-->
More information about the Checkins
mailing list