Merge pull request #48 from agoose77/agoose77/feat-simplify-local-package

feat: simplify developing against local notebooks

Author: agoose77

src/literary/hook/__init__.ipynb

@@ -46,7 +46,7 @@
     "import sys\n",
     "import traceback\n",
     "\n",
-    "from .finder import extend_file_finder, install_ipykernel_restrictor"
+    "from .finder import extend_file_finder"
    ]
   },
   {
@@ -143,10 +143,7 @@
    },
    "outputs": [],
    "source": [
-    "def install_import_hook(set_except_hook=True, restrict_ipykernel_path=True):\n",
-    "    if restrict_ipykernel_path:\n",
-    "        install_ipykernel_restrictor()\n",
-    "\n",
+    "def install_import_hook(set_except_hook=True):\n",
     "    extend_file_finder(\n",
     "        (notebook_loader_factory, [\".ipynb\"]),\n",
     "    )\n",

src/literary/hook/finder.ipynb

@@ -91,129 +91,6 @@
     "    # To fix cached path finders\n",
     "    sys.path_importer_cache.clear()"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "6dd8802c-5265-4e1e-b520-c1fb5855bf26",
-   "metadata": {
-    "editable": true,
-    "slideshow": {
-     "slide_type": ""
-    },
-    "tags": []
-   },
-   "source": [
-    "We will want to lazily load the notebook loader factory so that the Python startup is not adversely affected by importing nbconvert et al. However, IPyKernel puts the working directory on the `sys.path` by default, which causes problems if any notebooks shadow built-in packages. Although this also holds for regular Python files in the working directory, in practice this behaviour is not desirable, so we choose to (opt-out) remove the working directory from the path using a meta path finder."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "ee0b40e3-cbea-4d11-9a32-75c7bc510844",
-   "metadata": {
-    "editable": true,
-    "slideshow": {
-     "slide_type": ""
-    },
-    "tags": [
-     "export"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "class IPyKernelPathRestrictor:\n",
-    "    ...    "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "daf09e61-74ff-4b3f-aaad-6994a8ff5460",
-   "metadata": {
-    "editable": true,
-    "slideshow": {
-     "slide_type": ""
-    },
-    "tags": [
-     "export"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "@patch(IPyKernelPathRestrictor)\n",
-    "@classmethod\n",
-    "def remove_cwd_from_sys_path(cls):\n",
-    "    cwd = os.path.realpath(os.getcwd())\n",
-    "    # TODO: should this only remove the first instance?\n",
-    "    sys.path = [p for p in sys.path if os.path.realpath(p) != cwd]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "2e493732-a88d-43fb-9d03-a291e3d5c1f4",
-   "metadata": {
-    "editable": true,
-    "slideshow": {
-     "slide_type": ""
-    },
-    "tags": [
-     "export"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "@patch(IPyKernelPathRestrictor)\n",
-    "@classmethod\n",
-    "def find_spec(cls, fullname, path=None, target=None):\n",
-    "    if \".\" in fullname:\n",
-    "        return None\n",
-    "\n",
-    "    # IPython controls the kernel startup including its path\n",
-    "    # The user cannot easily modify this. \n",
-    "    # Instead, we wait for an ipykernel import event to trigger this logic to clean up \n",
-    "    # during initialisation, to avoid problems of name shadowing in the cwd\n",
-    "    name = fullname.split(\".\", 1)[0]\n",
-    "    if name == \"ipykernel\":\n",
-    "        cls.remove_cwd_from_sys_path()\n",
-    "\n",
-    "    return None"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "24ff552e-f91a-4a96-b870-304e1008e648",
-   "metadata": {
-    "editable": true,
-    "slideshow": {
-     "slide_type": ""
-    },
-    "tags": []
-   },
-   "source": [
-    "Let's make a dedicated installer for this"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "731fec98-b411-4676-8975-a407e785d1d8",
-   "metadata": {
-    "tags": [
-     "export"
-    ]
-   },
-   "outputs": [],
-   "source": [
-    "def install_ipykernel_restrictor():\n",
-    "    for i, finder in enumerate(sys.meta_path):\n",
-    "        if finder is PathFinder:\n",
-    "            break\n",
-    "    else:\n",
-    "        return\n",
-    "\n",
-    "    sys.meta_path.insert(i, IPyKernelPathRestrictor)"
-   ]
   }
  ],
  "metadata": {

src/literary/module/__init__.ipynb

@@ -273,11 +273,8 @@
     "            f\"Couldn't determine the package name for the current working directory {cwd}. \"\n",
     "            f\"This might be because the current project has not been installed in editable mode.\"\n",
     "        )\n",
-    "        # Allow local absolute imports\n",
-    "        sys.path.append(str(cwd))\n",
     "    else:\n",
     "        # Packages don't have absolute imports\n",
-    "        # This should already have been done by the import hook, but let's guarantee\n",
     "        sys.path = [p for p in sys.path if Path(p).resolve() != cwd]\n",
     "\n",
     "    # Set `__package__` for consumer notebook\n",

src/literary/notebook/__init__.ipynb

@@ -98,9 +98,6 @@
     "    # inside a notebook, so even though we don't need to use the config, we load it anyway\n",
     "    config = load_literary_config(find_literary_config(cwd))\n",
     "\n",
-    "    # Allow local absolute imports\n",
-    "    sys.path.append(str(cwd))\n",
-    "\n",
     "    ipython.user_ns.update(\n",
     "        {\n",
     "            \"patch\": patch,\n",