DocumentFile API¶

File operations with SAF (Storage Access Framework) support for Android 4.4+.

Directory Operations¶

documentFileMkdir()¶

Create directory.

documentFileMkdir(Dir)

Parameters: - Dir (str): Directory path

Returns: True if success

documentFileListFiles()¶

List files in directory.

documentFileListFiles(Folder)

Returns: List of files

File Operations¶

documentFileExists()¶

Check if file or directory exists.

documentFileExists(path)

Parameters: - path (str): File or directory path

Returns: True if exists, False otherwise

documentFileIsFile()¶

Check if path is a file.

documentFileIsFile(path)

Parameters: - path (str): Path to check

Returns: True if file, False if not a file, None if not exists

documentFileIsDirectory()¶

Check if path is a directory.

documentFileIsDirectory(path)

Parameters: - path (str): Path to check

Returns: True if directory, False if not a directory, None if not exists

documentFileDelete()¶

Delete file or directory.

documentFileDelete(FileOrTree)

Returns: True if success

documentFileRenameTo()¶

Rename or move file.

documentFileRenameTo(Src, Dest)

Returns: True if success

documentFileCopy()¶

Copy file.

documentFileCopy(SrcFileOrTree, DestFileOrTree)

Stream Operations¶

documentFileInputStream()¶

Read file content.

documentFileInputStream(srcFile, EncodingFormat="", skip=None, length=None)

Parameters: - srcFile (str): Source file - EncodingFormat (str): "UTF-8", "GBK", "Base64", or "" for bytes - skip (int): Skip bytes from start - length (int): Read length

Returns: File content

documentFileOutputStream()¶

Write file content.

documentFileOutputStream(destFile, src, EncodingFormat="", append=None)

Parameters: - destFile (str): Destination file - src: Data to write - EncodingFormat (str): Encoding format - append (bool): Append mode

File Information¶

documentFileLength()¶

Get file size in bytes.

documentFileLength(path)

Parameters: - path (str): File path

Returns: File size in bytes (0 if not exists)

documentFileLastModified()¶

Get last modified time.

documentFileLastModified(path)

Parameters: - path (str): File path

Returns: Timestamp (0 if not exists)

documentFileGetStat()¶

Get comprehensive file statistics.

documentFileGetStat(path)

Parameters: - path (str): File path

Returns: Dict with length, last modified, and read/write permissions, or None if not exists

URI Operations¶

documentFileGetUri()¶

Get URI from path.

documentFileGetUri(path, isDirectory=None)

documentFileShowOpen()¶

Show file picker.

documentFileShowOpen()

Returns: Selected file URI

Usage Example¶

import androidhelper

droid = androidhelper.Android()

# Create directory
droid.documentFileMkdir("/sdcard/MyFolder")

# List files
files = droid.documentFileListFiles("/sdcard").result
for f in files:
    print(f)

# Read file
content = droid.documentFileInputStream(
    "/sdcard/test.txt",
    EncodingFormat="UTF-8"
).result
print(content)

# Write file
droid.documentFileOutputStream(
    "/sdcard/output.txt",
    "Hello World",
    EncodingFormat="UTF-8"
)