release

Author: jph00

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 <!-- do not remove -->
 
+## 1.1.0
+
+### Breaking Changes
+
+- Remove `Path.{read,write}` and change `Path.{load,save}` to functions `load_pickle` and `save_pickle` ([#121](https://github.com/fastai/fastcore/issues/121))
+
 ## 1.0.22
 
 ### New Features

fastcore/_nbdev.py

@@ -107,9 +107,10 @@
          "using_attr": "02_utils.ipynb",
          "Self": "02_utils.ipynb",
          "Path.readlines": "02_utils.ipynb",
+         "Path.mk_write": "02_utils.ipynb",
+         "Path.ls": "02_utils.ipynb",
          "save_pickle": "02_utils.ipynb",
          "load_pickle": "02_utils.ipynb",
-         "Path.ls": "02_utils.ipynb",
          "Path.__repr__": "02_utils.ipynb",
          "bunzip": "02_utils.ipynb",
          "join_path_file": "02_utils.ipynb",

fastcore/utils.py

@@ -506,9 +506,27 @@ def __getitem__(self,i): return self.__getattr__('__getitem__')(i)
 # Cell
 @patch
 def readlines(self:Path, hint=-1, encoding='utf8'):
-    "Read the content of `fname`"
+    "Read the content of `self`"
     with self.open(encoding=encoding) as f: return f.readlines(hint)
 
+# Cell
+@patch
+def mk_write(self:Path, data, encoding=None, errors=None, mode=511):
+    "Make all parent dirs of `self`"
+    self.parent.mkdir(exist_ok=True, parents=True, mode=mode)
+    self.write_text(data, encoding=encoding, errors=errors)
+
+# Cell
+@patch
+def ls(self:Path, n_max=None, file_type=None, file_exts=None):
+    "Contents of path as a list"
+    extns=L(file_exts)
+    if file_type: extns += L(k for k,v in mimetypes.types_map.items() if v.startswith(file_type+'/'))
+    has_extns = len(extns)==0
+    res = (o for o in self.iterdir() if has_extns or o.suffix in extns)
+    if n_max is not None: res = itertools.islice(res, n_max)
+    return L(res)
+
 # Cell
 def save_pickle(fn, o):
     "Save a pickle file, to a file name or opened file"
@@ -525,17 +543,6 @@ def load_pickle(fn):
     try: return pickle.load(fn)
     finally: fn.close()
 
-# Cell
-@patch
-def ls(self:Path, n_max=None, file_type=None, file_exts=None):
-    "Contents of path as a list"
-    extns=L(file_exts)
-    if file_type: extns += L(k for k,v in mimetypes.types_map.items() if v.startswith(file_type+'/'))
-    has_extns = len(extns)==0
-    res = (o for o in self.iterdir() if has_extns or o.suffix in extns)
-    if n_max is not None: res = itertools.islice(res, n_max)
-    return L(res)
-
 # Cell
 @patch
 def __repr__(self:Path):

nbs/02_utils.ipynb

@@ -295,7 +295,7 @@
     {
      "data": {
       "text/plain": [
-       "<__main__._t at 0x7f85ba48cfd0>"
+       "<__main__._t at 0x7f574d90d990>"
       ]
      },
      "execution_count": null,
@@ -2170,7 +2170,7 @@
     {
      "data": {
       "text/plain": [
-       "['e', 'g', 'f', 'b', 'c', 'a', 'd', 'h']"
+       "['d', 'b', 'h', 'a', 'g', 'c', 'e', 'f']"
       ]
      },
      "execution_count": null,
@@ -2878,7 +2878,7 @@
     "#export\n",
     "@patch\n",
     "def readlines(self:Path, hint=-1, encoding='utf8'):\n",
-    "    \"Read the content of `fname`\"\n",
+    "    \"Read the content of `self`\"\n",
     "    with self.open(encoding=encoding) as f: return f.readlines(hint)"
    ]
   },
@@ -2889,40 +2889,11 @@
    "outputs": [],
    "source": [
     "#export\n",
-    "def save_pickle(fn, o):\n",
-    "    \"Save a pickle file, to a file name or opened file\"\n",
-    "    fn = Path(fn)\n",
-    "    if not isinstance(fn, io.IOBase): fn = open(fn,'wb')\n",
-    "    try: pickle.dump(o, fn)\n",
-    "    finally: fn.close()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "#export\n",
-    "def load_pickle(fn):\n",
-    "    \"Load a pickle file from a file name or opened file\"\n",
-    "    fn = Path(fn)\n",
-    "    if not isinstance(fn, io.IOBase): fn = open(fn,'rb')\n",
-    "    try: return pickle.load(fn)\n",
-    "    finally: fn.close()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "with tempfile.NamedTemporaryFile() as f:\n",
-    "    fn = Path(f.name)\n",
-    "    save_pickle(fn, 't')\n",
-    "    t = load_pickle(fn)\n",
-    "test_eq(t,'t')"
+    "@patch\n",
+    "def mk_write(self:Path, data, encoding=None, errors=None, mode=511):\n",
+    "    \"Make all parent dirs of `self`\"\n",
+    "    self.parent.mkdir(exist_ok=True, parents=True, mode=mode)\n",
+    "    self.write_text(data, encoding=encoding, errors=errors)"
    ]
   },
   {
@@ -3009,6 +2980,49 @@
     "txt_files[0],ipy_files[0]"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#export\n",
+    "def save_pickle(fn, o):\n",
+    "    \"Save a pickle file, to a file name or opened file\"\n",
+    "    fn = Path(fn)\n",
+    "    if not isinstance(fn, io.IOBase): fn = open(fn,'wb')\n",
+    "    try: pickle.dump(o, fn)\n",
+    "    finally: fn.close()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#export\n",
+    "def load_pickle(fn):\n",
+    "    \"Load a pickle file from a file name or opened file\"\n",
+    "    fn = Path(fn)\n",
+    "    if not isinstance(fn, io.IOBase): fn = open(fn,'rb')\n",
+    "    try: return pickle.load(fn)\n",
+    "    finally: fn.close()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with tempfile.NamedTemporaryFile() as f:\n",
+    "    fn = Path(f.name)\n",
+    "    save_pickle(fn, 't')\n",
+    "    t = load_pickle(fn)\n",
+    "test_eq(t,'t')"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -3017,7 +3031,7 @@
    "source": [
     "#hide\n",
     "pkl = pickle.dumps(path)\n",
-    "p2 =pickle.loads(pkl)\n",
+    "p2 = pickle.loads(pkl)\n",
     "test_eq(path.ls()[0], p2.ls()[0])"
    ]
   },