Module botroyale.util.file

Writing, loading, and opening files.

"""Writing, loading, and opening files."""
import os
import subprocess
import platform
from pathlib import Path
import json
import tomlkit


def toml_dumps(data: dict, sort_keys: bool = False) -> str:
    """Convert a dictionary to a TOML-compatible string using `tomlkit`."""
    return tomlkit.dumps(data, sort_keys=sort_keys)


def toml_loads(string: str) -> dict:
    """Convert a TOML-compatible string to a dictionary using `tomlkit`."""
    toml_doc = tomlkit.loads(string)
    # The resulting TOMLDocument behaves like a dict but preserves format.
    # We convert to json and back to get a normal dict.
    json_str = json.dumps(toml_doc)
    return json.loads(json_str)


def file_load(file: os.PathLike) -> str:
    """Loads *file* and returns the contents as a string."""
    with open(file, "r") as f:
        d = f.read()
    return d


def file_dump(file: os.PathLike, d: str, clear: bool = True):
    """Saves the string *d* to *file*.

    Will overwrite the file if *clear* is True, otherwise will append to it.
    """
    with open(file, "w" if clear else "a", encoding="utf-8") as f:
        f.write(d)


def popen_path(path: os.PathLike):
    """Opens the given path. Method used is platform-dependent."""
    if platform.system() == "Windows":
        os.startfile(path)
    elif platform.system() == "Darwin":
        subprocess.Popen(["open", path])
    else:
        subprocess.Popen(["xdg-open", path])


def get_usr_dir(dir_name: str) -> Path:
    r"""Return a path to a dedicated directory in the user's app data folder.

    - Windows: `~\AppData\Local\BotRoyale\dir_name`
    - Mac OS: `~/Library/Local/BotRoyale/dir_name`
    - Linux: `~/.local/share/botroyale/dir_name`
    """
    path = Path.home()
    if platform.system() == "Windows":
        path = path / "AppData" / "Local" / "BotRoyale" / dir_name
    elif platform.system() == "Darwin":
        path = path / "Library" / "BotRoyale" / dir_name
    else:
        path = path / ".local" / "share" / "botroyale" / dir_name
    return path

Functions

def file_dump(file: os.PathLike, d: str, clear: bool = True)

Saves the string d to file.

Will overwrite the file if clear is True, otherwise will append to it.

Expand source code Browse git

def file_dump(file: os.PathLike, d: str, clear: bool = True):
    """Saves the string *d* to *file*.

    Will overwrite the file if *clear* is True, otherwise will append to it.
    """
    with open(file, "w" if clear else "a", encoding="utf-8") as f:
        f.write(d)

def file_load(file: os.PathLike) ‑> str

Loads file and returns the contents as a string.

Expand source code Browse git

def file_load(file: os.PathLike) -> str:
    """Loads *file* and returns the contents as a string."""
    with open(file, "r") as f:
        d = f.read()
    return d

def get_usr_dir(dir_name: str) ‑> pathlib.Path

Return a path to a dedicated directory in the user's app data folder.

• Windows: ~\AppData\Local\BotRoyale\dir_name
• Mac OS: ~/Library/Local/BotRoyale/dir_name
• Linux: ~/.local/share/botroyale/dir_name

Expand source code Browse git

def get_usr_dir(dir_name: str) -> Path:
    r"""Return a path to a dedicated directory in the user's app data folder.

    - Windows: `~\AppData\Local\BotRoyale\dir_name`
    - Mac OS: `~/Library/Local/BotRoyale/dir_name`
    - Linux: `~/.local/share/botroyale/dir_name`
    """
    path = Path.home()
    if platform.system() == "Windows":
        path = path / "AppData" / "Local" / "BotRoyale" / dir_name
    elif platform.system() == "Darwin":
        path = path / "Library" / "BotRoyale" / dir_name
    else:
        path = path / ".local" / "share" / "botroyale" / dir_name
    return path

def popen_path(path: os.PathLike)

Opens the given path. Method used is platform-dependent.

Expand source code Browse git

def popen_path(path: os.PathLike):
    """Opens the given path. Method used is platform-dependent."""
    if platform.system() == "Windows":
        os.startfile(path)
    elif platform.system() == "Darwin":
        subprocess.Popen(["open", path])
    else:
        subprocess.Popen(["xdg-open", path])

def toml_dumps(data: dict, sort_keys: bool = False) ‑> str

Convert a dictionary to a TOML-compatible string using tomlkit.

Expand source code Browse git

def toml_dumps(data: dict, sort_keys: bool = False) -> str:
    """Convert a dictionary to a TOML-compatible string using `tomlkit`."""
    return tomlkit.dumps(data, sort_keys=sort_keys)

def toml_loads(string: str) ‑> dict

Convert a TOML-compatible string to a dictionary using tomlkit.

Expand source code Browse git

def toml_loads(string: str) -> dict:
    """Convert a TOML-compatible string to a dictionary using `tomlkit`."""
    toml_doc = tomlkit.loads(string)
    # The resulting TOMLDocument behaves like a dict but preserves format.
    # We convert to json and back to get a normal dict.
    json_str = json.dumps(toml_doc)
    return json.loads(json_str)