Preserve the cell magic context's import path

plamut · plamut · commit 2c74ec883117 · 2020-09-05T01:15:50.000+02:00
The context still needs to be importable from the old path
diff --git a/docs/magics.rst b/docs/magics.rst
@@ -1,5 +1,5 @@
 IPython Magics for BigQuery
 ===========================
 
-.. automodule:: google.cloud.bigquery.ipython_magics.magics
+.. automodule:: google.cloud.bigquery.magics.magics
     :members:
diff --git a/google/cloud/bigquery/__init__.py b/google/cloud/bigquery/__init__.py
@@ -150,7 +150,7 @@
 
 def load_ipython_extension(ipython):
     """Called by IPython when this module is loaded as an IPython extension."""
-    from google.cloud.bigquery.ipython_magics.magics import _cell_magic
+    from google.cloud.bigquery.magics.magics import _cell_magic
 
     ipython.register_magic_function(
         _cell_magic, magic_kind="cell", magic_name="bigquery"
diff --git a/google/cloud/bigquery/magics/__init__.py b/google/cloud/bigquery/magics/__init__.py
@@ -11,3 +11,10 @@
 # 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.
+
+from google.cloud.bigquery.magics.magics import context
+
+
+# For backwards compatibility we need to make the context available in the path
+# google.cloud.bigquery.magics.context
+__all__ = ("context",)
diff --git a/google/cloud/bigquery/magics/line_arg_parser/__init__.py b/google/cloud/bigquery/magics/line_arg_parser/__init__.py
@@ -12,17 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from google.cloud.bigquery.ipython_magics.line_arg_parser.exceptions import ParseError
-from google.cloud.bigquery.ipython_magics.line_arg_parser.exceptions import (
+from google.cloud.bigquery.magics.line_arg_parser.exceptions import ParseError
+from google.cloud.bigquery.magics.line_arg_parser.exceptions import (
     DuplicateQueryParamsError,
     QueryParamsParseError,
 )
-from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Lexer
-from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import TokenType
-from google.cloud.bigquery.ipython_magics.line_arg_parser.parser import Parser
-from google.cloud.bigquery.ipython_magics.line_arg_parser.visitors import (
-    QueryParamsExtractor,
-)
+from google.cloud.bigquery.magics.line_arg_parser.lexer import Lexer
+from google.cloud.bigquery.magics.line_arg_parser.lexer import TokenType
+from google.cloud.bigquery.magics.line_arg_parser.parser import Parser
+from google.cloud.bigquery.magics.line_arg_parser.visitors import QueryParamsExtractor
 
 
 __all__ = (
diff --git a/google/cloud/bigquery/magics/line_arg_parser/exceptions.py b/google/cloud/bigquery/magics/line_arg_parser/exceptions.py
diff --git a/google/cloud/bigquery/magics/line_arg_parser/lexer.py b/google/cloud/bigquery/magics/line_arg_parser/lexer.py
diff --git a/google/cloud/bigquery/magics/line_arg_parser/parser.py b/google/cloud/bigquery/magics/line_arg_parser/parser.py
@@ -12,12 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from google.cloud.bigquery.ipython_magics.line_arg_parser import (
-    DuplicateQueryParamsError,
-)
-from google.cloud.bigquery.ipython_magics.line_arg_parser import ParseError
-from google.cloud.bigquery.ipython_magics.line_arg_parser import QueryParamsParseError
-from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
+from google.cloud.bigquery.magics.line_arg_parser import DuplicateQueryParamsError
+from google.cloud.bigquery.magics.line_arg_parser import ParseError
+from google.cloud.bigquery.magics.line_arg_parser import QueryParamsParseError
+from google.cloud.bigquery.magics.line_arg_parser import TokenType
 
 
 class ParseNode(object):
diff --git a/google/cloud/bigquery/magics/line_arg_parser/visitors.py b/google/cloud/bigquery/magics/line_arg_parser/visitors.py
diff --git a/google/cloud/bigquery/magics/magics.py b/google/cloud/bigquery/magics/magics.py
@@ -160,7 +160,7 @@
 from google.cloud import bigquery
 import google.cloud.bigquery.dataset
 from google.cloud.bigquery.dbapi import _helpers
-from google.cloud.bigquery.ipython_magics import line_arg_parser as lap
+from google.cloud.bigquery.magics import line_arg_parser as lap
 
 
 IPYTHON_USER_AGENT = "ipython-{}".format(IPython.__version__)
diff --git a/tests/unit/line_arg_parser/test_lexer.py b/tests/unit/line_arg_parser/test_lexer.py
@@ -17,14 +17,14 @@
 
 @pytest.fixture(scope="session")
 def lexer_class():
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Lexer
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Lexer
 
     return Lexer
 
 
 def test_empy_input(lexer_class):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Token
+    from google.cloud.bigquery.magics.line_arg_parser import TokenType
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Token
 
     lexer = lexer_class("")
     tokens = list(lexer)
diff --git a/tests/unit/line_arg_parser/test_parser.py b/tests/unit/line_arg_parser/test_parser.py
@@ -17,14 +17,14 @@
 
 @pytest.fixture(scope="session")
 def parser_class():
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.parser import Parser
+    from google.cloud.bigquery.magics.line_arg_parser.parser import Parser
 
     return Parser
 
 
 def test_consume_expected_eol(parser_class):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Token
+    from google.cloud.bigquery.magics.line_arg_parser import TokenType
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Token
 
     # A simple iterable of Tokens is sufficient.
     fake_lexer = [Token(TokenType.EOL, lexeme="", pos=0)]
@@ -34,9 +34,9 @@ def test_consume_expected_eol(parser_class):
 
 
 def test_consume_unexpected_eol(parser_class):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import ParseError
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Token
+    from google.cloud.bigquery.magics.line_arg_parser import ParseError
+    from google.cloud.bigquery.magics.line_arg_parser import TokenType
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Token
 
     # A simple iterable of Tokens is sufficient.
     fake_lexer = [Token(TokenType.EOL, lexeme="", pos=0)]
@@ -47,9 +47,9 @@ def test_consume_unexpected_eol(parser_class):
 
 
 def test_input_line_unexpected_input(parser_class):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import ParseError
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Token
+    from google.cloud.bigquery.magics.line_arg_parser import ParseError
+    from google.cloud.bigquery.magics.line_arg_parser import TokenType
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Token
 
     # A simple iterable of Tokens is sufficient.
     fake_lexer = [
@@ -64,9 +64,9 @@ def test_input_line_unexpected_input(parser_class):
 
 
 def test_destination_var_unexpected_input(parser_class):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import ParseError
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Token
+    from google.cloud.bigquery.magics.line_arg_parser import ParseError
+    from google.cloud.bigquery.magics.line_arg_parser import TokenType
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Token
 
     # A simple iterable of Tokens is sufficient.
     fake_lexer = [
@@ -80,9 +80,9 @@ def test_destination_var_unexpected_input(parser_class):
 
 
 def test_option_value_unexpected_input(parser_class):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import ParseError
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Token
+    from google.cloud.bigquery.magics.line_arg_parser import ParseError
+    from google.cloud.bigquery.magics.line_arg_parser import TokenType
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Token
 
     # A simple iterable of Tokens is sufficient.
     fake_lexer = [
@@ -96,8 +96,8 @@ def test_option_value_unexpected_input(parser_class):
 
 
 def test_dict_items_empty_dict(parser_class):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Token
+    from google.cloud.bigquery.magics.line_arg_parser import TokenType
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Token
 
     # A simple iterable of Tokens is sufficient.
     fake_lexer = [Token(TokenType.RCURL, lexeme="}", pos=22)]
@@ -109,8 +109,8 @@ def test_dict_items_empty_dict(parser_class):
 
 
 def test_dict_items_trailing_comma(parser_class):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Token
+    from google.cloud.bigquery.magics.line_arg_parser import TokenType
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Token
 
     # A simple iterable of Tokens is sufficient.
     fake_lexer = [
@@ -131,9 +131,9 @@ def test_dict_items_trailing_comma(parser_class):
 
 
 def test_dict_item_unknown_input(parser_class):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import ParseError
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Token
+    from google.cloud.bigquery.magics.line_arg_parser import ParseError
+    from google.cloud.bigquery.magics.line_arg_parser import TokenType
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Token
 
     # A simple iterable of Tokens is sufficient.
     fake_lexer = [Token(TokenType.UNKNOWN, lexeme="#/%", pos=35)]
@@ -144,10 +144,10 @@ def test_dict_item_unknown_input(parser_class):
 
 
 def test_pyvalue_list_containing_dict(parser_class):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Token
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.parser import PyDict
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.parser import PyList
+    from google.cloud.bigquery.magics.line_arg_parser import TokenType
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Token
+    from google.cloud.bigquery.magics.line_arg_parser.parser import PyDict
+    from google.cloud.bigquery.magics.line_arg_parser.parser import PyList
 
     # A simple iterable of Tokens is sufficient.
     fake_lexer = [
@@ -178,9 +178,9 @@ def test_pyvalue_list_containing_dict(parser_class):
 
 
 def test_pyvalue_invalid_token(parser_class):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import ParseError
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Token
+    from google.cloud.bigquery.magics.line_arg_parser import ParseError
+    from google.cloud.bigquery.magics.line_arg_parser import TokenType
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Token
 
     # A simple iterable of Tokens is sufficient.
     fake_lexer = [Token(TokenType.OPTION_SPEC, lexeme="--verbose", pos=75)]
@@ -192,8 +192,8 @@ def test_pyvalue_invalid_token(parser_class):
 
 
 def test_collection_items_empty(parser_class):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser import TokenType
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.lexer import Token
+    from google.cloud.bigquery.magics.line_arg_parser import TokenType
+    from google.cloud.bigquery.magics.line_arg_parser.lexer import Token
 
     # A simple iterable of Tokens is sufficient.
     fake_lexer = [Token(TokenType.RPAREN, lexeme=")", pos=30)]
diff --git a/tests/unit/line_arg_parser/test_visitors.py b/tests/unit/line_arg_parser/test_visitors.py
@@ -17,15 +17,13 @@
 
 @pytest.fixture
 def base_visitor():
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.visitors import (
-        NodeVisitor,
-    )
+    from google.cloud.bigquery.magics.line_arg_parser.visitors import NodeVisitor
 
     return NodeVisitor()
 
 
 def test_unknown_node(base_visitor):
-    from google.cloud.bigquery.ipython_magics.line_arg_parser.parser import ParseNode
+    from google.cloud.bigquery.magics.line_arg_parser.parser import ParseNode
 
     class UnknownNode(ParseNode):
         pass
diff --git a/tests/unit/test_magics.py b/tests/unit/test_magics.py
