import json
import os
import pathlib
from typing import List, Dict
from platypush.plugins import Plugin, action
[docs]class FilePlugin(Plugin):
"""
A plugin for general-purpose file methods
"""
@classmethod
def _get_path(cls, filename):
return os.path.abspath(os.path.expanduser(filename))
@classmethod
def _to_string(cls, content):
try:
return json.dumps(content)
except (ValueError, TypeError):
return str(content)
[docs] @action
def read(self, file: str):
"""
Read and return the content of a (text) file.
:param file: Path of the file.
"""
with open(self._get_path(file), 'r') as f:
return f.read()
[docs] @action
def write(self, file: str, content: str):
"""
Writes content to a specified (text) file. Previous content will be truncated.
:param file: Path of the file.
:param content: Content to write.
"""
if not isinstance(content, str):
content = self._to_string(content)
with open(self._get_path(file), 'w') as f:
f.write(content)
[docs] @action
def append(self, file: str, content):
"""
Append content to a specified (text) file.
:param file: Path of the file.
:param content: Content to write.
"""
if not isinstance(content, str):
content = self._to_string(content)
with open(self._get_path(file), 'a') as f:
f.write(content)
[docs] @action
def getsize(self, file):
"""
Get the size of the specified file in bytes.
:param file: File path.
"""
return os.path.getsize(self._get_path(file))
[docs] @action
def mkdir(self, directory: str, exist_ok=True, parents=True, mode=0o755):
"""
Create a directory.
:param directory: Directory name/path.
:param exist_ok: If set and the directory already exist the method will
not return an error (default: True).
:param parents: If set and any of the parent directories in the path don't
exist they will be created (analogous to mkdir -p) (default: True).
:param mode: Access mode (default: 0755).
"""
pathlib.Path(self._get_path(directory)).mkdir(parents=parents, exist_ok=exist_ok, mode=mode)
[docs] @action
def rmdir(self, directory: str):
"""
Remove a directory. The directory must be empty.
:param directory: Directory name/path.
"""
pathlib.Path(self._get_path(directory)).rmdir()
[docs] @action
def touch(self, file: str, mode=0o644):
"""
Create/touch a file.
:param file: File name/path.
:param mode: File permissions (default: 0644).
"""
pathlib.Path(self._get_path(file)).touch(mode=mode)
[docs] @action
def chmod(self, file: str, mode):
"""
Change the mode/permissions of a file.
:param file: File name/path.
:param mode: New file permissions.
"""
pathlib.Path(self._get_path(file)).chmod(mode=mode)
[docs] @action
def home(self) -> str:
"""
Returns the current user's home directory.
"""
return str(pathlib.Path.home())
[docs] @action
def rename(self, file: str, name: str):
"""
Rename/move a file.
:param file: File to rename.
:param name: New file name.
"""
pathlib.Path(self._get_path(file)).rename(self._get_path(name))
[docs] @action
def link(self, file: str, target: str, symbolic=True):
"""
Create a link to a file.
:param file: File to symlink.
:param target: Symlink path.
:param symbolic: If True, then the target link will be a symbolic link. Otherwise,
it will be a hard link (default: symbolic).
"""
file = pathlib.Path(self._get_path(file))
target = self._get_path(target)
if symbolic:
file.symlink_to(target)
else:
file.link_to(target)
[docs] @action
def unlink(self, file: str):
"""
Remove a file or symbolic link.
:param file: File/link to remove.
"""
pathlib.Path(self._get_path(file)).unlink()
[docs] @action
def list(self, path: str = os.path.abspath(os.sep)) -> List[Dict[str, str]]:
"""
List a file or all the files in a directory.
:param path: File or directory (default: root directory).
:return: List of files in the specified path, or absolute path of the specified path if ``path`` is a file and
it exists. Each item will contain the fields ``type`` (``file`` or ``directory``) and ``path``.
"""
path = self._get_path(path)
assert os.path.exists(path), 'No such file or directory: {}'.format(path)
if not os.path.isdir(path):
return [{
'type': 'file',
'path': path,
'name': os.path.basename(path),
}]
return sorted(
[
{
'type': 'directory' if os.path.isdir(os.path.join(path, f)) else 'file',
'path': os.path.join(path, f),
'name': os.path.basename(f),
}
for f in sorted(os.listdir(path))
],
key=lambda f: (f.get('type'), f.get('name'))
)
# vim:sw=4:ts=4:et:
