update for jlab3

Author: ianhi

.gitignore

@@ -3,6 +3,7 @@ lib/
 node_modules/
 *.egg-info/
 .ipynb_checkpoints
+jupyterlab_code_formatter/labextension
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -21,3 +22,24 @@ venv/
 build/
 
 **/dist/
+
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+.installed.cfg
+*.egg
+MANIFEST

MANIFEST.in

@@ -1 +1,23 @@
 include LICENSE
+include README.md
+include pyproject.toml
+include jupyter-config/jupyterlab_code_formatter.json
+
+include package.json
+include install.json
+include ts*.json
+
+graft jupyterlab_code_formatter/labextension
+
+# Javascript files
+graft src
+graft style
+prune **/node_modules
+prune lib
+
+# Patterns to exclude from any directory
+global-exclude *~
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude .git
+global-exclude .ipynb_checkpoints

Makefile

@@ -19,34 +19,20 @@ conda-freeze:  ## Use conda to freeze the current env available
 conda-install-frozen:  ## Use conda to install dev dependencies using pinned env specification - subject to repodata.json changes
 	conda env create -f environment-frozen.yml --force --name jupyterlab-code-formatter
 
-dev-install-serverextension:  ## Use pip to install the server extension in dev mode
-	pip install -e serverextension
-	jupyter serverextension enable --py jupyterlab_code_formatter
-
-dev-install-labextension:  ## Use npm to install the lab extension in dev mode
-	cd $(LABEXTENSION_PATH)
-	npm install
-	npm run build
-	jupyter labextension link .
-	cd -
-
-dev-install: dev-install-serverextension dev-install-labextension  ## Install both lab and server extension in dev mode
+dev-install:
+	pip install -e .
+	jupyter labextension develop . --overwrite
+	jlpm run build
 
 dev-watch-labextension:  ## Recompile labextension on changes
-	cd $(LABEXTENSION_PATH)
 	npm run watch
 
-dev-watch-jupyterlab:  ## Start jupyterlab under watch mode
-	jupyter lab --watch
-
 lint:  # Run linters
-	find serverextension/jupyterlab_code_formatter -name '*.py' | xargs black --check
-	cd $(LABEXTENSION_PATH)
+	find jupyterlab_code_formatter -name '*.py' | xargs black --check
 	npm run lint
 
 format:  # Run formatters
-	find serverextension/jupyterlab_code_formatter -name '*.py' | xargs black
-	cd $(LABEXTENSION_PATH)
+	find jupyterlab_code_formatter -name '*.py' | xargs black
 	npm run format
 
 test:  # Run test

install.json

@@ -0,0 +1,5 @@
+{
+  "packageManager": "python",
+  "packageName": "jupyterlab-code-formatter",
+  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package jupyterlab-code-formatter"
+}

jupyter-config/jupyterlab-code-formatter.json

@@ -0,0 +1,7 @@
+{
+  "ServerApp": {
+    "jpserver_extensions": {
+      "jupyterlab-code-formatter": true
+    }
+  }
+}

jupyterlab_code_formatter/__init__.py

@@ -0,0 +1,29 @@
+import json
+import os.path as osp
+
+from .handlers import setup_handlers
+from ._version import __version__
+
+HERE = osp.abspath(osp.dirname(__file__))
+
+with open(osp.join(HERE, "labextension", "package.json")) as fid:
+    data = json.load(fid)
+
+
+def _jupyter_labextension_paths():
+    return [{"src": "labextension", "dest": data["name"]}]
+
+
+def _jupyter_server_extension_paths():
+    return [{"module": "jupyterlab_code_formatter"}]
+
+
+def _load_jupyter_server_extension(server_app):
+    """Registers the API handler to receive HTTP requests from the frontend extension.
+
+    Parameters
+    ----------
+    lab_app: jupyterlab.labapp.LabApp
+        JupyterLab application instance
+    """
+    setup_handlers(server_app.web_app)

jupyterlab_code_formatter/_version.py

@@ -0,0 +1,20 @@
+__all__ = ["__version__"]
+
+
+def _fetchVersion():
+    import json
+    import os
+
+    HERE = os.path.abspath(os.path.dirname(__file__))
+
+    for d, _, _ in os.walk(HERE):
+        try:
+            with open(os.path.join(d, "package.json")) as f:
+                return json.load(f)["version"]
+        except FileNotFoundError:
+            pass
+
+    raise FileNotFoundError("Could not find package.json under dir {}".format(HERE))
+
+
+__version__ = _fetchVersion()

serverextension/jupyterlab_code_formatter/formatters.py renamed to jupyterlab_code_formatter/formatters.py

@@ -1,11 +1,13 @@
 import json
+
+from jupyter_server.base.handlers import APIHandler
+from jupyter_server.utils import url_path_join
+
 import pkg_resources
 
 from notebook.notebookapp import NotebookWebApplication
-from notebook.utils import url_path_join
-from notebook.base.handlers import APIHandler
 
-from jupyterlab_code_formatter.formatters import SERVER_FORMATTERS
+from .formatters import SERVER_FORMATTERS
 
 
 def setup_handlers(web_app: NotebookWebApplication) -> None:

serverextension/jupyterlab_code_formatter/handlers.py renamed to jupyterlab_code_formatter/handlers.py

@@ -29,7 +29,11 @@ def _generate_list_formaters_entry_json_schema(
 
 EXPECTED_VERSION_SCHEMA = {
     "type": "object",
-    "properties": {"version": {"type": "string",}},
+    "properties": {
+        "version": {
+            "type": "string",
+        }
+    },
 }
 
 EXPECTED_LIST_FORMATTERS_SCHEMA = {
@@ -157,7 +161,9 @@ def test_can_handle_magic(self):
         expected = '%%timeit\nsome_string = "abc"'
         for formatter in ["black", "yapf", "isort"]:
             response = self._format_code_request(
-                formatter=formatter, code=[given], options={},
+                formatter=formatter,
+                code=[given],
+                options={},
             )
             json_result = self._check_http_200_and_schema(response)
             assert json_result["code"][0]["code"] == expected
@@ -168,7 +174,9 @@ def test_can_handle_shell_cmd(self):
         expected = '%%timeit\nsome_string = "abc"\n!pwd'
         for formatter in ["black", "yapf", "isort"]:
             response = self._format_code_request(
-                formatter=formatter, code=[given], options={},
+                formatter=formatter,
+                code=[given],
+                options={},
             )
             json_result = self._check_http_200_and_schema(response)
             assert json_result["code"][0]["code"] == expected
@@ -177,7 +185,9 @@ def test_can_use_styler(self):
         given = "a = 3; 2"
         expected = "a <- 3\n2"
         response = self._format_code_request(
-            formatter="styler", code=[given], options={"scope": "tokens"},
+            formatter="styler",
+            code=[given],
+            options={"scope": "tokens"},
         )
         json_result = self._check_http_200_and_schema(response)
         assert json_result["code"][0]["code"] == expected
@@ -194,7 +204,9 @@ def test_can_use_styler_2(self):
   large  = 6
 )"""
         response = self._format_code_request(
-            code=[given], options={"strict": False}, formatter="styler",
+            code=[given],
+            options={"strict": False},
+            formatter="styler",
         )
         json_result = self._check_http_200_and_schema(response)
         assert json_result["code"][0]["code"] == expected
@@ -278,7 +290,10 @@ def test_422_on_mismatch_version_1(self):
         assert response.status_code == 422
 
     def test_200_on_version_without_header(self):
-        response = self.request(verb="GET", path="/jupyterlab_code_formatter/version",)
+        response = self.request(
+            verb="GET",
+            path="/jupyterlab_code_formatter/version",
+        )
         assert response.status_code == 200
         validate(instance=response.json(), schema=EXPECTED_VERSION_SCHEMA)