Merge branch 'drnushooz-sqlalchemy-20'

Author: catherinedevlin

NEWS.rst

@@ -170,4 +170,10 @@ Deleted Plugin import left behind in 0.2.2
 
 * Fixed .rst file location in MANIFEST.in 
 * Parse SQL comments in first line
-* Bugfixes for DSN, `--close`, others
+* Bugfixes for DSN, `--close`, others
+
+0.5.0 
+~~~~~
+
+* Use SQLAlchemy 2.0 
+* Drop undocumented support for dict-style access to raw row instances

README.rst

@@ -426,6 +426,7 @@ Credits
 - vkk800 for ``--file``
 - Jens Albrecht for MySQL DatabaseError bugfix
 - meihkv for connection-closing bugfix
+- Abhinav C for SQLAlchemy 2.0 compatibility
 
 .. _Distribute: http://pypi.python.org/pypi/distribute
 .. _Buildout: http://www.buildout.org/

requirements-dev.txt

@@ -1,9 +1,8 @@
-psycopg2
+psycopg2-binary
 pandas
 pytest
 wheel
 twine
 readme-renderer
 black
 isort
-

requirements.txt

@@ -1,6 +1,8 @@
-prettytable==0.7.2
-ipython>=1.0
-sqlalchemy>=0.6.7,<2.0
+prettytable
+ipython
+sqlalchemy>=2.0
 sqlparse
 six
-ipython-genutils>=0.1.0
+ipython-genutils
+traitlets
+matplotlib

setup.py

@@ -8,15 +8,15 @@
 NEWS = open(os.path.join(here, "NEWS.rst"), encoding="utf-8").read()
 
 
-version = "0.4.1"
+version = "0.5.0"
 
 install_requires = [
-    "prettytable<1",
-    "ipython>=1.0",
-    "sqlalchemy>=0.6.7",
+    "prettytable",
+    "ipython",
+    "sqlalchemy>=2.0",
     "sqlparse",
     "six",
-    "ipython-genutils>=0.1.0",
+    "ipython-genutils",
 ]
 
 
@@ -33,7 +33,6 @@
         "Topic :: Database",
         "Topic :: Database :: Front-Ends",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 2",
     ],
     keywords="database ipython postgresql mysql",
     author="Catherine Devlin",

src/sql/column_guesser.py

@@ -6,7 +6,7 @@
 
 
 class Column(list):
-    "Store a column of tabular data; record its name and whether it is numeric"
+    """Store a column of tabular data; record its name and whether it is numeric"""
     is_quantity = True
     name = ""
 
@@ -28,6 +28,9 @@ class ColumnGuesserMixin(object):
     pie: ... y
     """
 
+    def __init__(self):
+        self.keys = None
+
     def _build_columns(self):
         self.columns = [Column() for col in self.keys]
         for row in self:

src/sql/connection.py

@@ -1,5 +1,5 @@
 import os
-import re
+import traceback
 
 import sqlalchemy
 
@@ -45,20 +45,21 @@ def __init__(self, connect_str=None, connect_args={}, creator=None):
                 engine = sqlalchemy.create_engine(
                     connect_str, connect_args=connect_args
                 )
-        except:  # TODO: bare except; but what's an ArgumentError?
+        except Exception as ex:  # TODO: bare except; but what's an ArgumentError?
+            print(traceback.format_exc())
             print(self.tell_format())
             raise
+        self.url = engine.url
         self.dialect = engine.url.get_dialect()
-        self.metadata = sqlalchemy.MetaData(bind=engine)
         self.name = self.assign_name(engine)
-        self.session = engine.connect()
-        self.connections[repr(self.metadata.bind.url)] = self
+        self.internal_connection = engine.connect()
+        self.connections[repr(self.url)] = self
         self.connect_args = connect_args
         Connection.current = self
 
     @classmethod
     def set(cls, descriptor, displaycon, connect_args={}, creator=None):
-        "Sets the current database connection"
+        """Sets the current database connection"""
 
         if descriptor:
             if isinstance(descriptor, Connection):
@@ -94,16 +95,16 @@ def connection_list(cls):
         for key in sorted(cls.connections):
             engine_url = cls.connections[
                 key
-            ].metadata.bind.url  # type: sqlalchemy.engine.url.URL
+            ].url  # type: sqlalchemy.engine.url.URL
             if cls.connections[key] == cls.current:
                 template = " * {}"
             else:
                 template = "   {}"
             result.append(template.format(engine_url.__repr__()))
         return "\n".join(result)
-    
+
     @classmethod
-    def _close(cls, descriptor):
+    def close(cls, descriptor):
         if isinstance(descriptor, Connection):
             conn = descriptor
         else:
@@ -115,8 +116,5 @@ def _close(cls, descriptor):
                 "Could not close connection because it was not found amongst these: %s"
                 % str(cls.connections.keys())
             )
-        cls.connections.pop(str(conn.metadata.bind.url))
-        conn.session.close()
-
-    def close(self):
-        self.__class__._close(self)
+        cls.connections.pop(str(conn.url))
+        conn.internal_connection.close()

src/sql/magic.py

@@ -1,6 +1,6 @@
 import json
 import re
-from string import Formatter
+import traceback
 
 from IPython.core.magic import (
     Magics,
@@ -10,7 +10,6 @@
     needs_local_scope,
 )
 from IPython.core.magic_arguments import argument, magic_arguments, parse_argstring
-from IPython.display import display_javascript
 from sqlalchemy.exc import OperationalError, ProgrammingError, DatabaseError
 
 import sql.connection
@@ -46,7 +45,8 @@ class SqlMagic(Magics, Configurable):
     style = Unicode(
         "DEFAULT",
         config=True,
-        help="Set the table printing style to any of prettytable's defined styles (currently DEFAULT, MSWORD_FRIENDLY, PLAIN_COLUMNS, RANDOM)",
+        help="Set the table printing style to any of prettytable's defined styles "
+             "(currently DEFAULT, MSWORD_FRIENDLY, PLAIN_COLUMNS, RANDOM)",
     )
     short_errors = Bool(
         True,
@@ -72,17 +72,17 @@ class SqlMagic(Magics, Configurable):
         "odbc.ini",
         config=True,
         help="Path to DSN file. "
-        "When the first argument is of the form [section], "
-        "a sqlalchemy connection string is formed from the "
-        "matching section in the DSN file.",
+             "When the first argument is of the form [section], "
+             "a sqlalchemy connection string is formed from the "
+             "matching section in the DSN file.",
     )
     autocommit = Bool(True, config=True, help="Set autocommit mode")
 
     def __init__(self, shell):
         Configurable.__init__(self, config=shell.config)
         Magics.__init__(self, shell=shell)
 
-        # Add ourself to the list of module configurable via %config
+        # Add ourselves to the list of module configurable via %config
         self.shell.configurables.append(self)
 
     @needs_local_scope
@@ -121,7 +121,7 @@ def __init__(self, shell):
         help="specify dictionary of connection arguments to pass to SQL driver",
     )
     @argument("-f", "--file", type=str, help="Run SQL from file at this path")
-    def execute(self, line="", cell="", local_ns={}):
+    def execute(self, line="", cell="", local_ns=None):
         """Runs SQL statement against a database, specified by SQLAlchemy connect string.
 
         If no database connection has been established, first word
@@ -147,15 +147,17 @@ def execute(self, line="", cell="", local_ns={}):
 
         """
         # Parse variables (words wrapped in {}) for %%sql magic (for %sql this is done automatically)
+        if local_ns is None:
+            local_ns = {}
         cell = self.shell.var_expand(cell)
         line = sql.parse.without_sql_comment(parser=self.execute.parser, line=line)
         args = parse_argstring(self.execute, line)
         if args.connections:
             return sql.connection.Connection.connections
         elif args.close:
-            return sql.connection.Connection._close(args.close)
+            return sql.connection.Connection.close(args.close)
 
-        # save globals and locals so they can be referenced in bind vars
+        # save globals and locals, so they can be referenced in bind vars
         user_ns = self.shell.user_ns.copy()
         user_ns.update(local_ns)
 
@@ -173,7 +175,7 @@ def execute(self, line="", cell="", local_ns={}):
 
         if args.connection_arguments:
             try:
-                # check for string deliniators, we need to strip them for json parse
+                # check for string delineators, we need to strip them for json parse
                 raw_args = args.connection_arguments
                 if len(raw_args) > 1:
                     targets = ['"', "'"]
@@ -183,7 +185,7 @@ def execute(self, line="", cell="", local_ns={}):
                         raw_args = raw_args[1:-1]
                 args.connection_arguments = json.loads(raw_args)
             except Exception as e:
-                print(e)
+                print(traceback.format_exc())
                 raise e
         else:
             args.connection_arguments = {}
@@ -197,8 +199,10 @@ def execute(self, line="", cell="", local_ns={}):
                 connect_args=args.connection_arguments,
                 creator=args.creator,
             )
-        except Exception as e:
-            print(e)
+            # Rollback just in case there was an error in previous statement
+            conn.internal_connection.rollback()
+        except Exception:
+            print(traceback.format_exc())
             print(sql.connection.Connection.tell_format())
             return None
 
@@ -220,7 +224,7 @@ def execute(self, line="", cell="", local_ns={}):
                 and self.column_local_vars
             ):
                 # Instead of returning values, set variables directly in the
-                # users namespace. Variable names given by column names
+                # user's namespace. Variable names given by column names
 
                 if self.autopandas:
                     keys = result.keys()
@@ -253,7 +257,8 @@ def execute(self, line="", cell="", local_ns={}):
             if self.short_errors:
                 print(e)
             else:
-                raise
+                print(traceback.format_exc())
+                raise e
 
     legal_sql_identifier = re.compile(r"^[A-Za-z0-9#_$]+")
 
@@ -279,7 +284,7 @@ def _persist_dataframe(self, raw, conn, user_ns, append=False):
         table_name = self.legal_sql_identifier.search(table_name).group(0)
 
         if_exists = "append" if append else "fail"
-        frame.to_sql(table_name, conn.session.engine, if_exists=if_exists)
+        frame.to_sql(table_name, conn.internal_connection.engine, if_exists=if_exists)
         return "Persisted %s" % table_name
 
 

src/sql/parse.py

@@ -1,10 +1,7 @@
 import itertools
-import json
-import re
 import shlex
 from os.path import expandvars
 
-import six
 from six.moves import configparser as CP
 from sqlalchemy.engine.url import URL
 
@@ -13,11 +10,10 @@ def connection_from_dsn_section(section, config):
     parser = CP.ConfigParser()
     parser.read(config.dsn_filename)
     cfg_dict = dict(parser.items(section))
-    return str(URL(**cfg_dict))
+    return URL.create(**cfg_dict)
 
 
 def _connection_string(s, config):
-
     s = expandvars(s)  # for environment variables
     if "@" in s or "://" in s:
         return s