FileList Parser

File List Parser.

FileListParser

Bases: Object

File List Parser.

parse_file

parse_file(filepaths, inc_dirs, filepath, replace_envvars=False)

Read File List File.

Parameters:

Name	Type	Description	Default
filepaths	list[Path]	File Paths Container.	required
inc_dirs	list[Path]	Include Directories Container.	required
filepath	Path	File to be parsed.	required
replace_envvars	bool	Resolve Environment Variables.	False

parse

parse(filepaths, inc_dirs, basedir, items, replace_envvars=False, context='')

File List File.

Parameters:

Name	Type	Description	Default
filepaths	list[Path]	File Paths Container.	required
inc_dirs	list[Path]	Include Directories Container.	required
basedir	Path	Base Directory for Relative Paths.	required
items	Iterable[str | Path]	Items to be parsed.	required
replace_envvars	bool	Resolve Environment Variables.	False
context	str	Context for error reporting.	''

resolve

resolve(basedir, path)

Return Valid Filepath With Resolved Environment Variables.

Parameters:

Name	Type	Description	Default
basedir	Path	Base Directory.	required
path	Path	Path.	required

normalize

normalize(basedir, path, replace_envvars)

Return Normalized Filepaths for File List.

Parameters:

Name	Type	Description	Default
basedir	Path	Base Directory.	required
path	Path	Path.	required
replace_envvars	bool	Resolve Environment Variables.	required