assert_and_print(
+ format_where(
+ "WHERE brand = 'my_brand'"
+ ), "WHERE brand = 'my_brand'"
+)
+assert_and_print(
+ format_sql("SELECT brand FROM table WHERE brand = 'my_brand'"),
+"""
+SELECT brand
+FROM table
+WHERE brand = 'my_brand'
+""".strip()
+)
+pre-commit
pre-commit is a nice development tool to automatize the binding of pre-commit hooks. After installation and configuration pre-commit will run your hooks before you commit any change.
To add sql-formatter as a hook to your pre-commit configuration to format your SQL files before commit, just add the following lines to your .pre-commit-config.yaml:
repos:
+ - repo: https://github.com/PabloRMira/sql_formatter
+ rev: master
+ hooks:
+ - id: sql_formatter
+If you want to install sql-formatter locally and use that instead of using pre-commit's default environment, set repo: local in your .pre-commit-config.yaml file:
repos:
- repo: local
hooks:
diff --git a/docs/sidebar.json b/docs/sidebar.json
index c0b4234..9229f18 100644
--- a/docs/sidebar.json
+++ b/docs/sidebar.json
@@ -4,6 +4,7 @@
"core": "core.html",
"format_file": "format_file.html",
"utils": "utils.html",
- "validation": "validation.html"
+ "validation": "validation.html",
+ "Additional tests": "additional_tests.html"
}
}
\ No newline at end of file
diff --git a/nbs/00_core.ipynb b/nbs/00_core.ipynb
index 3fdfbac..0e1d394 100644
--- a/nbs/00_core.ipynb
+++ b/nbs/00_core.ipynb
@@ -4,7 +4,16 @@
"cell_type": "code",
"execution_count": null,
"metadata": {},
- "outputs": [],
+ "outputs": [
+ {
+ "name": "stdout",
+ "output_type": "stream",
+ "text": [
+ "The autoreload extension is already loaded. To reload it, use:\n",
+ " %reload_ext autoreload\n"
+ ]
+ }
+ ],
"source": [
"#hide\n",
"%load_ext autoreload\n",
@@ -3019,8 +3028,8 @@
" # split by comment / non comment, quote / non-quote\n",
" split_s = split_comment_quote(s)\n",
" # define regex before loop\n",
- " indent_and = re.compile(r\"\\s*(and)\\b\", flags=re.I)\n",
- " indent_or = re.compile(r\"\\s*(or)\\b\", flags=re.I)\n",
+ " indent_and = re.compile(r\"\\s*\\b(and)\\b\", flags=re.I)\n",
+ " indent_or = re.compile(r\"\\s*\\b(or)\\b\", flags=re.I)\n",
" for d in split_s:\n",
" if not d[\"comment\"] and not d[\"quote\"]:\n",
" s_aux = d[\"string\"]\n",
@@ -4060,6 +4069,7 @@
"Converted 01_format_file.ipynb.\n",
"Converted 02_utils.ipynb.\n",
"Converted 03_validation.ipynb.\n",
+ "Converted 99_additional_tests.ipynb.\n",
"Converted index.ipynb.\n"
]
}
diff --git a/nbs/99_additional_tests.ipynb b/nbs/99_additional_tests.ipynb
new file mode 100644
index 0000000..413528e
--- /dev/null
+++ b/nbs/99_additional_tests.ipynb
@@ -0,0 +1,123 @@
+{
+ "cells": [
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "#hide\n",
+ "%load_ext autoreload\n",
+ "%autoreload 2\n",
+ "%config Completer.use_jedi = False # workaround for buggy jedi"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Additional tests"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "#hide\n",
+ "from nbdev.showdoc import *\n",
+ "from sql_formatter.utils import *\n",
+ "from sql_formatter.core import *"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## core"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "### format_where"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {},
+ "outputs": [
+ {
+ "name": "stdout",
+ "output_type": "stream",
+ "text": [
+ "WHERE brand = 'my_brand'\n"
+ ]
+ }
+ ],
+ "source": [
+ "assert_and_print(\n",
+ " format_where(\n",
+ " \"WHERE brand = 'my_brand'\"\n",
+ " ), \"WHERE brand = 'my_brand'\"\n",
+ ")"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "### format_sql"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {},
+ "outputs": [
+ {
+ "name": "stdout",
+ "output_type": "stream",
+ "text": [
+ "SELECT brand\n",
+ "FROM table\n",
+ "WHERE brand = 'my_brand'\n"
+ ]
+ }
+ ],
+ "source": [
+ "assert_and_print(\n",
+ " format_sql(\"SELECT brand FROM table WHERE brand = 'my_brand'\"),\n",
+ "\"\"\"\n",
+ "SELECT brand\n",
+ "FROM table\n",
+ "WHERE brand = 'my_brand'\n",
+ "\"\"\".strip()\n",
+ ")"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "#hide\n",
+ "from nbdev.export import notebook2script\n",
+ "notebook2script()"
+ ]
+ }
+ ],
+ "metadata": {
+ "kernelspec": {
+ "display_name": "Python [conda env:sql-formatter-dev] *",
+ "language": "python",
+ "name": "conda-env-sql-formatter-dev-py"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}
diff --git a/sql_formatter/core.py b/sql_formatter/core.py
index 0826d55..63178d6 100644
--- a/sql_formatter/core.py
+++ b/sql_formatter/core.py
@@ -366,8 +366,8 @@ def format_where(s, **kwargs):
# split by comment / non comment, quote / non-quote
split_s = split_comment_quote(s)
# define regex before loop
- indent_and = re.compile(r"\s*(and)\b", flags=re.I)
- indent_or = re.compile(r"\s*(or)\b", flags=re.I)
+ indent_and = re.compile(r"\s*\b(and)\b", flags=re.I)
+ indent_or = re.compile(r"\s*\b(or)\b", flags=re.I)
for d in split_s:
if not d["comment"] and not d["quote"]:
s_aux = d["string"]