aboutsummaryrefslogtreecommitdiffstats
path: root/nbs/core.ipynb
blob: b3f58f4dc5423549c40d8e7485be407210e7ea9d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "aed9daa9-f05d-4e25-b9a5-a74d0211ef6f",
   "metadata": {},
   "outputs": [],
   "source": [
    "%%capture\n",
    "%load_ext autoreload\n",
    "%autoreload 2"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "596de171-5567-43c1-98ce-66eccc28bbe9",
   "metadata": {},
   "outputs": [],
   "source": [
    "#| default_exp: core"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "6a2cc7f8-6c65-4a7c-890c-3cf9d1cd314e",
   "metadata": {},
   "outputs": [],
   "source": [
    "#| export\n",
    "import inspect\n",
    "from typing import Callable"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "bbaf531f",
   "metadata": {},
   "outputs": [],
   "source": [
    "from nb import test"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "8485c16a",
   "metadata": {},
   "source": [
    "# Core\n",
    "> Fundamental Utilities"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "2b6822dd",
   "metadata": {},
   "source": [
    "## Function Utilities"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "c4875cc0-2d87-4c87-8789-7dc950be06c6",
   "metadata": {},
   "outputs": [],
   "source": [
    "#| export\n",
    "def callable_name(c: Callable) -> str:\n",
    "    \"Get the name of the callable `c`.\"\n",
    "    return getattr(c, '__name__', c.__class__.__name__)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "406d605d",
   "metadata": {},
   "source": [
    "This works for any function:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "0e9c39c5",
   "metadata": {},
   "outputs": [],
   "source": [
    "assert callable_name(max) == \"max\""
   ]
  },
  {
   "cell_type": "markdown",
   "id": "d66b2d42",
   "metadata": {},
   "source": [
    "And for any classes:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "056cb776",
   "metadata": {},
   "outputs": [],
   "source": [
    "class _A: pass\n",
    "assert callable_name(_A) == \"_A\""
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "f2c70dd3",
   "metadata": {},
   "outputs": [],
   "source": [
    "#| export\n",
    "def pubattr(o):\n",
    "    \"Retrieve the public attributes of the object `o`.\"\n",
    "    return [a for a in dir(o) if not a.startswith('_')]"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "53cb2bd5",
   "metadata": {},
   "source": [
    "`pubattr` will hide any attribute on an object if it starts with an underscore."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "ac30af03",
   "metadata": {},
   "outputs": [],
   "source": [
    "_A.print = print\n",
    "_A._private_print = print\n",
    "_A.__python_internal__ = print\n",
    "assert pubattr(_A) == [\"print\"]"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f892f4f1",
   "metadata": {},
   "source": [
    "## Class Definitions"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "4008335c",
   "metadata": {},
   "source": [
    "Iterative notebook-driven development makes class definitions tricky. Typically, you'd write a clas definition in one monolithic block, which leaves no room for prose or incremental execution. Inspired by the wonderful [fastcore](https://github.com/AnswerDotAI/fastcore) library, we'll add `patch` and `patch_to` function to enable piecemeal class definition via monkeypatching."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "78d61a07",
   "metadata": {},
   "outputs": [],
   "source": [
    "#| export\n",
    "def patch_to(\n",
    "    o:object,                 # The object to patch.\n",
    "    cls_method:bool=False,    # Patch the decorated function to `o` as a classmethod\n",
    "    static_method:bool=False, # Patch the decorated function to `o` as a staticmethod\n",
    "    prop:bool=False,          # Patch the decorated function to `o` as a property\n",
    ")->Callable:\n",
    "    \"Decorator that takes in a object and attaches the decorated function onto it.\"\n",
    "    def inner(fn:Callable)->Callable:\n",
    "        nm = callable_name(fn)\n",
    "        if cls_method:    fn = classmethod(fn)\n",
    "        if static_method: fn = staticmethod(fn)\n",
    "        if prop:          fn = property(fn)\n",
    "        setattr(o, nm, fn)\n",
    "        return fn\n",
    "    return inner\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "0d4bb2e6",
   "metadata": {},
   "source": [
    "Let's try it out. We'll create a dummy class named `_T`."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "c67a3c29",
   "metadata": {},
   "outputs": [],
   "source": [
    "class _T: pass"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "b7d0a482",
   "metadata": {},
   "source": [
    "Now, we'll attach on a function to `_T` in a separate code cell."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "42580f8b",
   "metadata": {},
   "outputs": [],
   "source": [
    "@patch_to(_T)\n",
    "def say_hello(self: _T, name: str): return f'Hello, {name}'"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "0edc152b",
   "metadata": {},
   "source": [
    "`_T` should have a `say_hello` function on it. Let's confirm."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "404bd72f",
   "metadata": {},
   "outputs": [],
   "source": [
    "_t = _T()\n",
    "test.equal(_t.say_hello('eugene'), 'Hello, eugene')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "b9c102e7",
   "metadata": {},
   "source": [
    "We can also do this with class methods:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "f5eca4e3",
   "metadata": {},
   "outputs": [],
   "source": [
    "@patch_to(_T, cls_method=True)\n",
    "def say_good_morning(cls:_T): return 'Good morning'"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "3a52ddb4",
   "metadata": {},
   "outputs": [],
   "source": [
    "test.equal(_T.say_good_morning(), 'Good morning')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "29565467",
   "metadata": {},
   "source": [
    "And with static methods:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "da2e0279",
   "metadata": {},
   "outputs": [],
   "source": [
    "@patch_to(_T, static_method=True)\n",
    "def say_good_evening(): return 'Good evening'"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "d3802615",
   "metadata": {},
   "outputs": [],
   "source": [
    "test.equal(_T.say_good_evening(), 'Good evening')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "6e694762",
   "metadata": {},
   "source": [
    "And properties:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "be5a1f11",
   "metadata": {},
   "outputs": [],
   "source": [
    "@patch_to(_T, prop=True)\n",
    "def hi(self:_T): return 'hi'"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "d637ab8e",
   "metadata": {},
   "outputs": [],
   "source": [
    "test.equal(_T().hi, 'hi')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "4acd774c",
   "metadata": {},
   "source": [
    "That's neat and all but notice that `self: _T` and `@patch_to(_T)` are both two different ways to provide the same sort of information (attach this method onto `_T`).\n",
    "\n",
    "What if we could look at the type hint to determine which object to patch?\n",
    "\n",
    "We already have `patch_to`, so let's create a `patch` decorator. All we'll need to do inside `patch` is find the object to patch and call `patch_to`. If we assume the object we're patching will always be called `self` i.e. patching a class, then this should be easy-peasy."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "4eb650ab",
   "metadata": {},
   "outputs": [],
   "source": [
    "#| export\n",
    "def patch(\n",
    "    fn:Callable|None=None, # The function to patch onto the object specified via a `self` or `cls` type hint.\n",
    "    prop:bool=False,       # Whether to patch `fn` onto the `self` type hint as a property.\n",
    ")->Callable:               # The patched `fn`\n",
    "    \"\"\"Decorator to patch an object using type hints on `fn`.\n",
    "\n",
    "    `fn` must have either `self` or `cls` arguments present with a type hint.\n",
    "    - `self`: Created as either an instance method or property if `prop=True`.\n",
    "    - `cls`: Created as a class method\n",
    "\n",
    "    If `self` and `cls` is missing or `self` is missing with `prop=True`,\n",
    "    a ValueError is raised.\n",
    "    \"\"\"\n",
    "    def inner(fn:Callable)->Callable:\n",
    "        anno = inspect.get_annotations(fn)\n",
    "        if 'self' not in anno and prop: raise ValueError('Must have `self` argument with prop=True')\n",
    "        if 'self' in anno: return patch_to(anno['self'], prop=prop)(fn)\n",
    "        if 'cls' in anno:  return patch_to(anno['cls'], cls_method=True)(fn)\n",
    "        raise ValueError('Must have either `self` or `cls` argument when using patch')\n",
    "    if fn is not None: return inner(fn)  # @patch case, as opposed to @patch()\n",
    "    return inner"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "13272b5e",
   "metadata": {},
   "source": [
    "The one caveat is we can't easily support static methods because we naturally may have no arguments to investigate the type hints of to know which object to patch with static methods."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "97378af3",
   "metadata": {},
   "source": [
    "Let's see if we can try `patch` out now with our dummy `_T` class."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "601e27f2",
   "metadata": {},
   "outputs": [],
   "source": [
    "@patch\n",
    "def say_goodbye(self:_T, name): return f'Goodbye, {name}'"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "6aa1ffbc",
   "metadata": {},
   "outputs": [],
   "source": [
    "test.equal(_T().say_goodbye('eugene'), 'Goodbye, eugene')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "b5d14f35",
   "metadata": {},
   "outputs": [],
   "source": [
    "@patch\n",
    "def say_bye(cls:_T): return 'bye'"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "f3ce8fe7",
   "metadata": {},
   "outputs": [],
   "source": [
    "test.equal(_T.say_bye(), 'bye')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "0c59c003",
   "metadata": {},
   "outputs": [],
   "source": [
    "@patch(prop=True)\n",
    "def bye(self:_T): return 'bye'"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "5fedf001",
   "metadata": {},
   "outputs": [],
   "source": [
    "test.equal(_T().bye, 'bye')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "12b62cf8-2193-4f03-b80a-46304d73896e",
   "metadata": {},
   "outputs": [],
   "source": [
    "import nb; nb.export_nb('core.ipynb', src_dir='../nb/')"
   ]
  }
 ],
 "metadata": {},
 "nbformat": 4,
 "nbformat_minor": 5
}