snippets display improvement

[bbeat2782]

Describe your changes

Change %sqlcmd snippets output into displaying 1. snippet name 2. snippet query 3. snippet table.

Still working on 1. figuring out how to retrieve SqlMagic.displaylimit 2. adding test functions 3. update documentation if needed, but I want to know whether it's on the right direction or not.

Issue number

Closes #648

Checklist before requesting a review

• Performed a self-review of my code
• Formatted my code with pkgmt format
• Added tests (when necessary).
• Added docstring documentation and update the changelog (when needed)

---

📚 Documentation preview 📚: https://jupysql--716.org.readthedocs.build/en/716/

[bbeat2782]

@edublancas

This is the current output of %sqlcmd snippets. Am I on the right track?

[edublancas]

@bbeat2782 you don't need to query the tables. instead, you can create a table that displays the snippet names

e.g.

----------------
| some snippet |
----------------
| another           |
----------------

you can use this:

jupysql/src/sql/display.py

Line 10 in 4b938ed

class Table:

[bbeat2782]

@bbeat2782 you don't need to query the tables. instead, you can create a table that displays the snippet names

e.g.

----------------
| some snippet |
----------------
| another           |
----------------

you can use this:

jupysql/src/sql/display.py

Line 10 in 4b938ed

class Table:

@edublancas Oh that is what you meant when you said table. Thanks. Will make the change.

[bbeat2782]

Output of %sqlcmd snippets when no snippet is stored.

Output of %sqlcmd snippets when chinstrap and chinstrap_sub are stored.

The above images are screen captured images from snippet_display_improvement.ipynb.zip

[yafimvo]

looks good. Added one comment about the test.

[yafimvo]

Deleting a snippet might affect some other tests. To make sure we are not, I think you can create a new snippet and see if it's in the table. then, clean up these snippets. I would test the following cases: no snippets, 1, 2, and 3 snippets.

[bbeat2782]

@yafimvo
To ensure it doesn't affect other tests, I created a new @pytest.fixture for this test function for creating and deleting snippets.

[yafimvo]

lgtm!