capitalized comments

Author: dmalan

src/cs50/sql.py

@@ -22,11 +22,11 @@ def __init__(self, url, **kwargs):
         http://docs.sqlalchemy.org/en/latest/dialects/index.html
         """
 
-        # log statements to standard error
+        # Log statements to standard error
         logging.basicConfig(level=logging.DEBUG)
         self.logger = logging.getLogger("cs50")
 
-        # create engine, raising exception if back end's module not installed
+        # Create engine, raising exception if back end's module not installed
         self.engine = sqlalchemy.create_engine(url, **kwargs)
 
     def execute(self, text, **params):
@@ -81,54 +81,54 @@ def process(value):
                     elif isinstance(value, sqlalchemy.sql.elements.Null):
                         return sqlalchemy.types.NullType().literal_processor(dialect)(value)
 
-                    # unsupported value
+                    # Unsupported value
                     raise RuntimeError("unsupported value")
 
-                # process value(s), separating with commas as needed
+                # Process value(s), separating with commas as needed
                 if type(value) is list:
                     return ", ".join([process(v) for v in value])
                 else:
                     return process(value)
 
-        # allow only one statement at a time
+        # Allow only one statement at a time
         if len(sqlparse.split(text)) > 1:
             raise RuntimeError("too many statements at once")
 
-        # raise exceptions for warnings
+        # Raise exceptions for warnings
         warnings.filterwarnings("error")
 
-        # prepare, execute statement
+        # Prepare, execute statement
         try:
 
-            # construct a new TextClause clause
+            # Construct a new TextClause clause
             statement = sqlalchemy.text(text)
 
-            # iterate over parameters
+            # Iterate over parameters
             for key, value in params.items():
 
-                # translate None to NULL
+                # Translate None to NULL
                 if value is None:
                     value = sqlalchemy.sql.null()
 
-                # bind parameters before statement reaches database, so that bound parameters appear in exceptions
+                # Bind parameters before statement reaches database, so that bound parameters appear in exceptions
                 # http://docs.sqlalchemy.org/en/latest/core/sqlelement.html#sqlalchemy.sql.expression.text
                 statement = statement.bindparams(sqlalchemy.bindparam(
                     key, value=value, type_=UserDefinedType()))
 
-            # stringify bound parameters
+            # Stringify bound parameters
             # http://docs.sqlalchemy.org/en/latest/faq/sqlexpressions.html#how-do-i-render-sql-expressions-as-strings-possibly-with-bound-parameters-inlined
             statement = str(statement.compile(compile_kwargs={"literal_binds": True}))
 
-            # execute statement
+            # Execute statement
             result = self.engine.execute(statement)
 
-            # log statement
+            # Log statement
             self.logger.debug(re.sub(r"\n\s*", " ", sqlparse.format(statement, reindent=True)))
 
-            # if SELECT (or INSERT with RETURNING), return result set as list of dict objects
+            # If SELECT (or INSERT with RETURNING), return result set as list of dict objects
             if re.search(r"^\s*SELECT", statement, re.I):
 
-                # coerce any decimal.Decimal objects to float objects
+                # Coerce any decimal.Decimal objects to float objects
                 # https://groups.google.com/d/msg/sqlalchemy/0qXMYJvq8SA/oqtvMD9Uw-kJ
                 rows = [dict(row) for row in result.fetchall()]
                 for row in rows:
@@ -137,21 +137,21 @@ def process(value):
                             row[column] = float(row[column])
                 return rows
 
-            # if INSERT, return primary key value for a newly inserted row
+            # If INSERT, return primary key value for a newly inserted row
             elif re.search(r"^\s*INSERT", statement, re.I):
                 if self.engine.url.get_backend_name() in ["postgres", "postgresql"]:
                     result = self.engine.execute(sqlalchemy.text("SELECT LASTVAL()"))
                     return result.first()[0]
                 else:
                     return result.lastrowid
 
-            # if DELETE or UPDATE, return number of rows matched
+            # If DELETE or UPDATE, return number of rows matched
             elif re.search(r"^\s*(?:DELETE|UPDATE)", statement, re.I):
                 return result.rowcount
 
-            # if some other statement, return True unless exception
+            # If some other statement, return True unless exception
             return True
 
-        # if constraint violated, return None
+        # If constraint violated, return None
         except sqlalchemy.exc.IntegrityError:
             return None