"""Manage a directory in a *parent* filesystem.
"""
from __future__ import print_function
from __future__ import unicode_literals
import typing
import six
from .wrapfs import WrapFS
from .path import abspath, join, normpath, relpath
if False: # typing.TYPE_CHECKING
from typing import Text, Tuple
from .base import FS
_F = typing.TypeVar("_F", bound="FS", covariant=True)
[docs]@six.python_2_unicode_compatible
class SubFS(WrapFS[_F], typing.Generic[_F]):
"""A sub-directory on another filesystem.
A SubFS is a filesystem object that maps to a sub-directory of
another filesystem. This is the object that is returned by
`~fs.base.FS.opendir`.
"""
def __init__(self, parent_fs, path):
# type: (_F, Text) -> None
super(SubFS, self).__init__(parent_fs)
self._sub_dir = abspath(normpath(path))
def __repr__(self):
# type: () -> Text
return "{}({!r}, {!r})".format(
self.__class__.__name__, self._wrap_fs, self._sub_dir
)
def __str__(self):
# type: () -> Text
return "{parent}{dir}".format(parent=self._wrap_fs, dir=self._sub_dir)
def delegate_fs(self):
# type: () -> _F
return self._wrap_fs
def delegate_path(self, path):
# type: (Text) -> Tuple[_F, Text]
_path = join(self._sub_dir, relpath(normpath(path)))
return self._wrap_fs, _path
[docs]class ClosingSubFS(SubFS[_F], typing.Generic[_F]):
"""A version of `SubFS` which closes its parent when closed.
"""
def close(self):
# type: () -> None
self.delegate_fs().close()
super(ClosingSubFS, self).close()