File I/O

file_io

Provide small generic text-file I/O helpers.

read_text

read_text(path: Path, *, encoding: str = 'utf-8') -> str

Read a text file.

Parameters:

Name	Type	Description	Default
path	Path	File to read.	required
encoding	str	Text encoding.	'utf-8'

Returns:

Type	Description
str	File contents.

Raises:

Type	Description
OSError	If the file cannot be read.

Source code in hotstring\file_io.py

def read_text(path: Path, *, encoding: str = "utf-8") -> str:
    """Read a text file.

    Args:
        path:
            File to read.
        encoding:
            Text encoding.

    Returns:
        File contents.

    Raises:
        OSError:
            If the file cannot be read.
    """
    return path.read_text(encoding=encoding)

write_text

write_text(
    path: Path,
    text: str,
    *,
    append: bool = False,
    encoding: str = "utf-8",
    create_parents: bool = True,
) -> None

Write or append text to a file.

Parameters:

Name	Type	Description	Default
path	Path	Destination file.	required
text	str	Text to write.	required
append	bool	Append instead of replacing the current contents.	False
encoding	str	Text encoding.	'utf-8'
create_parents	bool	Create missing parent directories before writing.	True

Raises:

Type	Description
OSError	If the destination cannot be written.

Source code in hotstring\file_io.py

def write_text(
    path: Path,
    text: str,
    *,
    append: bool = False,
    encoding: str = "utf-8",
    create_parents: bool = True,
) -> None:
    """Write or append text to a file.

    Args:
        path:
            Destination file.
        text:
            Text to write.
        append:
            Append instead of replacing the current contents.
        encoding:
            Text encoding.
        create_parents:
            Create missing parent directories before writing.

    Raises:
        OSError:
            If the destination cannot be written.
    """
    if create_parents:
        path.parent.mkdir(parents=True, exist_ok=True)

    mode = "a" if append else "w"
    with path.open(mode, encoding=encoding, newline="") as stream:
        stream.write(text)