{ "cells": [ { "cell_type": "code", "execution_count": 38, "id": "f0b47680", "metadata": {}, "outputs": [], "source": [ "%%capture\n", "%load_ext autoreload\n", "%autoreload 2" ] }, { "cell_type": "code", "execution_count": 39, "id": "989dbd8c", "metadata": {}, "outputs": [], "source": [ "#| default_exp: config" ] }, { "cell_type": "markdown", "id": "983c3e1a", "metadata": {}, "source": [ "# Config\n", "\n", "> Reading configuration for `nb`" ] }, { "cell_type": "code", "execution_count": 40, "id": "5006bc03", "metadata": {}, "outputs": [], "source": [ "#| export\n", "import dataclasses\n", "import os\n", "import tomllib\n", "from pathlib import Path\n", "\n", "from nb.core import patch" ] }, { "cell_type": "code", "execution_count": 41, "id": "645d4349", "metadata": {}, "outputs": [], "source": [ "from tempfile import TemporaryDirectory\n", "from nb import test" ] }, { "cell_type": "code", "execution_count": 42, "id": "c282bbbc", "metadata": {}, "outputs": [], "source": [ "#| export\n", "def config_path(curdir:str|Path='.')->Path|None:\n", " \"Find the pyproject.toml configuration file by traversing dirs until the root of the file system.\"\n", " path = os.path.abspath(curdir)\n", " while path != os.path.dirname(path):\n", " if 'pyproject.toml' in os.listdir(path):\n", " return Path(path + '/pyproject.toml')\n", " path = os.path.dirname(path)" ] }, { "cell_type": "code", "execution_count": 43, "id": "6c5c3460", "metadata": {}, "outputs": [], "source": [ "with TemporaryDirectory() as tmp:\n", " test.equal(config_path(tmp), None)" ] }, { "cell_type": "code", "execution_count": 44, "id": "7363f5ed", "metadata": {}, "outputs": [], "source": [ "with TemporaryDirectory() as tmp:\n", " p = Path(tmp)/'pyproject.toml'\n", " p.touch()\n", " test.equal(config_path(tmp), p)" ] }, { "cell_type": "code", "execution_count": 45, "id": "89f6f072", "metadata": {}, "outputs": [], "source": [ "#| export\n", "def config_dir(curdir:str|Path='.')->Path|None:\n", " return Path(curdir).parent if config_path(curdir) is not None else None" ] }, { "cell_type": "code", "execution_count": 46, "id": "73f36540", "metadata": {}, "outputs": [ { "ename": "AssertionError", "evalue": "config_dir(tmp) != Path(tmp)\n where config_dir(tmp) = PosixPath('/v...dmcw0000gn/T')\n where Path(tmp) = PosixPath('/v.../tmp3p23_l6_')", "output_type": "error", "traceback": [ "\u001b[31m---------------------------------------------------------------------------\u001b[39m", "\u001b[31mAssertionError\u001b[39m Traceback (most recent call last)", "\u001b[36mCell\u001b[39m\u001b[36m \u001b[39m\u001b[32mIn[46]\u001b[39m\u001b[32m, line 4\u001b[39m\n\u001b[32m 1\u001b[39m \u001b[38;5;28;01mwith\u001b[39;00m TemporaryDirectory() \u001b[38;5;28;01mas\u001b[39;00m tmp:\n\u001b[32m 2\u001b[39m p = Path(tmp)/\u001b[33m'pyproject.toml'\u001b[39m\n\u001b[32m 3\u001b[39m p.touch()\n\u001b[32m----> \u001b[39m\u001b[32m4\u001b[39m test.equal(config_dir(tmp), Path(tmp))\n", "\u001b[36mFile \u001b[39m\u001b[32m~/src/nb/nb/test.py:87\u001b[39m, in \u001b[36mequal\u001b[39m\u001b[34m(a, b)\u001b[39m\n\u001b[32m 85\u001b[39m \u001b[38;5;28;01mdef\u001b[39;00m\u001b[38;5;250m \u001b[39m\u001b[34mequal\u001b[39m(a, b):\n\u001b[32m 86\u001b[39m \u001b[33m\"\u001b[39m\u001b[33mAssert that a == b.\u001b[39m\u001b[33m\"\u001b[39m\n\u001b[32m---> \u001b[39m\u001b[32m87\u001b[39m \u001b[30;43mexpect\u001b[39;49m\u001b[30;43m(\u001b[39;49m\u001b[30;43ma\u001b[39;49m\u001b[30;43m,\u001b[39;49m\u001b[30;43m \u001b[39;49m\u001b[30;43mb\u001b[39;49m\u001b[30;43m,\u001b[39;49m\u001b[30;43m \u001b[39;49m\u001b[30;43moperator\u001b[39;49m\u001b[30;43m.\u001b[39;49m\u001b[30;43meq\u001b[39;49m\u001b[30;43m,\u001b[39;49m\u001b[30;43m \u001b[39;49m\u001b[30;43mnegstr\u001b[39;49m\u001b[30;43m=\u001b[39;49m\u001b[30;43m'\u001b[39;49m\u001b[30;43m!=\u001b[39;49m\u001b[30;43m'\u001b[39;49m\u001b[30;43m,\u001b[39;49m\u001b[30;43m \u001b[39;49m\u001b[30;43mframes_up\u001b[39;49m\u001b[30;43m=\u001b[39;49m\u001b[30;43m2\u001b[39;49m\u001b[30;43m)\u001b[39;49m\n", "\u001b[36mFile \u001b[39m\u001b[32m~/src/nb/nb/test.py:77\u001b[39m, in \u001b[36mexpect\u001b[39m\u001b[34m(a, b, cmp, negstr, frames_up, truncate)\u001b[39m\n\u001b[32m 75\u001b[39m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mlen\u001b[39m(args_src) > \u001b[32m0\u001b[39m \u001b[38;5;129;01mand\u001b[39;00m a_repr != args_src[\u001b[32m0\u001b[39m]: lines.append(\u001b[33mf\u001b[39m\u001b[33m'\u001b[39m\u001b[33m where \u001b[39m\u001b[38;5;132;01m{\u001b[39;00margs_src[\u001b[32m0\u001b[39m]\u001b[38;5;132;01m}\u001b[39;00m\u001b[33m = \u001b[39m\u001b[38;5;132;01m{\u001b[39;00ma_repr\u001b[38;5;132;01m}\u001b[39;00m\u001b[33m'\u001b[39m)\n\u001b[32m 76\u001b[39m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mlen\u001b[39m(args_src) > \u001b[32m1\u001b[39m \u001b[38;5;129;01mand\u001b[39;00m b_repr != args_src[\u001b[32m1\u001b[39m]: lines.append(\u001b[33mf\u001b[39m\u001b[33m'\u001b[39m\u001b[33m where \u001b[39m\u001b[38;5;132;01m{\u001b[39;00margs_src[\u001b[32m1\u001b[39m]\u001b[38;5;132;01m}\u001b[39;00m\u001b[33m = \u001b[39m\u001b[38;5;132;01m{\u001b[39;00mb_repr\u001b[38;5;132;01m}\u001b[39;00m\u001b[33m'\u001b[39m)\n\u001b[32m---> \u001b[39m\u001b[32m77\u001b[39m \u001b[38;5;28;01massert\u001b[39;00m cmp(a, b), \u001b[33m\"\u001b[39m\u001b[38;5;130;01m\\n\u001b[39;00m\u001b[33m\"\u001b[39m.join(lines)\n", "\u001b[31mAssertionError\u001b[39m: config_dir(tmp) != Path(tmp)\n where config_dir(tmp) = PosixPath('/v...dmcw0000gn/T')\n where Path(tmp) = PosixPath('/v.../tmp3p23_l6_')" ] } ], "source": [ "with TemporaryDirectory() as tmp:\n", " p = Path(tmp)/'pyproject.toml'\n", " p.touch()\n", " test.equal(config_dir(tmp), Path(tmp))" ] }, { "cell_type": "code", "execution_count": null, "id": "0948469f", "metadata": {}, "outputs": [], "source": [ "#| export\n", "@dataclasses.dataclass\n", "class Config:\n", " nb_dir:str|Path|None\n", " export_dir:str|Path|None" ] }, { "cell_type": "code", "execution_count": null, "id": "311895a2", "metadata": {}, "outputs": [], "source": [ "#| export\n", "def config_defaults(base_dir:Path)->dict:\n", " return {'nb_dir': base_dir/Path('nbs'), 'export_dir': base_dir/Path('.')}" ] }, { "cell_type": "code", "execution_count": null, "id": "b2c35e58", "metadata": {}, "outputs": [], "source": [ "with TemporaryDirectory() as tmp:\n", " test.equal(config_defaults(Path(tmp)), {'nb_dir': Path(tmp)/Path('nbs'), 'export_dir': Path(tmp)})" ] }, { "cell_type": "code", "execution_count": null, "id": "6b811084", "metadata": {}, "outputs": [], "source": [ "#| export\n", "@patch\n", "def default(cls:type[Config], base_dir:Path)->Config:\n", " return cls(**config_defaults(base_dir))" ] }, { "cell_type": "code", "execution_count": null, "id": "667948b3", "metadata": {}, "outputs": [], "source": [ "#| export\n", "@patch\n", "def empty(cls:type[Config])->Config:\n", " return cls(**{f.name:None for f in dataclasses.fields(cls)})" ] }, { "cell_type": "code", "execution_count": null, "id": "97fc77c3", "metadata": {}, "outputs": [], "source": [ "empty = Config.empty()\n", "test.equal(empty, Config(nb_dir=None, export_dir=None))" ] }, { "cell_type": "code", "execution_count": null, "id": "d95dafba", "metadata": {}, "outputs": [], "source": [ "#| export\n", "@patch\n", "def from_dict(cls:type[Config], d:dict, base_dir:Path)->Config:\n", " d = config_defaults(base_dir) | d\n", " fields = {f.name for f in dataclasses.fields(cls)}\n", " extra = d.keys() - fields\n", " if extra: raise ValueError(f\"Unknown config keys: {extra}\")\n", " return cls(**d)" ] }, { "cell_type": "code", "execution_count": null, "id": "2217ca78", "metadata": {}, "outputs": [], "source": [ "with test.raises(exc=ValueError, contains=\"Unknown config keys: {'abc'}\"):\n", " Config.from_dict({'abc': 123}, base_dir=Path('.'))" ] }, { "cell_type": "code", "execution_count": null, "id": "ed87dda5", "metadata": {}, "outputs": [], "source": [ "test.equal(Config.from_dict({}, base_dir=Path('.')), Config.default(base_dir=Path('.')))" ] }, { "cell_type": "code", "execution_count": null, "id": "7b2800d5", "metadata": {}, "outputs": [], "source": [ "_d = {'nb_dir': 'abc'}\n", "test.equal(Config.from_dict(_d, base_dir=Path('.')), Config(**(config_defaults(Path('.')) | _d)))" ] }, { "cell_type": "code", "execution_count": null, "id": "00ceaa67", "metadata": {}, "outputs": [], "source": [ "#| export\n", "def get_config(curdir:str|Path='.')->Config:\n", " p = config_path(curdir)\n", " if not p: return Config.empty()\n", " nb = tomllib.loads(p.read_text()).get('tool', {}).get('nb', {})\n", " return Config.from_dict(nb, base_dir=p.parent)" ] }, { "cell_type": "code", "execution_count": null, "id": "bee6bc66", "metadata": {}, "outputs": [], "source": [ "with TemporaryDirectory() as tmp:\n", " test.equal(get_config(tmp), Config.empty())" ] }, { "cell_type": "code", "execution_count": null, "id": "f0084313", "metadata": {}, "outputs": [], "source": [ "with TemporaryDirectory() as tmp:\n", " p = Path(tmp)/'pyproject.toml'\n", " p.touch()\n", " test.equal(get_config(tmp), Config.default(tmp))" ] }, { "cell_type": "code", "execution_count": null, "id": "502bec22", "metadata": {}, "outputs": [], "source": [ "with TemporaryDirectory() as tmp:\n", " p = Path(tmp)/'pyproject.toml'\n", " p.write_text('[tool.nb]')\n", " test.equal(get_config(tmp), Config.default(tmp))" ] }, { "cell_type": "code", "execution_count": null, "id": "2a47c918", "metadata": {}, "outputs": [], "source": [ "with (\n", " test.raises(exc=ValueError, contains=\"Unknown config keys: {'dir'}\"),\n", " TemporaryDirectory() as tmp\n", "):\n", " p = Path(tmp)/'pyproject.toml'\n", " p.write_text('[tool.nb]\\ndir=1')\n", " get_config(tmp)" ] }, { "cell_type": "code", "execution_count": null, "id": "552b4e70", "metadata": {}, "outputs": [], "source": [ "with TemporaryDirectory() as tmp:\n", " p = Path(tmp)/'pyproject.toml'\n", " p.write_text('[tool.nb]\\nnb_dir=\"abc/test\"')\n", " test.equal(get_config(tmp), Config.from_dict({'nb_dir': 'abc/test'}, tmp))" ] }, { "cell_type": "code", "execution_count": null, "id": "7d6ee6fa", "metadata": {}, "outputs": [], "source": [ "import nb; nb.export_nb('config.ipynb', src_dir='../nb')" ] } ], "metadata": { "kernelspec": { "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.14.4" } }, "nbformat": 4, "nbformat_minor": 5 }