14.2.11. crate_anon.common.inputfunc
crate_anon/common/inputfunc.py
Copyright (C) 2015, University of Cambridge, Department of Psychiatry. Created by Rudolf Cardinal (rnc1001@cam.ac.uk).
This file is part of CRATE.
CRATE 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 3 of the License, or (at your option) any later version.
CRATE 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 CRATE. If not, see <https://www.gnu.org/licenses/>.
Read from files or stdin.
- crate_anon.common.inputfunc.gen_chunks_from_files(filenames: List[str], chunk_terminator_line: str | None = None, stdin_prompt: str | None = None) Iterable[str] [source]
Iterates through filenames (also permitting ‘-’ for stdin). Generates multi-line chunks, separated by a terminator.
- Parameters:
filenames – Filenames (or ‘-’ for stdin).
chunk_terminator_line – Single-line string used to separate chunks within a file. If this is an empty string, then enter a blank line to terminate. If it is
None
, then lines are yielded one by one (multi-line input is not possible).stdin_prompt – Optional prompt to show (to the log) before each request.
- Yields:
str – Each chunk.