remove some xdg tests

Author: jph00

fastcore/_modidx.py

@@ -9,6 +9,7 @@
                 'branch': 'master',
                 'clean_ids': 'True',
                 'copyright': 'fast.ai',
+                'custom_quarto_yml': 'False',
                 'custom_sidebar': 'False',
                 'description': 'Python supercharged for fastai development',
                 'dev_requirements': 'numpy nbdev>=0.2.39 matplotlib pillow torch pandas jupyterlab',

fastcore/docments.py

@@ -39,14 +39,17 @@ def isdataclass(s):
     "Check if `s` is a dataclass but not a dataclass' instance"
     return is_dataclass(s) and isclass(s)
 
+# %% ../nbs/06_docments.ipynb 19
 def get_dataclass_source(s):
     "Get source code for dataclass `s`"
     return getsource(s) if not getattr(s, "__module__") == '__main__' else ""
 
+# %% ../nbs/06_docments.ipynb 20
 def get_source(s):
     "Get source code for string, function object or dataclass `s`"
     return getsource(s) if isfunction(s) or ismethod(s) else get_dataclass_source(s) if isdataclass(s) else s
 
+# %% ../nbs/06_docments.ipynb 21
 def _parses(s):
     "Parse Python code in string, function object or dataclass `s`"
     return parse(dedent(get_source(s)))
@@ -75,10 +78,10 @@ def _param_locs(s, returns=True):
             return res
     return None
 
-# %% ../nbs/06_docments.ipynb 19
+# %% ../nbs/06_docments.ipynb 22
 empty = Parameter.empty
 
-# %% ../nbs/06_docments.ipynb 20
+# %% ../nbs/06_docments.ipynb 23
 def _get_comment(line, arg, comments, parms):
     if line in comments: return comments[line].strip()
     line -= 1
@@ -92,7 +95,7 @@ def _get_full(anno, name, default, docs):
     if anno==empty and default!=empty: anno = type(default)
     return AttrDict(docment=docs.get(name), anno=anno, default=default)
 
-# %% ../nbs/06_docments.ipynb 21
+# %% ../nbs/06_docments.ipynb 24
 def _merge_doc(dm, npdoc):
     if not npdoc: return dm
     if not dm.anno or dm.anno==empty: dm.anno = npdoc.type
@@ -105,14 +108,14 @@ def _merge_docs(dms, npdocs):
     if 'return' in dms: params['return'] = _merge_doc(dms['return'], npdocs['Returns'])
     return params
 
-# %% ../nbs/06_docments.ipynb 22
+# %% ../nbs/06_docments.ipynb 25
 def _get_property_name(p):
     "Get the name of property `p`"
     if hasattr(p, 'fget'):
         return p.fget.func.__qualname__ if hasattr(p.fget, 'func') else p.fget.__qualname__
     else: return next(iter(re.findall(r'\'(.*)\'', str(p)))).split('.')[-1]
 
-# %% ../nbs/06_docments.ipynb 23
+# %% ../nbs/06_docments.ipynb 26
 def get_name(obj):
     "Get the name of `obj`"
     if hasattr(obj, '__name__'):       return obj.__name__
@@ -121,14 +124,14 @@ def get_name(obj):
     elif type(obj)==property:          return _get_property_name(obj)
     else:                              return str(obj).split('.')[-1]
 
-# %% ../nbs/06_docments.ipynb 25
+# %% ../nbs/06_docments.ipynb 28
 def qual_name(obj):
     "Get the qualified name of `obj`"
     if hasattr(obj,'__qualname__'): return obj.__qualname__
     if ismethod(obj):       return f"{get_name(obj.__self__)}.{get_name(fn)}"
     return get_name(obj)
 
-# %% ../nbs/06_docments.ipynb 27
+# %% ../nbs/06_docments.ipynb 30
 def _docments(s, returns=True, eval_str=False):
     "`dict` of parameter names to 'docment-style' comments in function or string `s`"
     nps = parse_docstring(s)
@@ -148,12 +151,12 @@ def _docments(s, returns=True, eval_str=False):
             if k in hints: v['anno'] = hints.get(k)
     return res
 
-# %% ../nbs/06_docments.ipynb 28
+# %% ../nbs/06_docments.ipynb 31
 @delegates(_docments)
 def docments(elt, full=False, **kwargs):
     "Generates a `docment`"
     res = _docments(elt, **kwargs)
-    if hasattr(elt, "__delwrap__"): #for delegates
+    if hasattr(elt, "__delwrap__"): # for delegates
         delwrap_dict = _docments(elt.__delwrap__, **kwargs)
         verbose = getattr(elt,'__delopts__',{}).get('verbose',True)
         for k,v in res.items():

fastcore/xdg.py

@@ -41,18 +41,18 @@ def xdg_data_dirs():
     "Paths corresponding to XDG_DATA_DIRS`"
     return _paths_from_env( "XDG_DATA_DIRS", [Path(o) for o in "/usr/local/share/:/usr/share/".split(":")])
 
-# %% ../nbs/09_xdg.ipynb 21
+# %% ../nbs/09_xdg.ipynb 20
 def xdg_data_home():
     "Path corresponding to `XDG_DATA_HOME`"
     return _path_from_env("XDG_DATA_HOME", Path.home()/".local"/"share")
 
-# %% ../nbs/09_xdg.ipynb 23
+# %% ../nbs/09_xdg.ipynb 22
 def xdg_runtime_dir():
     "Path corresponding to `XDG_RUNTIME_DIR`"
     value = os.getenv("XDG_RUNTIME_DIR")
     return Path(value) if value and os.path.isabs(value) else None
 
-# %% ../nbs/09_xdg.ipynb 25
+# %% ../nbs/09_xdg.ipynb 23
 def xdg_state_home():
     "Path corresponding to `XDG_STATE_HOME`"
     return _path_from_env("XDG_STATE_HOME", Path.home()/".local"/"state")

nbs/06_docments.ipynb

@@ -221,16 +221,40 @@
     "#|export\n",
     "def isdataclass(s):\n",
     "    \"Check if `s` is a dataclass but not a dataclass' instance\"\n",
-    "    return is_dataclass(s) and isclass(s)\n",
-    "\n",
+    "    return is_dataclass(s) and isclass(s)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#|export\n",
     "def get_dataclass_source(s):\n",
     "    \"Get source code for dataclass `s`\"\n",
-    "    return getsource(s) if not getattr(s, \"__module__\") == '__main__' else \"\"\n",
-    "\n",
+    "    return getsource(s) if not getattr(s, \"__module__\") == '__main__' else \"\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#|export\n",
     "def get_source(s):\n",
     "    \"Get source code for string, function object or dataclass `s`\"\n",
-    "    return getsource(s) if isfunction(s) or ismethod(s) else get_dataclass_source(s) if isdataclass(s) else s\n",
-    "\n",
+    "    return getsource(s) if isfunction(s) or ismethod(s) else get_dataclass_source(s) if isdataclass(s) else s"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#|export\n",
     "def _parses(s):\n",
     "    \"Parse Python code in string, function object or dataclass `s`\"\n",
     "    return parse(dedent(get_source(s)))\n",
@@ -412,7 +436,7 @@
     "def docments(elt, full=False, **kwargs):\n",
     "    \"Generates a `docment`\"\n",
     "    res = _docments(elt, **kwargs)\n",
-    "    if hasattr(elt, \"__delwrap__\"): #for delegates\n",
+    "    if hasattr(elt, \"__delwrap__\"): # for delegates\n",
     "        delwrap_dict = _docments(elt.__delwrap__, **kwargs)\n",
     "        verbose = getattr(elt,'__delopts__',{}).get('verbose',True)\n",
     "        for k,v in res.items():\n",

nbs/08_script.ipynb

@@ -160,6 +160,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "#|hide\n",
     "from fastcore.test import *"
    ]
   },
@@ -561,9 +562,11 @@
    "source": [
     "@call_parse\n",
     "def test_add(\n",
-    "    a:int,  # param a\n",
-    "    b:int  # param 1\n",
-    "): return a + b"
+    "    a:int=0,  # param a\n",
+    "    b:int=0  # param 1\n",
+    "):\n",
+    "    \"Add up `a` and `b`\"\n",
+    "    return a + b"
    ]
   },
   {
@@ -622,9 +625,7 @@
    "outputs": [],
    "source": [
     "#|hide\n",
-    "#|eval: false\n",
-    "from nbdev import nbdev_export\n",
-    "nbdev_export()"
+    "import nbdev; nbdev.nbdev_export()"
    ]
   },
   {

nbs/09_xdg.ipynb

@@ -243,18 +243,6 @@
     "    return _paths_from_env( \"XDG_DATA_DIRS\", [Path(o) for o in \"/usr/local/share/:/usr/share/\".split(\":\")])"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "a87fd3a8",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "test_eq(xdg_data_dirs(), [Path('/usr/local/share'), Path('/usr/share')])\n",
-    "with env('XDG_DATA_DIRS', '/home/fastai/.xdg:/home/fastai/.data'):\n",
-    "    test_eq(xdg_data_dirs(), [Path('/home/fastai/.xdg'), Path('/home/fastai/.data')])"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -294,19 +282,6 @@
     "    return Path(value) if value and os.path.isabs(value) else None"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "fb098eba",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "assert (xdg_runtime_dir() is None # macos\n",
-    "        or xdg_runtime_dir().parent == Path('/run/user/')) # ubuntu\n",
-    "with env('XDG_RUNTIME_DIR', '/home/fastai/.data'):\n",
-    "    test_eq(xdg_runtime_dir(), Path('/home/fastai/.data'))"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,

settings.ini

@@ -32,3 +32,5 @@ allowed_cell_metadata_keys =
 jupyter_hooks = True
 clean_ids = True
 
+#console_scripts = fc1=fastcore.script:test_add
+