Skip to content
This repository was archived by the owner on Mar 6, 2026. It is now read-only.

feat: add custom cell magic parser #213

Merged
tswast merged 20 commits into from
Sep 9, 2020
Merged

feat: add custom cell magic parser #213

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
c5e63c6
chore: Move cell magic code into its own directory
plamut Aug 2, 2020
199974f
Add custom argument parser for cell magic
plamut Aug 17, 2020
d3525d4
Add AST node visitor
plamut Aug 7, 2020
5690b81
Use a custom parser for cell magic arguments
plamut Aug 17, 2020
976567c
Improve cell magic parser test coverage
plamut Aug 24, 2020
f57c6cd
Generalize valid option values
plamut Sep 2, 2020
c7e4420
Fix recognizing --params option in state 3
plamut Sep 2, 2020
90c504e
Fix typo in comment
plamut Sep 2, 2020
3b94a55
Merge branch 'master' into fix-cellmagic-parser
plamut Sep 2, 2020
5249c6a
Cover missing parser code path with a test
plamut Sep 2, 2020
83218a2
Merge branch 'master' into fix-cellmagic-parser
plamut Sep 3, 2020
2c74ec8
Preserve the cell magic context's import path
plamut Sep 4, 2020
19af056
Clarify lexer states
plamut Sep 4, 2020
4cbf7f2
Replace re.scanner with finditer()
plamut Sep 9, 2020
64f19b5
Fix typo in docstring
plamut Sep 9, 2020
5d10d36
Simplify string literal in a single line
plamut Sep 9, 2020
46d1def
Explain the visitors module.
plamut Sep 9, 2020
ed01a66
Merge branch 'master' into fix-cellmagic-parser
plamut Sep 9, 2020
d9dd3e0
Pass pos as a positional arg to finditer()
plamut Sep 9, 2020
415c608
Resolve coverage complaint about a code path
plamut Sep 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Generalize valid option values 
The parser should accept as wide a range of values as possible and let
the code that delas with the semantics to decide whether the values are
good or not.
  • Loading branch information
@plamut
plamut committed Sep 2, 2020
commit f57c6cd5f317a781a4a1f124ba4cf7eb76599eb1
4 changes: 1 addition & 3 deletions google/cloud/bigquery/ipython_magics/line_arg_parser/lexer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,7 @@
),
("OPTION_SPEC", r"(?P<OPTION_SPEC>--\w+)"),
("OPTION_EQ", r"(?P<OPTION_EQ>=)"),
# NOTE: Currently the only valid value for a non "--params" option is
# either a project/table name or an integer (e.g. max_results).
("OPT_VAL", r"(?P<OPT_VAL>(?:\w|\.|-(?!-))+)"),
("OPT_VAL", r"(?P<OPT_VAL>\S+?(?=\s|--|$))"),
]
),
),
Expand Down
21 changes: 19 additions & 2 deletions tests/unit/test_magics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1361,8 +1361,7 @@ def test_bigquery_magic_with_option_value_incorrect():

sql = "SELECT @foo AS foo"

exc_pattern = r".*[Uu]nrecognized input.*option values correct\?.*"
with pytest.raises(ValueError, match=exc_pattern):
with pytest.raises(ValueError, match=r".*invalid literal.*\[PLENTY!\].*"):
cell_magic_args = "params_dict_df --max_results [PLENTY!]"
ip.run_cell_magic("bigquery", cell_magic_args, sql)

Expand Down Expand Up @@ -1502,6 +1501,24 @@ def test_bigquery_magic_with_improperly_formatted_params():
ip.run_cell_magic("bigquery", "--params {17}", sql)


@pytest.mark.usefixtures("ipython_interactive")
@pytest.mark.skipif(pandas is None, reason="Requires `pandas`")
def test_bigquery_magic_with_invalid_multiple_option_values():
ip = IPython.get_ipython()
ip.extension_manager.load_extension("google.cloud.bigquery")
magics.context.credentials = mock.create_autospec(
google.auth.credentials.Credentials, instance=True
)

sql = "SELECT @foo AS foo"

exc_pattern = r".*[Uu]nrecognized input.*option values correct\?.*567.*"

with pytest.raises(ValueError, match=exc_pattern):
cell_magic_args = "params_dict_df --max_results 10 567"
ip.run_cell_magic("bigquery", cell_magic_args, sql)


@pytest.mark.usefixtures("ipython_interactive")
def test_bigquery_magic_omits_tracebacks_from_error_message():
ip = IPython.get_ipython()
Expand Down