Validating CLI arguments

doc/environment.yml

@@ -25,8 +25,6 @@ dependencies:
     - pytest
     # for %%sql --interact
     - ipywidgets
-    # 0.13.2 is broken currently
     # https://github.com/pydata/pydata-sphinx-theme/issues/1274
-    - pydata-sphinx-theme<0.13.2
     # needed to upload and download from/to S3 for notebook cache
     - awscli

doc/intro.md

@@ -65,25 +65,36 @@ After the first connection, connect info can be omitted::
 %sql select count(*) from languages
 ```
 
-Connections to multiple databases can be maintained.  You can refer to
-an existing connection by username@database
+Connections to multiple databases can be maintained.  You can switch connection using --alias
+Suppose we create two database, named one and two. Then, assign alias to both connections so we can switch them by name:
 
 ```sql
-%%sql will@shakes
-select charname, speechcount from character
-where  speechcount = (select max(speechcount)
-from character);
+%sql sqlite:///one.db --alias one
+%sql sqlite:///two.db --alias two
 ```
 
-```python
-print(_)
+```sql
+%sql 
 ```
 
-+++
+It will run query in "two" database
+
+Pass the alias to make it the current connection:
+
+```sql
+%sql one
+```
 
-If no connect string is supplied, ``%sql`` will provide a list of existing connections;
-however, if no connections have yet been made and the environment variable ``DATABASE_URL``
-is available, that will be used.
+You can pass an alias and query in the same cell:
+
+```sql
+%sql two
+SELECT * FROM two
+```
+
+However, this isn’t supported with the line magic (e.g., `%sql one SELECT * FROM one`).
+
++++
 
 For secure access, you may dynamically access your credentials (e.g. from your system environment or `getpass.getpass`) to avoid storing your password in the notebook itself. Use the `$` before any variable to access it in your `%sql` command.
 
@@ -98,9 +109,7 @@ connection_string = "postgresql://{user}:{password}@localhost/some_database".for
 
 +++
 
-You may use multiple SQL statements inside a single cell, but you will
-only see any query results from the last of them, so this really only
-makes sense for statements with no output
+You may use multiple SQL statements inside a single cell, but you will only see any query results from the last of them, so this really only makes sense for statements with no output
 
 +++
 

src/sql/magic.py

@@ -22,6 +22,7 @@
 import sql.connection
 import sql.parse
 import sql.run
+from sql.parse import _option_strings_from_parser
 from sql import display, exceptions
 from sql.store import store
 from sql.command import SQLCommand
@@ -180,6 +181,26 @@ def _mutex_autopandas_autopolars(self, change):
                 setattr(self, other, False)
                 print(f"Disabled '{other}' since '{change['name']}' was enabled.")
 
+    def check_random_arguments(self, line="", cell=""):
+        # Split the line into tokens separated by whitespace
+        tokens = line.split()
+        arguments = []
+
+        # Iterate through the tokens to separate arguments and SQL code
+        # If the token starts with "--", it is an argument
+        for token in tokens:
+            if token.startswith("--"):
+                arguments.append(token)
+
+        declared_argument = _option_strings_from_parser(SqlMagic.execute.parser)
+        # check only for cell magic
+        if cell is not None:
+            for check_argument in arguments:
+                if check_argument not in declared_argument:
+                    raise exceptions.UsageError(
+                        "Unrecognized argument(s): {}".format(check_argument)
+                    )
+
     @no_var_expand
     @needs_local_scope
     @line_magic("sql")
@@ -315,6 +336,9 @@ def interactive_execute_wrapper(**kwargs):
 
         # %%sql {line}
         # {cell}
+
+        self.check_random_arguments(line, cell)
+
         if local_ns is None:
             local_ns = {}
 

src/tests/test_magic.py

@@ -187,6 +187,11 @@ def test_persist_no_index(ip):
     assert persisted == [(1, "foo"), (2, "bar")]
 
 
+def test_unrecognized_arguments_cell_magic(ip):
+    result = ip.run_cell("%%sql --stuff \n SELECT * FROM test")
+    assert "Unrecognized argument(s)" in str(result.error_in_exec)
+
+
 def test_persist_invalid_identifier(ip):
     result = ip.run_cell("%sql --persist sqlite:// not an identifier")
     assert "not a valid identifier" in str(result.error_in_exec)