ipyk-unlock 0.1.1__py3-none-any.whl

ipyk_unlock/__init__.py

@@ -0,0 +1,6 @@
+__version__ = "0.1.1"
+
+
+from .kernelapp import UnlockKernelApp, launch_new_instance
+from .unlock_kernel import UnlockKernel
+

ipyk_unlock/kernelapp.py

@@ -0,0 +1,9 @@
+from ipykernel.kernelapp import IPKernelApp
+from traitlets import Type
+
+class UnlockKernelApp(IPKernelApp):
+    kernel_class = Type("ipyk_unlock.unlock_kernel.UnlockKernel", klass="ipykernel.kernelbase.Kernel",
+                        help="Kernel subclass used by this launcher.").tag(config=True)
+    subcommands = {"install": ("ipyk_unlock.kernelspec.InstallUnlockKernelSpecApp", "Install the Unlock kernel")}
+
+launch_new_instance = UnlockKernelApp.launch_instance

ipyk_unlock/kernelspec.py

@@ -0,0 +1,69 @@
+import errno
+import platform
+import shutil
+import sys
+
+from ipykernel import kernelspec as ipks
+from jupyter_client.kernelspec import KernelSpecManager
+from traitlets import Unicode
+
+KERNEL_NAME = f"{ipks.KERNEL_NAME}-unlock"
+DISPLAY_NAME = f"Python {sys.version_info[0]} (unlock)"
+
+def install(kernel_spec_manager: KernelSpecManager | None = None, user: bool = False, kernel_name: str = KERNEL_NAME,
+            display_name: str | None = None, prefix: str | None = None, profile: str | None = None,
+            env: dict[str, str] | None = None, frozen_modules: bool = False) -> str:
+    if kernel_spec_manager is None: kernel_spec_manager = KernelSpecManager()
+    if env is None: env = {}
+    if kernel_name != KERNEL_NAME and display_name is None: display_name = kernel_name
+
+    overrides = dict(display_name=display_name or DISPLAY_NAME, argv=ipks.make_ipkernel_cmd(mod="ipyku_launcher"))
+    extra_arguments = ["--profile", profile] if profile else None
+
+    if extra_arguments:
+        overrides["argv"] = ipks.make_ipkernel_cmd(mod="ipyku_launcher", extra_arguments=extra_arguments)
+        if display_name is None: overrides["display_name"] = "Python %i [profile=%s] (unlock)" % (sys.version_info[0], profile)
+
+    if sys.version_info >= (3, 11) and platform.python_implementation() == "CPython":
+        if not frozen_modules:
+            overrides["argv"] = ipks.make_ipkernel_cmd(mod="ipyku_launcher", extra_arguments=extra_arguments,
+                                                       python_arguments=["-Xfrozen_modules=off"])
+        elif "PYDEVD_DISABLE_FILE_VALIDATION" not in env: env["PYDEVD_DISABLE_FILE_VALIDATION"] = "1"
+
+    if env: overrides["env"] = env
+    path = ipks.write_kernel_spec(overrides=overrides)
+    dest = kernel_spec_manager.install_kernel_spec(path, kernel_name=kernel_name, user=user, prefix=prefix)
+    shutil.rmtree(path)
+    return dest
+
+
+class InstallUnlockKernelSpecApp(ipks.InstallIPythonKernelSpecApp):
+    name = Unicode("ipyku-kernel-install")
+
+    def start(self) -> None:
+        import argparse
+
+        parser = argparse.ArgumentParser(prog=self.name, description="Install the Unlock kernel spec.")
+        parser.add_argument("--user", action="store_true", help="Install for the current user instead of system-wide")
+        parser.add_argument("--name", type=str, default=KERNEL_NAME,
+                            help="Specify a name for the kernelspec. This is needed to have multiple kernels.")
+        parser.add_argument("--display-name", type=str, help="Specify the display name for the kernelspec.")
+        parser.add_argument("--profile", type=str, help="Specify an IPython profile to load.")
+        parser.add_argument("--prefix", type=str, help="Specify an install prefix for the kernelspec.")
+        parser.add_argument("--sys-prefix", action="store_const", const=sys.prefix, dest="prefix",
+                            help="Install to Python's sys.prefix.")
+        parser.add_argument("--env", action="append", nargs=2, metavar=("ENV", "VALUE"),
+                            help="Set environment variables for the kernel.")
+        parser.add_argument("--frozen_modules", action="store_true", help="Enable frozen modules for faster startup.")
+        opts = parser.parse_args(self.argv)
+        if opts.env: opts.env = dict(opts.env)
+        try:
+            dest = install(user=opts.user, kernel_name=opts.name, profile=opts.profile, prefix=opts.prefix,
+                           display_name=opts.display_name, env=opts.env, frozen_modules=opts.frozen_modules)
+        except OSError as e:
+            if e.errno == errno.EACCES:
+                print(e, file=sys.stderr)
+                if opts.user: print("Perhaps you want `sudo` or `--user`?", file=sys.stderr)
+                self.exit(1)
+            raise
+        print(f"Installed kernelspec {opts.name} in {dest}")

ipyk_unlock/unlock_kernel.py

@@ -0,0 +1,16 @@
+from ipykernel.ipkernel import IPythonKernel
+import contextlib
+from . import __version__
+
+class UnlockKernel(IPythonKernel):
+    implementation = "unlock-kernel"
+    implementation_version = __version__
+    language = "python"
+    language_version = "3.x"
+    language_info = dict(name="python", mimetype="text/x-python",
+                         file_extension=".py", nbconvert_exporter="python")
+    banner = "Unlock kernel"
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._main_asyncio_lock = contextlib.nullcontext()

ipyk_unlock-0.1.1.dist-info/METADATA

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: ipyk-unlock
+Version: 0.1.1
+Summary: Minimal custom ipykernel launcher using a custom kernel subclass
+Project-URL: Homepage, https://github.com/fastai/ipyk-unlock
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: ipykernel>=7.1
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: fastship>=0.0.6; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=5.0.0; extra == "dev"
+
+# ipyk-unlock
+
+Minimal custom `ipykernel` launcher that swaps in `ipyk_unlock.unlock_kernel.UnlockKernel`.
+
+## Run
+
+```bash
+python -m ipyku_launcher -f /path/to/connection.json
+```
+
+## Install kernelspec
+
+```bash
+python -m ipyku_launcher install --sys-prefix
+```
+
+Default kernelspec name is `python3-unlock` (on Python 3).
+
+## Install (local)
+
+```bash
+pip install -e .
+```
+
+For release tooling:
+
+```bash
+pip install -e .[dev]
+```
+
+## Use in a kernelspec
+
+Set `argv` in `kernel.json` to:
+
+```json
+["python", "-m", "ipyku_launcher", "-f", "{connection_file}"]
+```
+

ipyk_unlock-0.1.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+ipyku_launcher.py,sha256=NT0Q15g38eGQGAhYPNU9Ar1O-eePBILBJg66Qa9f-HE,411
+ipyk_unlock/__init__.py,sha256=jZj21dSYQnFUE7VLVWjrTz9_lDA7p_B4-JRklgZS3ok,125
+ipyk_unlock/kernelapp.py,sha256=GXjkPhyk2F6N4zmqQuCUnhsJJVOxBOqJJIpnKjnNzmc,468
+ipyk_unlock/kernelspec.py,sha256=VvPAS8WvGeViHCjAKtmc8_qJPVsfBCoVWPFnouVPl34,3854
+ipyk_unlock/unlock_kernel.py,sha256=l5u8YHW34z0OEDDb7FG69duUE4dJ7_5DM-atXZaOWus,570
+ipyk_unlock-0.1.1.dist-info/METADATA,sha256=ocKg2fxA55I6-yOJWJm-Q7WxGBVNkMUF2TBwCJ5Q5HE,1040
+ipyk_unlock-0.1.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+ipyk_unlock-0.1.1.dist-info/entry_points.txt,sha256=QIXY9X4Dqs-uWqin_zloGx5rvATs4-DcM5u1OTm1djo,55
+ipyk_unlock-0.1.1.dist-info/top_level.txt,sha256=cT4vDFhvsHlFRCs2lGq3E6QpPCGhyfWfC1PO4FCSWCc,27
+ipyk_unlock-0.1.1.dist-info/RECORD,,

ipyk_unlock-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ipyk_unlock-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ipyku-launcher = ipyku_launcher:main

ipyk_unlock-0.1.1.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+ipyk_unlock
+ipyku_launcher

ipyku_launcher.py

@@ -0,0 +1,18 @@
+"""
+Entry point for launching an IPython kernel.
+
+This is separate from the ipykernel package so we can avoid doing imports until
+after removing the cwd from sys.path.
+"""
+
+import sys
+from pathlib import Path
+
+
+def main():
+    if sys.path[0] == "" or Path(sys.path[0]) == Path.cwd(): del sys.path[0]
+    from ipyk_unlock import kernelapp as app
+    app.launch_new_instance()
+
+
+if __name__ == "__main__": main()