<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[12130] twext/trunk/twext/who</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/12130">12130</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2013-12-18 14:28:51 -0800 (Wed, 18 Dec 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Make ConstantsContainer a bit more user-friendly.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#twexttrunktwextwhoaggregatepy">twext/trunk/twext/who/aggregate.py</a></li>
<li><a href="#twexttrunktwextwhodirectorypy">twext/trunk/twext/who/directory.py</a></li>
<li><a href="#twexttrunktwextwhoidirectorypy">twext/trunk/twext/who/idirectory.py</a></li>
<li><a href="#twexttrunktwextwhoindexpy">twext/trunk/twext/who/index.py</a></li>
<li><a href="#twexttrunktwextwhoopendirectoryservicepy">twext/trunk/twext/who/opendirectory/service.py</a></li>
<li><a href="#twexttrunktwextwhotesttest_utilpy">twext/trunk/twext/who/test/test_util.py</a></li>
<li><a href="#twexttrunktwextwhoutilpy">twext/trunk/twext/who/util.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="twexttrunktwextwhoaggregatepy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/aggregate.py (12129 => 12130)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/aggregate.py 2013-12-18 19:29:44 UTC (rev 12129)
+++ twext/trunk/twext/who/aggregate.py 2013-12-18 22:28:51 UTC (rev 12130)
</span><span class="lines">@@ -71,10 +71,10 @@
</span><span class="cx"> @property
</span><span class="cx"> def recordType(self):
</span><span class="cx"> if not hasattr(self, "_recordType"):
</span><del>- self._recordType = ConstantsContainer(chain(*tuple(
</del><ins>+ self._recordType = ConstantsContainer(tuple(
</ins><span class="cx"> s.recordTypes()
</span><span class="cx"> for s in self.services
</span><del>- )))
</del><ins>+ ))
</ins><span class="cx"> return self._recordType
</span><span class="cx">
</span><span class="cx">
</span></span></pre></div>
<a id="twexttrunktwextwhodirectorypy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/directory.py (12129 => 12130)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/directory.py 2013-12-18 19:29:44 UTC (rev 12129)
+++ twext/trunk/twext/who/directory.py 2013-12-18 22:28:51 UTC (rev 12130)
</span><span class="lines">@@ -87,7 +87,7 @@
</span><span class="cx"> """
</span><span class="cx">
</span><span class="cx"> recordType = RecordType
</span><del>- fieldName = FieldName
</del><ins>+ fieldName = FieldName
</ins><span class="cx">
</span><span class="cx"> normalizedFields = {
</span><span class="cx"> FieldName.emailAddresses: lambda e: bytes(e).lower(),
</span></span></pre></div>
<a id="twexttrunktwextwhoidirectorypy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/idirectory.py (12129 => 12130)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/idirectory.py 2013-12-18 19:29:44 UTC (rev 12129)
+++ twext/trunk/twext/who/idirectory.py 2013-12-18 22:28:51 UTC (rev 12130)
</span><span class="lines">@@ -119,7 +119,7 @@
</span><span class="cx"> """
</span><span class="cx"> Constants for common directory record field names.
</span><span class="cx">
</span><del>- Fields as assciated with either a single value or an iterable of values.
</del><ins>+ Fields as associated with either a single value or an iterable of values.
</ins><span class="cx">
</span><span class="cx"> @cvar uid: The primary unique identifier for a directory record.
</span><span class="cx"> The associated value must be a L{unicode}.
</span></span></pre></div>
<a id="twexttrunktwextwhoindexpy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/index.py (12129 => 12130)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/index.py 2013-12-18 19:29:44 UTC (rev 12129)
+++ twext/trunk/twext/who/index.py 2013-12-18 22:28:51 UTC (rev 12130)
</span><span class="lines">@@ -24,8 +24,6 @@
</span><span class="cx"> "DirectoryRecord",
</span><span class="cx"> ]
</span><span class="cx">
</span><del>-from itertools import chain
-
</del><span class="cx"> from twisted.python.constants import Names, NamedConstant
</span><span class="cx"> from twisted.internet.defer import succeed, inlineCallbacks, returnValue
</span><span class="cx">
</span><span class="lines">@@ -142,9 +140,8 @@
</span><span class="cx"> which are indexed.
</span><span class="cx"> """
</span><span class="cx">
</span><del>- fieldName = ConstantsContainer(chain(
- BaseDirectoryService.fieldName.iterconstants(),
- FieldName.iterconstants()
</del><ins>+ fieldName = ConstantsContainer((
+ BaseDirectoryService.fieldName, FieldName
</ins><span class="cx"> ))
</span><span class="cx">
</span><span class="cx"> indexedFields = (
</span></span></pre></div>
<a id="twexttrunktwextwhoopendirectoryservicepy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/opendirectory/service.py (12129 => 12130)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/opendirectory/service.py 2013-12-18 19:29:44 UTC (rev 12129)
+++ twext/trunk/twext/who/opendirectory/service.py 2013-12-18 22:28:51 UTC (rev 12130)
</span><span class="lines">@@ -194,6 +194,7 @@
</span><span class="cx"> compound = ValueConstant(0x210B)
</span><span class="cx"> compound.matchType = MatchType.compound
</span><span class="cx">
</span><ins>+
</ins><span class="cx"> @classmethod
</span><span class="cx"> def fromMatchType(cls, matchType):
</span><span class="cx"> if not hasattr(cls, "_matchTypeByMatchType"):
</span></span></pre></div>
<a id="twexttrunktwextwhotesttest_utilpy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/test/test_util.py (12129 => 12130)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/test/test_util.py 2013-12-18 19:29:44 UTC (rev 12129)
+++ twext/trunk/twext/who/test/test_util.py 2013-12-18 22:28:51 UTC (rev 12130)
</span><span class="lines">@@ -18,6 +18,8 @@
</span><span class="cx"> Directory service utility tests.
</span><span class="cx"> """
</span><span class="cx">
</span><ins>+from itertools import chain
+
</ins><span class="cx"> from twisted.trial import unittest
</span><span class="cx"> from twisted.python.constants import Names, NamedConstant
</span><span class="cx"> from twisted.python.constants import Flags, FlagConstant
</span><span class="lines">@@ -36,7 +38,12 @@
</span><span class="cx"> screwdriver.description = u"screw twister"
</span><span class="cx">
</span><span class="cx">
</span><ins>+class MoreTools(Names):
+ saw = NamedConstant()
</ins><span class="cx">
</span><ins>+ saw.description = u"z maker"
+
+
</ins><span class="cx"> class Instruments(Names):
</span><span class="cx"> hammer = NamedConstant()
</span><span class="cx"> chisel = NamedConstant()
</span><span class="lines">@@ -57,14 +64,66 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> class ConstantsContainerTest(unittest.TestCase):
</span><del>- def test_conflict(self):
- constants = set((Tools.hammer, Instruments.hammer))
- self.assertRaises(ValueError, ConstantsContainer, constants)
</del><ins>+ """
+ Tests for L{ConstantsContainer}.
+ """
</ins><span class="cx">
</span><ins>+ def test_constants_from_constants(self):
+ """
+ Initialize a container from some constants.
+ """
+ constants = set((Tools.hammer, Tools.screwdriver, Instruments.chisel))
+ self.assertEquals(
+ set(ConstantsContainer(constants).iterconstants()),
+ constants,
+ )
</ins><span class="cx">
</span><ins>+
+ def test_constants_from_containers(self):
+ """
+ Initialize a container from other containers.
+ """
+ self.assertEquals(
+ set(ConstantsContainer((Tools, MoreTools)).iterconstants()),
+ set(chain(Tools.iterconstants(), MoreTools.iterconstants())),
+ )
+
+
+ def test_constants_from_iterables(self):
+ """
+ Initialize a container from iterables of constants.
+ """
+ self.assertEquals(
+ set(
+ ConstantsContainer((
+ Tools.iterconstants(), MoreTools.iterconstants()
+ )).iterconstants()
+ ),
+ set(chain(Tools.iterconstants(), MoreTools.iterconstants())),
+ )
+
+
+ def test_conflictingClasses(self):
+ """
+ A container can't contain two constants with the same name.
+ """
+ self.assertRaises(TypeError, ConstantsContainer, (Tools, Switches))
+
+
+ def test_conflictingNames(self):
+ """
+ A container can't contain two constants with the same name.
+ """
+ self.assertRaises(ValueError, ConstantsContainer, (Tools, Instruments))
+
+
</ins><span class="cx"> def test_attrs(self):
</span><del>- constants = set((Tools.hammer, Tools.screwdriver, Instruments.chisel))
- container = ConstantsContainer(constants)
</del><ins>+ """
+ Constants are assessible via attributes.
+ """
+ container = ConstantsContainer((
+ Tools.hammer, Tools.screwdriver, Instruments.chisel
+ ))
</ins><span class="cx">
</span><span class="cx"> self.assertEquals(container.hammer, Tools.hammer)
</span><span class="cx"> self.assertEquals(container.screwdriver, Tools.screwdriver)
</span><span class="lines">@@ -73,6 +132,10 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> def test_iterconstants(self):
</span><ins>+ """
+ L{ConstantsContainer.iterconstants}C{()} produces the contained
+ constants.
+ """
</ins><span class="cx"> constants = set((Tools.hammer, Tools.screwdriver, Instruments.chisel))
</span><span class="cx"> container = ConstantsContainer(constants)
</span><span class="cx">
</span><span class="lines">@@ -81,7 +144,11 @@
</span><span class="cx"> constants,
</span><span class="cx"> )
</span><span class="cx">
</span><ins>+
</ins><span class="cx"> def test_lookupByName(self):
</span><ins>+ """
+ Constants are assessible via L{ConstantsContainer.lookupByName}.
+ """
</ins><span class="cx"> constants = set((
</span><span class="cx"> Instruments.hammer,
</span><span class="cx"> Tools.screwdriver,
</span><span class="lines">@@ -110,14 +177,20 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> class UtilTest(unittest.TestCase):
</span><ins>+ """
+ Miscellaneous tests.
+ """
+
</ins><span class="cx"> def test_uniqueResult(self):
</span><span class="cx"> self.assertEquals(1, uniqueResult((1,)))
</span><span class="cx"> self.assertRaises(DirectoryServiceError, uniqueResult, (1, 2, 3))
</span><span class="cx">
</span><ins>+
</ins><span class="cx"> def test_describe(self):
</span><span class="cx"> self.assertEquals(u"nail pounder", describe(Tools.hammer))
</span><span class="cx"> self.assertEquals(u"hammer", describe(Instruments.hammer))
</span><span class="cx">
</span><ins>+
</ins><span class="cx"> def test_describeFlags(self):
</span><span class="cx"> self.assertEquals(u"blue", describe(Switches.b))
</span><span class="cx"> self.assertEquals(u"red|green", describe(Switches.r | Switches.g))
</span></span></pre></div>
<a id="twexttrunktwextwhoutilpy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/who/util.py (12129 => 12130)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/who/util.py 2013-12-18 19:29:44 UTC (rev 12129)
+++ twext/trunk/twext/who/util.py 2013-12-18 22:28:51 UTC (rev 12130)
</span><span class="lines">@@ -26,7 +26,8 @@
</span><span class="cx"> "iterFlags",
</span><span class="cx"> ]
</span><span class="cx">
</span><del>-from twisted.python.constants import FlagConstant
</del><ins>+from twisted.python.constants import Names, Values, Flags
+from twisted.python.constants import NamedConstant, ValueConstant, FlagConstant
</ins><span class="cx">
</span><span class="cx"> from twext.who.idirectory import DirectoryServiceError
</span><span class="cx">
</span><span class="lines">@@ -36,14 +37,45 @@
</span><span class="cx"> """
</span><span class="cx"> A container for constants.
</span><span class="cx"> """
</span><del>- def __init__(self, constants):
- myConstants = {}
</del><ins>+ def __init__(self, sources):
+ self._constants = {}
+
+ for source in sources:
+ if type(source) is type:
+ if issubclass(
+ source, (ConstantsContainer, Names, Values, Flags)
+ ):
+ self._addConstants(source.iterconstants())
+ else:
+ raise TypeError(
+ "Unknown constants type: {0}".format(source)
+ )
+
+ elif isinstance(
+ source, (NamedConstant, ValueConstant, FlagConstant)
+ ):
+ self._addConstants((source,))
+
+ else:
+ self._addConstants(source)
+
+
+ def _addConstants(self, constants):
</ins><span class="cx"> for constant in constants:
</span><del>- if constant.name in myConstants:
</del><ins>+ if hasattr(self, "_constantsClass"):
+ if constant.__class__ != self._constantsClass:
+ raise TypeError(
+ "Can't mix constants classes in the "
+ "same constants container: {0} != {1}"
+ .format(constant.__class__, self._constantsClass)
+ )
+ else:
+ self._constantsClass = constant.__class__
+
+ if constant.name in self._constants:
</ins><span class="cx"> raise ValueError("Name conflict: {0}".format(constant.name))
</span><del>- myConstants[constant.name] = constant
</del><span class="cx">
</span><del>- self._constants = myConstants
</del><ins>+ self._constants[constant.name] = constant
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx"> def __getattr__(self, name):
</span></span></pre>
</div>
</div>
</body>
</html>