Merge branch 'master' into jstoebel-iss91

Author: catherinedevlin

NEWS.txt

@@ -148,3 +148,4 @@ Deleted Plugin import left behind in 0.2.2
 * `<<` operator (thanks xiaochuanyu)
 * added README example (thanks tanhuil)
 * bugfix in executing column_local_vars (thanks tebeka)
+* pgspecial installation optional (thanks jstoebel and arjoe)

README.rst

@@ -64,7 +64,7 @@ an existing connection by username@database
     ======================
     Poet       733
 
-If no connect string is supplied, ``5sql`` will provide a list of existing connections;
+If no connect string is supplied, ``%sql`` will provide a list of existing connections;
 however, if no connections have yet been made and the environment variable ``DATABASE_URL``
 is available, that will be used.
 
@@ -265,7 +265,11 @@ PostgreSQL features
 -------------------
 
 ``psql``-style "backslash" `meta-commands`_ commands (``\d``, ``\dt``, etc.)
-are provided by `PGSpecial`_.
+are provided by `PGSpecial`_.  Example:
+
+.. code-block:: python
+
+    In[9]: %sql \d
 
 .. _PGSpecial: https://pypi.python.org/pypi/pgspecial
 

run_tests.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
-ipython -c "import nose; nose.run()"
-# Insert breakpoints with `from nose.tools import set_trace; set_trace()`
+python -c "import pytest; pytest.main(['.', '-x', '--pdb'])"
+# Insert breakpoints with `import pytest; pytest.set_trace()`

setup.py

@@ -2,8 +2,8 @@
 import os
 
 here = os.path.abspath(os.path.dirname(__file__))
-README = open(os.path.join(here, 'README.rst')).read()
-NEWS = open(os.path.join(here, 'NEWS.txt')).read()
+README = open(os.path.join(here, 'README.rst'), encoding='utf-8').read()
+NEWS = open(os.path.join(here, 'NEWS.txt'), encoding='utf-8').read()
 
 
 version = '0.3.9'
@@ -14,7 +14,6 @@
     'sqlalchemy>=0.6.7',
     'sqlparse',
     'six',
-    'pgspecial',
     'ipython-genutils>=0.1.0',
 ]
 

src/sql/run.py

@@ -1,15 +1,21 @@
-import operator
-import csv
-import six
 import codecs
+import csv
+import operator
 import os.path
 import re
+
+import prettytable
+import six
 import sqlalchemy
 import sqlparse
-import prettytable
-from pgspecial.main import PGSpecial
+
 from .column_guesser import ColumnGuesserMixin
 
+try:
+    from pgspecial.main import PGSpecial
+except ImportError:
+    PGSpecial = None
+
 
 def unduplicate_field_names(field_names):
     """Append a number to duplicate field names to make them unique. """
@@ -23,6 +29,7 @@ def unduplicate_field_names(field_names):
         res.append(k)
     return res
 
+
 class UnicodeWriter(object):
     """
     A CSV writer which will write rows to CSV file "f",
@@ -38,19 +45,17 @@ def __init__(self, f, dialect=csv.excel, encoding="utf-8", **kwds):
 
     def writerow(self, row):
         if six.PY2:
-            _row = [s.encode("utf-8")
-                    if hasattr(s, "encode")
-                    else s
+            _row = [s.encode("utf-8") if hasattr(s, "encode") else s
                     for s in row]
         else:
             _row = row
         self.writer.writerow(_row)
         # Fetch UTF-8 output from the queue ...
         data = self.queue.getvalue()
         if six.PY2:
-           data = data.decode("utf-8")
-           # ... and reencode it into the target encoding
-           data = self.encoder.encode(data)
+            data = data.decode("utf-8")
+            # ... and reencode it into the target encoding
+            data = self.encoder.encode(data)
         # write to the target stream
         self.stream.write(data)
         # empty queue
@@ -61,14 +66,20 @@ def writerows(self, rows):
         for row in rows:
             self.writerow(row)
 
+
 class CsvResultDescriptor(object):
     """Provides IPython Notebook-friendly output for the feedback after a ``.csv`` called."""
+
     def __init__(self, file_path):
         self.file_path = file_path
+
     def __repr__(self):
-        return 'CSV results at %s' % os.path.join(os.path.abspath('.'), self.file_path)
+        return 'CSV results at %s' % os.path.join(
+            os.path.abspath('.'), self.file_path)
+
     def _repr_html_(self):
-        return '<a href="%s">CSV results</a>' % os.path.join('.', 'files', self.file_path)
+        return '<a href="%s">CSV results</a>' % os.path.join('.', 'files',
+                                                             self.file_path)
 
 
 def _nonbreaking_spaces(match_obj):
@@ -81,6 +92,7 @@ def _nonbreaking_spaces(match_obj):
     spaces = '&nbsp;' * len(match_obj.group(2))
     return '%s%s' % (match_obj.group(1), spaces)
 
+
 _cell_with_spaces_pattern = re.compile(r'(<td>)( {2,})')
 
 
@@ -90,6 +102,7 @@ class ResultSet(list, ColumnGuesserMixin):
 
     Can access rows listwise, or by string value of leftmost column.
     """
+
     def __init__(self, sqlaproxy, sql, config):
         self.keys = sqlaproxy.keys()
         self.sql = sql
@@ -115,7 +128,8 @@ def _repr_html_(self):
             self.pretty.add_rows(self)
             result = self.pretty.get_html_string()
             result = _cell_with_spaces_pattern.sub(_nonbreaking_spaces, result)
-            if self.config.displaylimit and len(self) > self.config.displaylimit:
+            if self.config.displaylimit and len(
+                    self) > self.config.displaylimit:
                 result = '%s\n<span style="font-style:italic;text-align:center;">%d rows, truncated to displaylimit of %d</span>' % (
                     result, len(self), self.config.displaylimit)
             return result
@@ -140,6 +154,7 @@ def __getitem__(self, key):
             if len(result) > 1:
                 raise KeyError('%d results for "%s"' % (len(result), key))
             return result[0]
+
     def dict(self):
         """Returns a single dict built from the result set
 
@@ -214,7 +229,7 @@ def plot(self, title=None, **kwargs):
         plt.ylabel(ylabel)
         return plot
 
-    def bar(self, key_word_sep = " ", title=None, **kwargs):
+    def bar(self, key_word_sep=" ", title=None, **kwargs):
         """Generates a pylab bar plot from the result set.
 
         ``matplotlib`` must be installed, and in an
@@ -238,8 +253,7 @@ def bar(self, key_word_sep = " ", title=None, **kwargs):
         self.guess_pie_columns(xlabel_sep=key_word_sep)
         plot = plt.bar(range(len(self.ys[0])), self.ys[0], **kwargs)
         if self.xlabels:
-            plt.xticks(range(len(self.xlabels)), self.xlabels,
-                       rotation=45)
+            plt.xticks(range(len(self.xlabels)), self.xlabels, rotation=45)
         plt.xlabel(self.xlabel)
         plt.ylabel(self.ys[0].name)
         return plot
@@ -248,7 +262,7 @@ def csv(self, filename=None, **format_params):
         """Generate results in comma-separated form.  Write to ``filename`` if given.
            Any other parameters will be passed on to csv.writer."""
         if not self.pretty:
-            return None # no results
+            return None  # no results
         self.pretty.add_rows(self)
         if filename:
             encoding = format_params.get('encoding', 'utf-8')
@@ -276,17 +290,37 @@ def interpret_rowcount(rowcount):
         result = '%d rows affected.' % rowcount
     return result
 
+
 class FakeResultProxy(object):
     """A fake class that pretends to behave like the ResultProxy from
     SqlAlchemy.
     """
+
     def __init__(self, cursor, headers):
         self.fetchall = cursor.fetchall
         self.fetchmany = cursor.fetchmany
         self.rowcount = cursor.rowcount
         self.keys = lambda: headers
         self.returns_rows = True
 
+# some dialects have autocommit
+# specific dialects break when commit is used:
+_COMMIT_BLACKLIST_DIALECTS = ('mssql', 'clickhouse')
+
+
+def _commit(conn, config):
+    """Issues a commit, if appropriate for current config and dialect"""
+
+    _should_commit = config.autocommit and all(
+        dialect not in str(conn.dialect)
+        for dialect in _COMMIT_BLACKLIST_DIALECTS)
+
+    if _should_commit:
+        try:
+            conn.session.execute('commit')
+        except sqlalchemy.exc.OperationalError:
+            pass  # not all engines can commit
+
 
 def run(conn, sql, config, user_namespace):
     if sql.strip():
@@ -295,20 +329,16 @@ def run(conn, sql, config, user_namespace):
             if first_word == 'begin':
                 raise Exception("ipython_sql does not support transactions")
             if first_word.startswith('\\') and 'postgres' in str(conn.dialect):
+                if not PGSpecial:
+                    raise ImportError('pgspecial not installed')
                 pgspecial = PGSpecial()
                 _, cur, headers, _ = pgspecial.execute(
-                                              conn.session.connection.cursor(),
-                                              statement)[0]
+                    conn.session.connection.cursor(), statement)[0]
                 result = FakeResultProxy(cur, headers)
             else:
                 txt = sqlalchemy.sql.text(statement)
                 result = conn.session.execute(txt, user_namespace)
-            try:
-                # mssql has autocommit
-                if config.autocommit and ('mssql' not in str(conn.dialect)):
-                    conn.session.execute('commit')
-            except sqlalchemy.exc.OperationalError:
-                pass # not all engines can commit
+            _commit(conn=conn, config=config)
             if result and config.feedback:
                 print(interpret_rowcount(result.rowcount))
         resultset = ResultSet(result, statement, config)
@@ -322,11 +352,10 @@ def run(conn, sql, config, user_namespace):
 
 
 class PrettyTable(prettytable.PrettyTable):
-
     def __init__(self, *args, **kwargs):
         self.row_count = 0
         self.displaylimit = None
-        return super(PrettyTable, self).__init__(*args,  **kwargs)
+        return super(PrettyTable, self).__init__(*args, **kwargs)
 
     def add_rows(self, data):
         if self.row_count and (data.config.displaylimit == self.displaylimit):