%sqlplot bar and pie charts

CHANGELOG.md

@@ -6,6 +6,7 @@
 * [Feature] Better error messages when function used in plotting API unsupported by DB driver (#159)
 * [Fix] Fix the default value of %config SqlMagic.displaylimit to 10 (#462)
 * [Feature] Detailed error messages when syntax error in SQL query, postgres connection password missing or inaccessible, invalid DuckDB connection string (#229)
+* [Feature] Added bar plot and pie charts to %sqlplot (#508)
 
 
 ## 0.7.4 (2023-04-28)

doc/api/magic-plot.md

@@ -160,3 +160,100 @@ ax = %sqlplot histogram --table no_nulls --column body_mass_g --with no_nulls
 ax.set_title("Body mass (grams)")
 _ = ax.grid()
 ```
+## `%sqlplot bar`
+
+Shortcut: `%sqlplot bar`
+
+`-t`/`--table` Table to use (if using DuckDB: path to the file to query)
+
+`-c`/`--column` Column to plot.
+
+`-o`/`--orient` Barplot orientation (`h` for horizontal, `v` for vertical)
+
+`-w`/`--with` Use a previously saved query as input data
+
+`-sn`/`--show_num` Show number on top of the bar
+
+Barplot does not support NULL values, so let's remove them:
+
+```{code-cell} ipython3
+%%sql --save no_nulls --no-execute
+SELECT *
+FROM penguins.csv
+WHERE species IS NOT NULL
+```
+
+```{code-cell} ipython3
+%sqlplot bar --table no_nulls --column species --with no_nulls
+```
+
+You can additionally pass two columns to bar plot i.e. `x` and `height` columns.
+
+```{code-cell} ipython3
+%%sql --save add_col --no-execute --with no_nulls
+SELECT species, count(species) as cnt
+FROM no_nulls
+group by species
+```
+
+```{code-cell} ipython3
+%sqlplot bar --table add_col --column species cnt --with add_col
+```
+
+You can also pass the orientation using the `orient` argument.
+
+```{code-cell} ipython3
+%sqlplot bar --table add_col --column species cnt --with add_col --orient h
+``` 
+
+You can also show the number on top of the bar using the `show_num` argument.
+
+```{code-cell} ipython3
+%sqlplot bar --table no_nulls --column species --with no_nulls -sn
+```
+
+## `%sqlplot pie`
+
+Shortcut: `%sqlplot pie`
+
+`-t`/`--table` Table to use (if using DuckDB: path to the file to query)
+
+`-c`/`--column` Column to plot
+
+`-w`/`--with` Use a previously saved query as input data
+
+`-sn`/`--show_num` Show the percentage on top of the pie
+
+Pie chart does not support NULL values, so let's remove them:
+
+```{code-cell} ipython3
+%%sql --save no_nulls --no-execute
+SELECT *
+FROM penguins.csv
+WHERE species IS NOT NULL
+```
+
+```{code-cell} ipython3
+%sqlplot pie --table no_nulls --column species --with no_nulls
+```
+
+You can additionally pass two columns to bar plot i.e. `labels` and `x` columns.
+
+```{code-cell} ipython3
+%%sql --save add_col --no-execute --with no_nulls
+SELECT species, count(species) as cnt
+FROM no_nulls
+group by species
+```
+
+```{code-cell} ipython3
+%sqlplot pie --table add_col --column species cnt --with add_col
+```
+Here, `species` is the `labels` column and `cnt` is the `x` column.
+
+
+You can also show the percentage on top of the pie using the `show_num` argument.
+
+```{code-cell} ipython3
+%sqlplot pie --table no_nulls --column species --with no_nulls -sn
+```

src/sql/magic_plot.py

@@ -17,6 +17,8 @@
 from sql import exceptions
 from sql import util
 
+SUPPORTED_PLOTS = ["histogram", "boxplot", "bar", "pie"]
+
 
 @magics_class
 class SqlPlotMagic(Magics, Configurable):
@@ -51,6 +53,12 @@ class SqlPlotMagic(Magics, Configurable):
         action="append",
         dest="with_",
     )
+    @argument(
+        "-sn",
+        "--show_num",
+        action="store_true",
+        help="Show number of observations",
+    )
     @modify_exceptions
     def execute(self, line="", cell="", local_ns=None):
         """
@@ -65,8 +73,10 @@ def execute(self, line="", cell="", local_ns=None):
             column = cmd.args.column
 
         if not cmd.args.line:
+            plot_str = util.pretty_print(SUPPORTED_PLOTS, last_delimiter="or")
             raise exceptions.UsageError(
-                "Missing the first argument, must be: 'histogram' or 'boxplot'. "
+                "Missing the first argument, must be any of: "
+                f"{plot_str}\n"
                 "Example: %sqlplot histogram"
             )
 
@@ -92,7 +102,29 @@ def execute(self, line="", cell="", local_ns=None):
                 with_=cmd.args.with_,
                 conn=None,
             )
+        elif cmd.args.line[0] in {"bar"}:
+            util.is_table_exists(table, with_=cmd.args.with_)
+
+            return plot.bar(
+                table=table,
+                column=column,
+                with_=cmd.args.with_,
+                orient=cmd.args.orient,
+                show_num=cmd.args.show_num,
+                conn=None,
+            )
+        elif cmd.args.line[0] in {"pie"}:
+            util.is_table_exists(table, with_=cmd.args.with_)
+
+            return plot.pie(
+                table=table,
+                column=column,
+                with_=cmd.args.with_,
+                show_num=cmd.args.show_num,
+                conn=None,
+            )
         else:
+            plot_str = util.pretty_print(SUPPORTED_PLOTS, last_delimiter="or")
             raise exceptions.UsageError(
-                f"Unknown plot {cmd.args.line[0]!r}. Must be: 'histogram' or 'boxplot'"
+                f"Unknown plot {cmd.args.line[0]!r}. Must be any of: " f"{plot_str}"
             )