Skip to content

Commit eec7cd3

Browse files
committed
Change all internal use of to_unicode() to __unicode__() and marked former one as deprecated.
1 parent a911e95 commit eec7cd3

File tree

5 files changed

+27
-24
lines changed

5 files changed

+27
-24
lines changed

extras/py3k/setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def find_packages(base):
5555
>>> res
5656
(<Statement 'select...' at 0x9ad08ec>,)
5757
>>> stmt = res[0]
58-
>>> stmt.to_unicode() # converting it back to unicode
58+
>>> unicode(stmt) # converting it back to unicode
5959
u'select * from someschema.mytable where id = 1'
6060
>>> # This is how the internal representation looks like:
6161
>>> stmt.tokens
@@ -87,7 +87,7 @@ def find_packages(base):
8787
long_description=LONG_DESCRIPTION,
8888
license='BSD',
8989
url='http://python-sqlparse.googlecode.com/',
90-
classifiers = [
90+
classifiers=[
9191
'Development Status :: 4 - Beta',
9292
'Intended Audience :: Developers',
9393
'License :: OSI Approved :: BSD License',

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def find_packages(base):
5555
>>> res
5656
(<Statement 'select...' at 0x9ad08ec>,)
5757
>>> stmt = res[0]
58-
>>> stmt.to_unicode() # converting it back to unicode
58+
>>> unicode(stmt) # converting it back to unicode
5959
u'select * from someschema.mytable where id = 1'
6060
>>> # This is how the internal representation looks like:
6161
>>> stmt.tokens
@@ -87,7 +87,7 @@ def find_packages(base):
8787
long_description=LONG_DESCRIPTION,
8888
license='BSD',
8989
url='http://python-sqlparse.googlecode.com/',
90-
classifiers = [
90+
classifiers=[
9191
'Development Status :: 4 - Beta',
9292
'Intended Audience :: Developers',
9393
'License :: OSI Approved :: BSD License',

sqlparse/filters.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ def process(self, stack, stmt):
350350
self._process(stmt)
351351
if isinstance(stmt, sql.Statement):
352352
if self._last_stmt is not None:
353-
if self._last_stmt.to_unicode().endswith('\n'):
353+
if unicode(self._last_stmt).endswith('\n'):
354354
nl = '\n'
355355
else:
356356
nl = '\n\n'
@@ -382,7 +382,7 @@ def _process(self, stack, group, stream):
382382
and not token.__class__ in self.keep_together):
383383
token.tokens = self._process(stack, token, token.tokens)
384384
else:
385-
val = token.to_unicode()
385+
val = unicode(token)
386386
if len(self.line) + len(val) > self.width:
387387
match = re.search('^ +', self.line)
388388
if match is not None:
@@ -456,7 +456,7 @@ def process(self, stack, stream):
456456
class SerializerUnicode(Filter):
457457

458458
def process(self, stack, stmt):
459-
raw = stmt.to_unicode()
459+
raw = unicode(stmt)
460460
add_nl = raw.endswith('\n')
461461
res = '\n'.join(line.rstrip() for line in raw.splitlines())
462462
if add_nl:
@@ -516,7 +516,7 @@ def process(self, stack, stmt):
516516
varname = '%s%d' % (self.varname, self.cnt)
517517
else:
518518
varname = self.varname
519-
has_nl = len(stmt.to_unicode().strip().splitlines()) > 1
519+
has_nl = len(unicode(stmt).strip().splitlines()) > 1
520520
stmt.tokens = self._process(stmt.tokens, varname, self.cnt, has_nl)
521521
return stmt
522522

sqlparse/sql.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,14 @@ def __repr__(self):
3131
short, id(self))
3232

3333
def __unicode__(self):
34+
"""Returns a unicode representation of this object."""
3435
return self.value or ''
3536

3637
def to_unicode(self):
37-
"""Returns a unicode representation of this object."""
38+
"""Returns a unicode representation of this object.
39+
40+
@deprecated: please use __unicode__()
41+
"""
3842
return unicode(self)
3943

4044
def _get_repr_name(self):
@@ -333,8 +337,7 @@ def get_alias(self):
333337
alias = next_
334338
if isinstance(alias, Identifier):
335339
return alias.get_name()
336-
else:
337-
return alias.to_unicode()
340+
return unicode(alias)
338341

339342
def get_name(self):
340343
"""Returns the name of this identifier.
@@ -420,7 +423,7 @@ def get_typecast(self):
420423
next_ = self.token_next(self.token_index(marker), False)
421424
if next_ is None:
422425
return None
423-
return next_.to_unicode()
426+
return unicode(next_)
424427

425428

426429
class IdentifierList(TokenList):

tests/test_grouping.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
class TestGrouping(TestCaseBase):
1111

1212
def test_parenthesis(self):
13-
s ='select (select (x3) x2) and (y2) bar'
13+
s = 'select (select (x3) x2) and (y2) bar'
1414
parsed = sqlparse.parse(s)[0]
1515
self.ndiffAssertEqual(s, str(parsed))
1616
self.assertEqual(len(parsed.tokens), 9)
@@ -39,18 +39,18 @@ def test_assignment(self):
3939
def test_identifiers(self):
4040
s = 'select foo.bar from "myscheme"."table" where fail. order'
4141
parsed = sqlparse.parse(s)[0]
42-
self.ndiffAssertEqual(s, parsed.to_unicode())
42+
self.ndiffAssertEqual(s, unicode(parsed))
4343
self.assert_(isinstance(parsed.tokens[2], sql.Identifier))
4444
self.assert_(isinstance(parsed.tokens[6], sql.Identifier))
4545
self.assert_(isinstance(parsed.tokens[8], sql.Where))
4646
s = 'select * from foo where foo.id = 1'
4747
parsed = sqlparse.parse(s)[0]
48-
self.ndiffAssertEqual(s, parsed.to_unicode())
48+
self.ndiffAssertEqual(s, unicode(parsed))
4949
self.assert_(isinstance(parsed.tokens[-1].tokens[-1].tokens[0],
5050
sql.Identifier))
5151
s = 'select * from (select "foo"."id" from foo)'
5252
parsed = sqlparse.parse(s)[0]
53-
self.ndiffAssertEqual(s, parsed.to_unicode())
53+
self.ndiffAssertEqual(s, unicode(parsed))
5454
self.assert_(isinstance(parsed.tokens[-1].tokens[3], sql.Identifier))
5555

5656
def test_identifier_wildcard(self):
@@ -117,44 +117,44 @@ def test_identifier_list_other(self): # issue2
117117
def test_where(self):
118118
s = 'select * from foo where bar = 1 order by id desc'
119119
p = sqlparse.parse(s)[0]
120-
self.ndiffAssertEqual(s, p.to_unicode())
120+
self.ndiffAssertEqual(s, unicode(p))
121121
self.assertTrue(len(p.tokens), 16)
122122
s = 'select x from (select y from foo where bar = 1) z'
123123
p = sqlparse.parse(s)[0]
124-
self.ndiffAssertEqual(s, p.to_unicode())
124+
self.ndiffAssertEqual(s, unicode(p))
125125
self.assertTrue(isinstance(p.tokens[-3].tokens[-2], sql.Where))
126126

127127
def test_typecast(self):
128128
s = 'select foo::integer from bar'
129129
p = sqlparse.parse(s)[0]
130-
self.ndiffAssertEqual(s, p.to_unicode())
130+
self.ndiffAssertEqual(s, unicode(p))
131131
self.assertEqual(p.tokens[2].get_typecast(), 'integer')
132132
self.assertEqual(p.tokens[2].get_name(), 'foo')
133133
s = 'select (current_database())::information_schema.sql_identifier'
134134
p = sqlparse.parse(s)[0]
135-
self.ndiffAssertEqual(s, p.to_unicode())
135+
self.ndiffAssertEqual(s, unicode(p))
136136
self.assertEqual(p.tokens[2].get_typecast(),
137137
'information_schema.sql_identifier')
138138

139139
def test_alias(self):
140140
s = 'select foo as bar from mytable'
141141
p = sqlparse.parse(s)[0]
142-
self.ndiffAssertEqual(s, p.to_unicode())
142+
self.ndiffAssertEqual(s, unicode(p))
143143
self.assertEqual(p.tokens[2].get_real_name(), 'foo')
144144
self.assertEqual(p.tokens[2].get_alias(), 'bar')
145145
s = 'select foo from mytable t1'
146146
p = sqlparse.parse(s)[0]
147-
self.ndiffAssertEqual(s, p.to_unicode())
147+
self.ndiffAssertEqual(s, unicode(p))
148148
self.assertEqual(p.tokens[6].get_real_name(), 'mytable')
149149
self.assertEqual(p.tokens[6].get_alias(), 't1')
150150
s = 'select foo::integer as bar from mytable'
151151
p = sqlparse.parse(s)[0]
152-
self.ndiffAssertEqual(s, p.to_unicode())
152+
self.ndiffAssertEqual(s, unicode(p))
153153
self.assertEqual(p.tokens[2].get_alias(), 'bar')
154154
s = ('SELECT DISTINCT '
155155
'(current_database())::information_schema.sql_identifier AS view')
156156
p = sqlparse.parse(s)[0]
157-
self.ndiffAssertEqual(s, p.to_unicode())
157+
self.ndiffAssertEqual(s, unicode(p))
158158
self.assertEqual(p.tokens[4].get_alias(), 'view')
159159

160160
def test_alias_case(self): # see issue46

0 commit comments

Comments
 (0)