Merge pull request kvesteri#648 from kvesteri/use-pre-commit

Use pre-commit

Author: kurtmckee

.editorconfig

@@ -12,3 +12,6 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 indent_size = 4
+
+[*.yaml]
+indent_size = 2

.github/workflows/lint.yaml

@@ -6,13 +6,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.6', '3.10']
+        python-version: ['3.11']
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install tox
         run: pip install tox
       - name: Run linting
-        run: tox -e lint
+        run: tox -e flake8,isort

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+# Run `pre-commit autoupdate` to update the hook versions.
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+
+      # Allow tox to run isort as a linter.
+      - id: isort
+        alias: isort-check
+        args: [--check]
+        stages: [manual]
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.1.0
+    hooks:
+      - id: pyupgrade
+        args: [--py36-plus]

CHANGES.rst

@@ -8,6 +8,7 @@ Unreleased
 ^^^^^^^^^^
 
 - Support Python 3.11.
+- Add pre-commit hooks for uniform text checks, isort, flake8, and pyupgrade.
 - Fix a crash that occurs if the ``colour-science`` package is installed,
   which shares the same import name as the ``colour`` package that sqlalchemy-utils supports.
   (`#637 <https://github.com/kvesteri/sqlalchemy-utils/pull/637>`_, courtesy of JayPalm)

conftest.py

@@ -73,7 +73,7 @@ def mysql_db_user():
 @pytest.fixture
 def postgresql_dsn(postgresql_db_user, postgresql_db_password, postgresql_db_host,
                    db_name):
-    return 'postgresql://{0}:{1}@{2}/{3}'.format(
+    return 'postgresql://{}:{}@{}/{}'.format(
         postgresql_db_user,
         postgresql_db_password,
         postgresql_db_host,
@@ -83,7 +83,7 @@ def postgresql_dsn(postgresql_db_user, postgresql_db_password, postgresql_db_hos
 
 @pytest.fixture
 def mysql_dsn(mysql_db_user, db_name):
-    return 'mysql+pymysql://{0}@localhost/{1}'.format(mysql_db_user, db_name)
+    return f'mysql+pymysql://{mysql_db_user}@localhost/{db_name}'
 
 
 @pytest.fixture
@@ -98,7 +98,7 @@ def sqlite_none_database_dsn():
 
 @pytest.fixture
 def sqlite_file_dsn(db_name):
-    return 'sqlite:///{0}.db'.format(db_name)
+    return f'sqlite:///{db_name}.db'
 
 
 @pytest.fixture
@@ -121,7 +121,7 @@ def mssql_db_driver():
 
 @pytest.fixture
 def mssql_dsn(mssql_db_user, mssql_db_password, mssql_db_driver, db_name):
-    return 'mssql+pyodbc://{0}:{1}@localhost/{2}?driver={3}'\
+    return 'mssql+pyodbc://{}:{}@localhost/{}?driver={}'\
         .format(mssql_db_user, mssql_db_password, db_name, mssql_db_driver)
 
 
@@ -177,7 +177,7 @@ class Category(Base):
 
         @hybrid_property
         def full_name(self):
-            return '%s %s' % (self.title, self.name)
+            return f'{self.title} {self.name}'
 
         @full_name.expression
         def full_name(self):

sqlalchemy_utils/aggregates.py

@@ -391,7 +391,7 @@ def __init__(
         *args,
         **kwargs
     ):
-        super(AggregatedAttribute, self).__init__(fget, *args, **kwargs)
+        super().__init__(fget, *args, **kwargs)
         self.__doc__ = fget.__doc__
         self.column = column
         self.relationship = relationship

sqlalchemy_utils/expressions.py

@@ -24,7 +24,7 @@ def compile_array_get(element, compiler, **kw):
         raise Exception(
             "Second argument should be an integer."
         )
-    return '(%s)[%s]' % (
+    return '({})[{}]'.format(
         compiler.process(args[0]),
         sa.text(str(args[1].value + 1))
     )
@@ -37,7 +37,7 @@ class row_to_json(GenericFunction):
 
 @compiles(row_to_json, 'postgresql')
 def compile_row_to_json(element, compiler, **kw):
-    return "%s(%s)" % (element.name, compiler.process(element.clauses))
+    return f"{element.name}({compiler.process(element.clauses)})"
 
 
 class json_array_length(GenericFunction):
@@ -47,7 +47,7 @@ class json_array_length(GenericFunction):
 
 @compiles(json_array_length, 'postgresql')
 def compile_json_array_length(element, compiler, **kw):
-    return "%s(%s)" % (element.name, compiler.process(element.clauses))
+    return f"{element.name}({compiler.process(element.clauses)})"
 
 
 class Asterisk(ColumnElement):

sqlalchemy_utils/functions/database.py

@@ -93,7 +93,7 @@ def scalar_convert(a):
             )
         )
     elif isinstance(value, str):
-        return scalar_convert("'{0}'".format(value))
+        return scalar_convert(f"'{value}'")
     elif isinstance(value, Sequence):
         return sa.func.json_build_array(
             *(
@@ -165,7 +165,7 @@ def scalar_convert(a):
             )
         )
     elif isinstance(value, str):
-        return scalar_convert("'{0}'".format(value))
+        return scalar_convert(f"'{value}'")
     elif isinstance(value, Sequence):
         return sa.func.jsonb_build_array(
             *(
@@ -565,7 +565,7 @@ def create_database(url, encoding='utf8', template=None):
         if not template:
             template = 'template1'
 
-        text = "CREATE DATABASE {0} ENCODING '{1}' TEMPLATE {2}".format(
+        text = "CREATE DATABASE {} ENCODING '{}' TEMPLATE {}".format(
             quote(engine, database),
             encoding,
             quote(engine, template)
@@ -575,7 +575,7 @@ def create_database(url, encoding='utf8', template=None):
             connection.execute(sa.text(text))
 
     elif dialect_name == 'mysql':
-        text = "CREATE DATABASE {0} CHARACTER SET = '{1}'".format(
+        text = "CREATE DATABASE {} CHARACTER SET = '{}'".format(
             quote(engine, database),
             encoding
         )
@@ -589,7 +589,7 @@ def create_database(url, encoding='utf8', template=None):
                 connection.execute(sa.text("DROP TABLE DB;"))
 
     else:
-        text = 'CREATE DATABASE {0}'.format(quote(engine, database))
+        text = f'CREATE DATABASE {quote(engine, database)}'
         with engine.begin() as connection:
             connection.execute(sa.text(text))
 
@@ -642,18 +642,18 @@ def drop_database(url):
                 'pid' if (version >= (9, 2)) else 'procpid'
             )
             text = '''
-            SELECT pg_terminate_backend(pg_stat_activity.%(pid_column)s)
+            SELECT pg_terminate_backend(pg_stat_activity.{pid_column})
             FROM pg_stat_activity
-            WHERE pg_stat_activity.datname = '%(database)s'
-            AND %(pid_column)s <> pg_backend_pid();
-            ''' % {'pid_column': pid_column, 'database': database}
+            WHERE pg_stat_activity.datname = '{database}'
+            AND {pid_column} <> pg_backend_pid();
+            '''.format(pid_column=pid_column, database=database)
             connection.execute(sa.text(text))
 
             # Drop the database.
-            text = 'DROP DATABASE {0}'.format(quote(connection, database))
+            text = f'DROP DATABASE {quote(connection, database)}'
             connection.execute(sa.text(text))
     else:
-        text = 'DROP DATABASE {0}'.format(quote(engine, database))
+        text = f'DROP DATABASE {quote(engine, database)}'
         with engine.begin() as connection:
             connection.execute(sa.text(text))
 

sqlalchemy_utils/functions/foreign_keys.py

@@ -13,17 +13,15 @@
 
 def get_foreign_key_values(fk, obj):
     mapper = get_mapper(obj)
-    return dict(
-        (
-            fk.constraint.columns.values()[index],
-            getattr(obj, element.column.key)
-            if hasattr(obj, element.column.key)
-            else getattr(
-                obj, mapper.get_property_by_column(element.column).key
-            ),
+    return {
+        fk.constraint.columns.values()[index]:
+        getattr(obj, element.column.key)
+        if hasattr(obj, element.column.key)
+        else getattr(
+            obj, mapper.get_property_by_column(element.column).key
         )
         for index, element in enumerate(fk.constraint.elements)
-    )
+    }
 
 
 def group_foreign_keys(foreign_keys):
@@ -177,7 +175,7 @@ class BlogPost(self.Base):
                 fk.constraint.table.update()
                 .where(sa.and_(*criteria))
                 .values(
-                    dict((key.key, value) for key, value in new_values.items())
+                    {key.key: value for key, value in new_values.items()}
                 )
             )
             session.execute(query)

sqlalchemy_utils/functions/mock.py

@@ -37,7 +37,7 @@ def render_literal_value(self, value, type_):
                     elif isinstance(value, (datetime.date, datetime.datetime)):
                         return "'%s'" % value
 
-                    return super(Compiler, self).render_literal_value(
+                    return super().render_literal_value(
                         value, type_)
 
             text = str(Compiler(engine.dialect, sql).process(sql))