ComfyUI Node: 📄 Read Text File

📄 Read Text File:

The ReadTextFile node is designed to read the contents of a specified text file and return the data as a string. This node is particularly useful for AI artists who need to incorporate text data from external files into their workflows. It can read the entire file or a specific line, making it versatile for various use cases. The node handles file reading in UTF-8 format, ensuring compatibility with most text files. Additionally, it provides options to manage end-of-file (EOF) scenarios gracefully, either by ignoring non-existent lines or raising an error to alert you.

📄 Read Text File Input Parameters:

file

This parameter specifies the path to the text file you want to read. It can be an absolute or relative path. The default value is file.txt. This parameter is crucial as it tells the node which file to read from.

line

This optional parameter determines which line of the file to read. If set to 0, the entire file will be read and returned as a single string. If set to a positive integer, only that specific line number will be read. The default value is 0.

on_eof

This optional boolean parameter dictates the action to take if the specified line number does not exist in the file. If set to True (default), the node will ignore the non-existent line and return an empty string. If set to False, the node will raise an error to alert you.

📄 Read Text File Output Parameters:

STRING

The output is a string containing the contents of the text file. If a specific line number is provided, only that line will be returned. If the entire file is read, the output will be the full text content of the file.

📄 Read Text File Usage Tips:

• To read the entire content of a file, set the line parameter to 0.
• If you are only interested in a specific line, set the line parameter to the desired line number.
• Use the on_eof parameter to control how the node handles non-existent lines, which can be useful for error handling in your workflow.

📄 Read Text File Common Errors and Solutions:

File not found

• Explanation: The specified file path does not exist.
• Solution: Ensure that the file path is correct and that the file exists at the specified location.

Line number out of range

• Explanation: The specified line number exceeds the number of lines in the file.
• Solution: Adjust the line number to be within the range of the file's line count or set on_eof to True to ignore this error.

Permission denied

• Explanation: The node does not have permission to read the specified file.
• Solution: Check the file permissions and ensure that the node has read access to the file.