Source code for repomatic.bundle

# Copyright Kevin Deldycke <[email protected]> and contributors.
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

"""Raw access to the data files bundled in `repomatic/data/`.

The lowest layer of bundled-data access, deliberately dependency-free so any
module can read a data file without import cycles. Policy layers sit above:
`repomatic.init_project.export_content` validates names against the
exportable-file registry, and `repomatic.tool_runner` resolves tool configs.
"""

from __future__ import annotations

from contextlib import contextmanager
from importlib.resources import as_file, files

TYPE_CHECKING = False
if TYPE_CHECKING:
    from collections.abc import Iterator
    from pathlib import Path




def get_data_content(filename: str) -> str:
    """Get the content of a bundled data file.

    This is the low-level function for reading any file from `repomatic/data/`.

    :param filename: Name of the file to retrieve (e.g., "labels.toml").
    :return: Content of the file as a string.
    :raises FileNotFoundError: If the file doesn't exist.
    """
    data_files = files("repomatic.data")
    with as_file(data_files.joinpath(filename)) as path:
        if path.exists():
            return path.read_text(encoding="UTF-8")

    msg = f"Data file not found: {filename}"
    raise FileNotFoundError(msg)





@contextmanager
def get_data_file_path(filename: str) -> Iterator[Path]:
    """Yield the filesystem path of a bundled data file.

    Unlike {func}`get_data_content` which returns string content, this yields
    a `Path` suitable for passing to external tools via `--config <path>`.
    The path is valid only within the context manager.
    """
    data_files = files("repomatic.data")
    with as_file(data_files.joinpath(filename)) as path:
        if not path.exists():
            msg = f"Bundled data file not found: {filename}"
            raise FileNotFoundError(msg)
        yield path