Changes between Version 52 and Version 53 of DeveloperGuidelines/Py_2_3

Timestamp:

07/05/19 22:57:25 (6 years ago)

Author:

Dominic König

Comment:

--

DeveloperGuidelines/Py_2_3

@@ -132 +132 @@
 The following objects are provided by s3compat:
 
+==== Constants ====
+
 ||= '''Name''' =||= '''Type''' =||= '''!Comments/Caveats''' =||
 ||PY2||boolean||Constant indicating whether we're currently running on Py2, should only be used if alternatives cannot be generalized||
-||StringIO||class|| ||
+
+==== Modules ====
+
+||= '''Name''' =||= '''Type''' =||= '''!Comments/Caveats''' =||
+||Cookie||module||maps to http.cookies in Py3||
 ||pickle||module||replaces cPickle in Py2||
-||Cookie||module||maps to http.cookies in Py3||
-||reduce||function|| ||
-||basestring||type|| ||
-||unichr||function|| ||
-||unicodeT||type||for type checking, instead of {{{unicode}}} in Py2, maps to {{{str}}} in Py3||
-||STRING_TYPES||tuple||maps to tuple of all known string types: (str,unicode) in Py2, (str,) in Py3, for type checking||
-||sorted_locale||lambda i||locale-sensitive sorting, {{{sorted(i, cmp=locale.strcoll)}}} in Py2, {{{sorted(i, key=locale.strxfrm)}}} in Py3||
-||long||type||same as {{{int}}} in Py3, so can occasionally lead to redundancy||
-||INTEGER_TYPES||tuple||maps to tuple of all known integer types: (int,long) in Py2, (int,) in Py3, for use with {{{isinstance}}}||
-||!ClassType||type||replaces {{{types.ClassType}}} (old-style classes) in Py2, maps to {{{type}}} in Py3 (old-style classes do no longer exist)||
-||CLASS_TYPES||tuple||maps to tuple of all known class types: {{{(type,types.ClassType)}}} in Py2, just (types,) in Py3, for use with {{{isinstance}}}||
-||xrange||function||maps to {{{range}}} in Py3, since {{{xrange}}} does no longer exist (but {{{range}}} behaves like it)||
 ||urlparse||module||maps to urllib.parse in Py3||
 ||urllib2||module||maps to urllib.requests in Py3, which contains only part of Py2's urllib2 - some urllib2 objects therefore need to be imported separately (see below)||
-||HTTPError||Exception||replaces urllib2.HTTPError in Py2, '''NB''' HTTPError is a subclass of URLError, so must be caught first in order to differentiate||
-||URLError||Exception||replaces urllib2.URLError in Py2||
-||urlopen||function||replaces urllib.urlopen and urllib2.urlopen in Py2||
+
+==== Functions ====
+
+||= '''Name''' =||= '''Type''' =||= '''!Comments/Caveats''' =||
+||reduce||function|| ||
+||sorted_locale||lambda i||locale-sensitive sorting, {{{sorted(i, cmp=locale.strcoll)}}} in Py2, {{{sorted(i, key=locale.strxfrm)}}} in Py3||
+||unichr||function|| ||
 ||urlencode||function||replaces urllib.urlencode in Py2||
 ||urllib_quote||function||replaces urllib.quote in Py2||
+||urlopen||function||replaces urllib.urlopen and urllib2.urlopen in Py2||
+||xrange||function||maps to {{{range}}} in Py3, since {{{xrange}}} does no longer exist (but {{{range}}} behaves like it)||
+
+==== Types ====
+
+||= '''Name''' =||= '''Type''' =||= '''!Comments/Caveats''' =||
+||basestring||type|| ||
+||long||type||same as {{{int}}} in Py3, so can occasionally lead to redundancy||
+||unicodeT||type||for type checking, instead of {{{unicode}}} in Py2, maps to {{{str}}} in Py3||
+||!ClassType||type||replaces {{{types.ClassType}}} (old-style classes) in Py2, maps to {{{type}}} in Py3 (old-style classes do no longer exist)||
+
+==== Type Tuples for isinstance() ====
+
+||= '''Name''' =||= '''Type''' =||= '''!Comments/Caveats''' =||
+||CLASS_TYPES||tuple||maps to tuple of all known class types: {{{(type,types.ClassType)}}} in Py2, just (type,) in Py3||
+||INTEGER_TYPES||tuple||maps to tuple of all known integer types: (int,long) in Py2, (int,) in Py3||
+||STRING_TYPES||tuple||maps to tuple of all known string types: (str,unicode) in Py2, (str,) in Py3||
+
+==== Other Classes and Exceptions ====
+
+||= '''Name''' =||= '''Type''' =||= '''!Comments/Caveats''' =||
+||HTTPError||Exception||replaces urllib2.HTTPError in Py2, '''NB''' HTTPError is a subclass of URLError, so must be caught first in order to differentiate||
 ||HTMLParser||class||replaces HTMLParser.HTMLParser in Py2||
+||StringIO||class|| ||
+||URLError||Exception||replaces urllib2.URLError in Py2||
 === No dict.iteritems, iterkeys or itervalues ===