reasoning-gym/reasoning_gym/data/__init__.py
Andreas Koepf 20069b2a7d formatting
2025-01-24 10:34:07 +01:00

40 lines
1,006 B
Python

"""Package containing data files used by reasoning_gym"""
from importlib import resources
from pathlib import Path
from typing import Union
def get_data_file_path(filename: str) -> Path:
"""Get the path to a data file in the package.
Args:
filename: Name of the file in the data directory
Returns:
Path object pointing to the data file
Example:
>>> path = get_data_file_path("pg19362.txt")
>>> with open(path) as f:
... content = f.read()
"""
return resources.files("reasoning_gym.data").joinpath(filename)
def read_data_file(filename: str) -> str:
"""Read the contents of a data file in the package.
Args:
filename: Name of the file in the data directory
Returns:
String contents of the file
Example:
>>> content = read_data_file("pg19362.txt")
"""
return resources.files("reasoning_gym.data").joinpath(filename).read_text()
__all__ = ["get_data_file_path", "read_data_file"]