Ruff format. (#1507)

Author: j-bennet

.pre-commit-config.yaml

@@ -6,5 +6,5 @@ repos:
     # Run the linter.
     - id: ruff
       args: [ --fix ]
-    # Run the formatter. TODO: uncomment when the rest of the code is ruff-formatted
-    # - id: ruff-format
+    # Run the formatter.
+    - id: ruff-format

README.rst

@@ -158,6 +158,7 @@ get this running in a development setup.
 https://github.com/dbcli/pgcli/blob/main/CONTRIBUTING.rst
 
 Please feel free to reach out to us if you need help.
+
 * Amjith, pgcli author: [email protected], Twitter: `@amjithr <http://twitter.com/amjithr>`_
 * Irina, pgcli maintainer: [email protected], Twitter: `@irinatruong <http://twitter.com/irinatruong>`_
 

pgcli/auth.py

@@ -26,9 +26,7 @@ def keyring_initialize(keyring_enabled, *, logger):
 
         try:
             keyring = importlib.import_module("keyring")
-        except (
-            ModuleNotFoundError
-        ) as e:  # ImportError for Python 2, ModuleNotFoundError for Python 3
+        except ModuleNotFoundError as e:  # ImportError for Python 2, ModuleNotFoundError for Python 3
             logger.warning("import keyring failed: %r.", e)
 
 
@@ -40,9 +38,7 @@ def keyring_get_password(key):
         passwd = keyring.get_password("pgcli", key) or ""
     except Exception as e:
         click.secho(
-            keyring_error_message.format(
-                "Load your password from keyring returned:", str(e)
-            ),
+            keyring_error_message.format("Load your password from keyring returned:", str(e)),
             err=True,
             fg="red",
         )

pgcli/completion_refresher.py

@@ -40,18 +40,14 @@ def refresh(self, executor, special, callbacks, history=None, settings=None):
             )
             self._completer_thread.daemon = True
             self._completer_thread.start()
-            return [
-                (None, None, None, "Auto-completion refresh started in the background.")
-            ]
+            return [(None, None, None, "Auto-completion refresh started in the background.")]
 
     def is_refreshing(self):
         return self._completer_thread and self._completer_thread.is_alive()
 
     def _bg_refresh(self, pgexecute, special, callbacks, history=None, settings=None):
         settings = settings or {}
-        completer = PGCompleter(
-            smart_completion=True, pgspecial=special, settings=settings
-        )
+        completer = PGCompleter(smart_completion=True, pgspecial=special, settings=settings)
 
         if settings.get("single_connection"):
             executor = pgexecute

pgcli/key_bindings.py

@@ -107,8 +107,7 @@ def _(event):
     # history search, and one of several conditions are True
     @kb.add(
         "enter",
-        filter=~(completion_is_selected | is_searching)
-        & buffer_should_be_handled(pgcli),
+        filter=~(completion_is_selected | is_searching) & buffer_should_be_handled(pgcli),
     )
     def _(event):
         _logger.debug("Detected enter key.")

pgcli/packages/formatter/sqlformatter.py

@@ -52,23 +52,16 @@ def adapter(data, headers, table_format=None, **kwargs):
             yield 'UPDATE "{}" SET'.format(table_name)
             prefix = "  "
             for i, v in enumerate(d[keys:], keys):
-                yield '{}"{}" = {}'.format(
-                    prefix, headers[i], escape_for_sql_statement(v)
-                )
+                yield '{}"{}" = {}'.format(prefix, headers[i], escape_for_sql_statement(v))
                 if prefix == "  ":
                     prefix = ", "
             f = '"{}" = {}'
-            where = (
-                f.format(headers[i], escape_for_sql_statement(d[i]))
-                for i in range(keys)
-            )
+            where = (f.format(headers[i], escape_for_sql_statement(d[i])) for i in range(keys))
             yield "WHERE {};".format(" AND ".join(where))
 
 
 def register_new_formatter(TabularOutputFormatter):
     global formatter
     formatter = TabularOutputFormatter
     for sql_format in supported_formats:
-        TabularOutputFormatter.register_new_formatter(
-            sql_format, adapter, preprocessors, {"table_format": sql_format}
-        )
+        TabularOutputFormatter.register_new_formatter(sql_format, adapter, preprocessors, {"table_format": sql_format})

pgcli/packages/parseutils/__init__.py

@@ -29,9 +29,7 @@ def is_destructive(queries, keywords):
     for query in sqlparse.split(queries):
         if query:
             formatted_sql = sqlparse.format(query.lower(), strip_comments=True).strip()
-            if "unconditional_update" in keywords and query_is_unconditional_update(
-                formatted_sql
-            ):
+            if "unconditional_update" in keywords and query_is_unconditional_update(formatted_sql):
                 return True
             if query_starts_with(formatted_sql, keywords):
                 return True

pgcli/packages/parseutils/meta.py

@@ -1,8 +1,6 @@
 from collections import namedtuple
 
-_ColumnMetadata = namedtuple(
-    "ColumnMetadata", ["name", "datatype", "foreignkeys", "default", "has_default"]
-)
+_ColumnMetadata = namedtuple("ColumnMetadata", ["name", "datatype", "foreignkeys", "default", "has_default"])
 
 
 def ColumnMetadata(name, datatype, foreignkeys=None, default=None, has_default=False):
@@ -143,11 +141,7 @@ def arg(name, typ, num):
             num_args = len(args)
             num_defaults = len(self.arg_defaults)
             has_default = num + num_defaults >= num_args
-            default = (
-                self.arg_defaults[num - num_args + num_defaults]
-                if has_default
-                else None
-            )
+            default = self.arg_defaults[num - num_args + num_defaults] if has_default else None
             return ColumnMetadata(name, typ, [], default, has_default)
 
         return [arg(name, typ, num) for num, (name, typ) in enumerate(args)]

pgcli/packages/parseutils/tables.py

@@ -3,16 +3,9 @@
 from sqlparse.sql import IdentifierList, Identifier, Function
 from sqlparse.tokens import Keyword, DML, Punctuation
 
-TableReference = namedtuple(
-    "TableReference", ["schema", "name", "alias", "is_function"]
-)
+TableReference = namedtuple("TableReference", ["schema", "name", "alias", "is_function"])
 TableReference.ref = property(
-    lambda self: self.alias
-    or (
-        self.name
-        if self.name.islower() or self.name[0] == '"'
-        else '"' + self.name + '"'
-    )
+    lambda self: self.alias or (self.name if self.name.islower() or self.name[0] == '"' else '"' + self.name + '"')
 )
 
 
@@ -53,11 +46,7 @@ def extract_from_part(parsed, stop_at_punctuation=True):
             # Also 'SELECT * FROM abc JOIN def' will trigger this elif
             # condition. So we need to ignore the keyword JOIN and its variants
             # INNER JOIN, FULL OUTER JOIN, etc.
-            elif (
-                item.ttype is Keyword
-                and (not item.value.upper() == "FROM")
-                and (not item.value.upper().endswith("JOIN"))
-            ):
+            elif item.ttype is Keyword and (not item.value.upper() == "FROM") and (not item.value.upper().endswith("JOIN")):
                 tbl_prefix_seen = False
             else:
                 yield item
@@ -116,15 +105,11 @@ def parse_identifier(item):
                     try:
                         schema_name = identifier.get_parent_name()
                         real_name = identifier.get_real_name()
-                        is_function = allow_functions and _identifier_is_function(
-                            identifier
-                        )
+                        is_function = allow_functions and _identifier_is_function(identifier)
                     except AttributeError:
                         continue
                     if real_name:
-                        yield TableReference(
-                            schema_name, real_name, identifier.get_alias(), is_function
-                        )
+                        yield TableReference(schema_name, real_name, identifier.get_alias(), is_function)
             elif isinstance(item, Identifier):
                 schema_name, real_name, alias = parse_identifier(item)
                 is_function = allow_functions and _identifier_is_function(item)

pgcli/packages/parseutils/utils.py

@@ -79,9 +79,7 @@ def find_prev_keyword(sql, n_skip=0):
     logical_operators = ("AND", "OR", "NOT", "BETWEEN")
 
     for t in reversed(flattened):
-        if t.value == "(" or (
-            t.is_keyword and (t.value.upper() not in logical_operators)
-        ):
+        if t.value == "(" or (t.is_keyword and (t.value.upper() not in logical_operators)):
             # Find the location of token t in the original parsed statement
             # We can't use parsed.token_index(t) because t may be a child token
             # inside a TokenList, in which case token_index throws an error