Add pathlib

internal_filesystem/lib/README.md

@@ -10,3 +10,4 @@ This /lib folder contains:
 - https://github.com/micropython/micropython-lib/blob/master/python-stdlib/logging/logging.py version 0.6.2 # for About app
 - https://github.com/micropython/micropython-lib/blob/master/python-stdlib/shutil/shutil.py version 0.0.5 # for rmtree()
 - https://github.com/micropython/micropython-lib/blob/master/python-stdlib/unittest/unittest/__init__.py  version 0.10.4 # for testing (also on-device)
+- https://github.com/micropython/micropython-lib/blob/master/python-stdlib/pathlib/pathlib.py version 0.0.1 # for Path()

internal_filesystem/lib/pathlib.py

@@ -0,0 +1,210 @@
+import errno
+import os
+
+from micropython import const
+
+_SEP = const("/")
+
+
+def _mode_if_exists(path):
+    try:
+        return os.stat(path)[0]
+    except OSError as e:
+        if e.errno == errno.ENOENT:
+            return 0
+        raise e
+
+
+def _clean_segment(segment):
+    segment = str(segment)
+    if not segment:
+        return "."
+    segment = segment.rstrip(_SEP)
+    if not segment:
+        return _SEP
+    while True:
+        no_double = segment.replace(_SEP + _SEP, _SEP)
+        if no_double == segment:
+            break
+        segment = no_double
+    return segment
+
+
+class Path:
+    def __init__(self, *segments):
+        segments_cleaned = []
+        for segment in segments:
+            segment = _clean_segment(segment)
+            if segment[0] == _SEP:
+                segments_cleaned = [segment]
+            elif segment == ".":
+                continue
+            else:
+                segments_cleaned.append(segment)
+
+        self._path = _clean_segment(_SEP.join(segments_cleaned))
+
+    def __truediv__(self, other):
+        return Path(self._path, str(other))
+
+    def __rtruediv__(self, other):
+        return Path(other, self._path)
+
+    def __repr__(self):
+        return f'{type(self).__name__}("{self._path}")'
+
+    def __str__(self):
+        return self._path
+
+    def __eq__(self, other):
+        return self.absolute() == Path(other).absolute()
+
+    def absolute(self):
+        path = self._path
+        cwd = os.getcwd()
+        if not path or path == ".":
+            return cwd
+        if path[0] == _SEP:
+            return path
+        return _SEP + path if cwd == _SEP else cwd + _SEP + path
+
+    def resolve(self):
+        return self.absolute()
+
+    def open(self, mode="r", encoding=None):
+        return open(self._path, mode, encoding=encoding)
+
+    def exists(self):
+        return bool(_mode_if_exists(self._path))
+
+    def mkdir(self, parents=False, exist_ok=False):
+        try:
+            os.mkdir(self._path)
+            return
+        except OSError as e:
+            if e.errno == errno.EEXIST and exist_ok:
+                return
+            elif e.errno == errno.ENOENT and parents:
+                pass  # handled below
+            else:
+                raise e
+
+        segments = self._path.split(_SEP)
+        progressive_path = ""
+        if segments[0] == "":
+            segments = segments[1:]
+            progressive_path = _SEP
+        for segment in segments:
+            progressive_path += _SEP + segment
+            try:
+                os.mkdir(progressive_path)
+            except OSError as e:
+                if e.errno != errno.EEXIST:
+                    raise e
+
+    def is_dir(self):
+        return bool(_mode_if_exists(self._path) & 0x4000)
+
+    def is_file(self):
+        return bool(_mode_if_exists(self._path) & 0x8000)
+
+    def _glob(self, path, pattern, recursive):
+        # Currently only supports a single "*" pattern.
+        n_wildcards = pattern.count("*")
+        n_single_wildcards = pattern.count("?")
+
+        if n_single_wildcards:
+            raise NotImplementedError("? single wildcards not implemented.")
+
+        if n_wildcards == 0:
+            raise ValueError
+        elif n_wildcards > 1:
+            raise NotImplementedError("Multiple * wildcards not implemented.")
+
+        prefix, suffix = pattern.split("*")
+
+        for name, mode, *_ in os.ilistdir(path):
+            full_path = path + _SEP + name
+            if name.startswith(prefix) and name.endswith(suffix):
+                yield full_path
+            if recursive and mode & 0x4000:  # is_dir
+                yield from self._glob(full_path, pattern, recursive=recursive)
+
+    def glob(self, pattern):
+        """Iterate over this subtree and yield all existing files (of any
+        kind, including directories) matching the given relative pattern.
+
+        Currently only supports a single "*" pattern.
+        """
+        return self._glob(self._path, pattern, recursive=False)
+
+    def rglob(self, pattern):
+        return self._glob(self._path, pattern, recursive=True)
+
+    def stat(self):
+        return os.stat(self._path)
+
+    def read_bytes(self):
+        with open(self._path, "rb") as f:
+            return f.read()
+
+    def read_text(self, encoding=None):
+        with open(self._path, "r", encoding=encoding) as f:
+            return f.read()
+
+    def rename(self, target):
+        os.rename(self._path, target)
+
+    def rmdir(self):
+        os.rmdir(self._path)
+
+    def touch(self, exist_ok=True):
+        if self.exists():
+            if exist_ok:
+                return  # TODO: should update timestamp
+            else:
+                # In lieue of FileExistsError
+                raise OSError(errno.EEXIST)
+        with open(self._path, "w"):
+            pass
+
+    def unlink(self, missing_ok=False):
+        try:
+            os.unlink(self._path)
+        except OSError as e:
+            if not (missing_ok and e.errno == errno.ENOENT):
+                raise e
+
+    def write_bytes(self, data):
+        with open(self._path, "wb") as f:
+            f.write(data)
+
+    def write_text(self, data, encoding=None):
+        with open(self._path, "w", encoding=encoding) as f:
+            f.write(data)
+
+    def with_suffix(self, suffix):
+        index = -len(self.suffix) or None
+        return Path(self._path[:index] + suffix)
+
+    @property
+    def stem(self):
+        return self.name.rsplit(".", 1)[0]
+
+    @property
+    def parent(self):
+        tokens = self._path.rsplit(_SEP, 1)
+        if len(tokens) == 2:
+            if not tokens[0]:
+                tokens[0] = _SEP
+            return Path(tokens[0])
+        return Path(".")
+
+    @property
+    def name(self):
+        return self._path.rsplit(_SEP, 1)[-1]
+
+    @property
+    def suffix(self):
+        elems = self._path.rsplit(".", 1)
+        return "" if len(elems) == 1 else "." + elems[1]