Improved docstrings and reordered method declarations

Author: sfneal

mysql/toolkit/components/advanced.py

@@ -7,16 +7,40 @@ class Advanced:
     def __init__(self):
         pass
 
-    def truncate_database(self):
-        """Drop all tables in a database."""
-        # Get list of tables
-        tables = self.tables if isinstance(self.tables, list) else [self.tables]
-        if len(tables) > 0:
-            # Join list of tables into comma separated string
-            tables_str = ', '.join([wrap(table) for table in tables])
-            self.execute('DROP TABLE ' + tables_str)
-            self._printer('\t' + str(len(tables)), 'tables truncated')
-        return tables
+    # def create_table(self, table, data, headers=None):
+    #     """Generate and execute a create table query by parsing a 2D dataset"""
+    #     # TODO: Fix
+    #     # Set headers list
+    #     if not headers:
+    #         headers = data[0]
+    #
+    #     # Create dictionary columns and data types from headers list
+    #     data_types = {header: None for header in headers}
+    #
+    #     # Confirm that each row of the dataset is the same length
+    #     for row in data:
+    #         assert len(row) == len(headers)
+    #
+    #     # Create list of columns
+    #     columns = [header + ' ' + data_type for header, data_type in data_types]
+    #     self._printer(columns)
+    #     statement = "create table " + table + " ("
+    #     self._printer(statement)
+
+    def drop_empty_tables(self):
+        """Drop all empty tables in a database."""
+        # Count number of rows in each table
+        counts = self.count_rows_all()
+        drops = []
+
+        # Loop through each table key and validate that rows count is not 0
+        for table, count in counts.items():
+            if count < 1:
+                # Drop table if it contains no rows
+                self.drop(table)
+                self._printer('Dropped table', table)
+                drops.append(table)
+        return drops
 
     def insert_uniques(self, table, columns, values):
         """
@@ -62,40 +86,16 @@ def update_many(self, table, columns, values, where_col, where_index):
         for row in values:
             self.update(table, columns, row, (where_col, row[where_index]))
 
-    # def create_table(self, table, data, headers=None):
-    #     """Generate and execute a create table query by parsing a 2D dataset"""
-    #     # TODO: Fix
-    #     # Set headers list
-    #     if not headers:
-    #         headers = data[0]
-    #
-    #     # Create dictionary columns and data types from headers list
-    #     data_types = {header: None for header in headers}
-    #
-    #     # Confirm that each row of the dataset is the same length
-    #     for row in data:
-    #         assert len(row) == len(headers)
-    #
-    #     # Create list of columns
-    #     columns = [header + ' ' + data_type for header, data_type in data_types]
-    #     self._printer(columns)
-    #     statement = "create table " + table + " ("
-    #     self._printer(statement)
-
-    def drop_empty_tables(self):
-        """Drop all empty tables in a database."""
-        # Count number of rows in each table
-        counts = self.count_rows_all()
-        drops = []
-
-        # Loop through each table key and validate that rows count is not 0
-        for table, count in counts.items():
-            if count < 1:
-                # Drop table if it contains no rows
-                self.drop(table)
-                self._printer('Dropped table', table)
-                drops.append(table)
-        return drops
+    def truncate_database(self):
+        """Drop all tables in a database."""
+        # Get list of tables
+        tables = self.tables if isinstance(self.tables, list) else [self.tables]
+        if len(tables) > 0:
+            # Join list of tables into comma separated string
+            tables_str = ', '.join([wrap(table) for table in tables])
+            self.execute('DROP TABLE ' + tables_str)
+            self._printer('\t' + str(len(tables)), 'tables truncated')
+        return tables
 
     def execute_script(self, sql_script, commands=None):
         """Wrapper method for ExecuteScript class."""

mysql/toolkit/components/core.py

@@ -6,7 +6,7 @@ def __init__(self):
         pass
 
     def select(self, table, cols, _print=True):
-        """Query only certain columns from a table and every row."""
+        """Query every row and only certain columns from a table."""
         # Concatenate statement
         cols_str = join_cols(cols)
         statement = "SELECT " + cols_str + " FROM " + wrap(table)
@@ -38,7 +38,7 @@ def select_where(self, table, cols, where):
         self._fetch(statement)
 
     def insert(self, table, columns, values):
-        """Insert a singular row into a table"""
+        """Insert a single row into a table."""
         # Concatenate statement
         cols, vals = get_col_val_str(columns)
         statement = "INSERT INTO " + wrap(table) + "(" + cols + ") " + "VALUES (" + vals + ")"
@@ -93,7 +93,7 @@ def truncate(self, table):
         self.execute(statement)
         self._printer('\tMySQL table ' + str(table) + ' successfully truncated')
 
-    def drop_table(self, table):
+    def drop(self, table):
         """Drop a table from a database."""
         self.execute('DROP TABLE ' + wrap(table))
         return table

mysql/toolkit/components/results.py

@@ -29,18 +29,10 @@ def get_primary_key(self, table):
             if 'pri' in column[3].lower():
                 return column[0]
 
-    def get_primary_key_values(self, table):
+    def get_primary_key_vals(self, table):
         """Retrieve a list of primary key values in a table"""
         return self.select(table, self.get_primary_key(table), _print=False)
 
-    def count_rows(self, table):
-        """Get the number of rows in a particular table"""
-        return self.select(table, 'COUNT(*)', False)
-
-    def count_rows_all(self):
-        """Get the number of rows for every table in the database."""
-        return {table: self.count_rows(table) for table in self.tables}
-
     def get_schema(self, table, with_headers=False):
         """Retrieve the database schema for a particular table."""
         f = self._fetch('desc ' + wrap(table))
@@ -49,3 +41,11 @@ def get_schema(self, table, with_headers=False):
         if with_headers:
             f.insert(0, ['Column', 'Type', 'Null', 'Key', 'Default', 'Extra'])
         return f
+
+    def count_rows(self, table):
+        """Get the number of rows in a particular table"""
+        return self.select(table, 'COUNT(*)', False)
+
+    def count_rows_all(self):
+        """Get the number of rows for every table in the database."""
+        return {table: self.count_rows(table) for table in self.tables}