chore: add bigquery-magics samples

bigquery_magics/bigquery.py

@@ -101,6 +101,7 @@
 from google.cloud.bigquery.dbapi import _helpers
 
 from bigquery_magics import line_arg_parser as lap
+import bigquery_magics._versions_helpers
 import bigquery_magics.config
 import bigquery_magics.line_arg_parser.exceptions
 

docs/index.rst

@@ -37,7 +37,6 @@ of this library (from ``1.x`` to ``2.x``, or from ``2.x`` to ``3.x``).
 .. toctree::
     :maxdepth: 2
 
-    UPGRADING
 
 Changelog
 ---------

docs/magics.rst

@@ -15,14 +15,14 @@ Code Samples
 
 Running a query:
 
-.. literalinclude:: ./samples/magics/query.py
+.. literalinclude:: ./samples/snippets/query.py
    :dedent: 4
    :start-after: [START bigquery_jupyter_query]
    :end-before: [END bigquery_jupyter_query]
 
 Running a parameterized query:
 
-.. literalinclude:: ./samples/magics/query_params_scalars.py
+.. literalinclude:: ./samples/snippets/query_params_scalars.py
    :dedent: 4
    :start-after: [START bigquery_jupyter_query_params_scalars]
    :end-before: [END bigquery_jupyter_query_params_scalars]

samples/snippets/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

samples/snippets/_helpers.py

@@ -0,0 +1,21 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+def strip_region_tags(sample_text: str) -> str:
+    """Remove blank lines and region tags from sample text"""
+    magic_lines = [
+        line for line in sample_text.split("\n") if len(line) > 0 and "# [" not in line
+    ]
+    return "\n".join(magic_lines)

samples/snippets/conftest.py

@@ -0,0 +1,44 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import typing
+from typing import Iterator
+
+import pytest
+
+if typing.TYPE_CHECKING:
+    from IPython.core.interactiveshell import TerminalInteractiveShell
+
+interactiveshell = pytest.importorskip("IPython.terminal.interactiveshell")
+tools = pytest.importorskip("IPython.testing.tools")
+
+
+@pytest.fixture(scope="session")
+def ipython() -> "TerminalInteractiveShell":
+    config = tools.default_config()
+    config.TerminalInteractiveShell.simple_prompt = True
+    shell = interactiveshell.TerminalInteractiveShell.instance(config=config)
+    return shell
+
+
+@pytest.fixture(autouse=True)
+def ipython_interactive(
+    ipython: "TerminalInteractiveShell",
+) -> Iterator["TerminalInteractiveShell"]:
+    """Activate IPython's builtin hooks
+
+    for the duration of the test scope.
+    """
+    with ipython.builtin_trap:
+        yield ipython

samples/snippets/mypy.ini

@@ -0,0 +1,8 @@
+[mypy]
+; We require type annotations in all samples.
+strict = True
+exclude = noxfile\.py
+warn_unused_configs = True
+
+[mypy-IPython.*,nox,noxfile_config,pandas]
+ignore_missing_imports = True