file

Description

A plugin for general-purpose file methods

Configuration

file:
    # No configuration required

Actions

• file.append

• file.chmod

• file.getsize

• file.home

• file.link

• file.list

• file.mkdir

• file.read

• file.rename

• file.rmdir

• file.touch

• file.unlink

• file.write

Module reference

class platypush.plugins.file.FilePlugin(**kwargs)

Bases: Plugin

A plugin for general-purpose file methods

__init__(**kwargs)

append(file: str, content)

Append content to a specified (text) file.

Parameters:

• file – Path of the file.

• content – Content to write.

chmod(file: str, mode)

Change the mode/permissions of a file.

Parameters:

• file – File name/path.

• mode – New file permissions.

getsize(file)

Get the size of the specified file in bytes.

Parameters:

file – File path.

home() → str

Returns the current user’s home directory.

link(file: str, target: str, symbolic=True)

Create a link to a file.

Parameters:

• file – File to symlink.

• target – Symlink path.

• symbolic – If True, then the target link will be a symbolic link. Otherwise, it will be a hard link (default: symbolic).

list(path: str | None = None) → List[Dict[str, str]]

List a file or all the files in a directory.

Parameters:

path – File or directory (default: root directory).

Returns:

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.

mkdir(directory: str, exist_ok=True, parents=True, mode=493)

Create a directory.

Parameters:

• directory – Directory name/path.

• exist_ok – If set and the directory already exist the method will not return an error (default: True).

• 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).

• mode – Access mode (default: 0755).

read(file: str)

Read and return the content of a (text) file.

Note that this method should only be used for small text files, as it reads the entire file in memory.

If you need to read large/binary files, consider using the GET /file?path=<path> HTTP API endpoint instead.

Parameters:

file – Path of the file.

rename(file: str, name: str)

Rename/move a file.

Parameters:

• file – File to rename.

• name – New file name.

rmdir(directory: str)

Remove a directory. The directory must be empty.

Parameters:

directory – Directory name/path.

touch(file: str, mode=420)

Create/touch a file.

Parameters:

• file – File name/path.

• mode – File permissions (default: 0644).

unlink(file: str)

Remove a file or symbolic link.

Parameters:

file – File/link to remove.

write(file: str, content: str)

Writes content to a specified (text) file. Previous content will be truncated.

Parameters:

• file – Path of the file.

• content – Content to write.