Changeset 188:b39caf780587

Timestamp:

May 6, 2013, 9:15:41 PM (8 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

hg-git-rename-source:

git

Message:

Deprecate prepareIDNName.

C{unicode.encode('idna')} does exactly the same as the recently
introduced L{generic.prepareIDNName}.

Files:

• NEWS (modified) (1 diff)
• wokkel/client.py (modified) (2 diffs)
• wokkel/generic.py (modified) (3 diffs)
• wokkel/server.py (modified) (2 diffs)
• wokkel/test/test_generic.py (modified) (2 diffs)

NEWS

@@ +1 @@
+0.8.0 (xxxx-xx-xx)
+==================
+
+Deprecations
+--------
+
+ - wokkel.generic.prepareIDNName is deprecated in favor of
+   unicode.encode('idna').
+
+
 0.7.1 (2013-01-12)
 ==================

wokkel/client.py

@@ -88 +88 @@
     def __init__(self, jid, password, host=None, port=5222):
         self.jid = jid
-        self.domain = generic.prepareIDNName(jid.host)
+        self.domain = jid.host.encode('idna')
         self.host = host
         self.port = port
@@ -183 +183 @@
 
 def clientCreator(factory):
-    domain = generic.prepareIDNName(factory.authenticator.jid.host)
+    domain = factory.authenticator.jid.host.encode('idna')
     c = XMPPClientConnector(reactor, domain, factory)
     c.connect()

wokkel/generic.py

@@ -8 +8 @@
 """
 
-from encodings import idna
-
 from zope.interface import implements
 
 from twisted.internet import defer, protocol
 from twisted.python import reflect
+from twisted.python.deprecate import deprecated
+from twisted.python.versions import Version
 from twisted.words.protocols.jabber import error, jid, xmlstream
 from twisted.words.protocols.jabber.xmlstream import toResponse
@@ -333 +333 @@
 
 
+@deprecated(Version("Wokkel", 0, 8, 0), "unicode.encode('idna')")
 def prepareIDNName(name):
     """
@@ -342 +343 @@
     standard full stop.
     """
-    result = []
-    labels = idna.dots.split(name)
-
-    if labels and len(labels[-1]) == 0:
-        trailing_dot = b'.'
-        del labels[-1]
-    else:
-        trailing_dot = b''
-
-    for label in labels:
-        result.append(idna.ToASCII(label))
-
-    return b'.'.join(result) + trailing_dot
+    return name.encode('idna')

wokkel/server.py

@@ -30 +30 @@
 from twisted.words.xish import domish
 
-from wokkel.generic import DeferredXmlStreamFactory, XmlPipe, prepareIDNName
+from wokkel.generic import DeferredXmlStreamFactory, XmlPipe
 
 NS_DIALBACK = 'jabber:server:dialback'
@@ -469 +469 @@
 
 def initiateS2S(factory):
-    domain = prepareIDNName(factory.authenticator.otherHost)
+    domain = factory.authenticator.otherHost.encode('idna')
     c = XMPPServerConnector(reactor, domain, factory)
     c.connect()

wokkel/test/test_generic.py

@@ -6 +6 @@
 """
 
+import re
+
+from twisted.python import deprecate
+from twisted.python.versions import Version
 from twisted.trial import unittest
+from twisted.trial.util import suppress as SUPPRESS
 from twisted.words.xish import domish
 from twisted.words.protocols.jabber.jid import JID
@@ -277 +282 @@
     """
 
+    suppress = [SUPPRESS(category=DeprecationWarning,
+                         message=re.escape(
+                             deprecate.getDeprecationWarningString(
+                                 generic.prepareIDNName,
+                                 Version("Wokkel", 0, 8, 0),
+                                 replacement="unicode.encode('idna')")))]
+
+
+    def test_deprecated(self):
+        """
+        prepareIDNName is deprecated.
+        """
+        self.callDeprecated((Version("Wokkel", 0, 8, 0),
+                             "unicode.encode('idna')"),
+                            generic.prepareIDNName, (b"example.com"))
+    test_deprecated.suppress = []
+
+
     def test_bytestring(self):
         """