Module File List

Module File List.

Paths module-attribute

Paths = tuple[Path, ...]

Paths.

StrPaths module-attribute

StrPaths = tuple[str | Path, ...]

StrPaths.

ToPaths module-attribute

ToPaths = StrPaths

ToPaths.

Placeholder module-attribute

Placeholder = dict[str, Any]

Module Attributes for File Path.

These placeholder are filled during resolve.

ModFileLists module-attribute

ModFileLists = tuple[ModFileList, ...]

ModFileLists.

ModFileList

Bases: NamedLightObject

Module File List.

Attributes:

Name	Type	Description
gen	Gen	Generate Mode
targets	Gen	Implementation Targets
inc_dirs	ToPaths	Include Directories
inc_filepaths	ToPaths	Include File paths relative to module
filepaths	ToPaths	File paths relative to module
dep_filepaths	ToPaths	Dependency Filepaths
dep_inc_dirs	ToPaths	Dependency Include Directories
template_filepaths	ToPaths	Template Filepaths
inc_template_filepaths	ToPaths	Template Filepaths
is_leaf	bool	Do not include file lists of sub modules

get_mod_placeholder staticmethod

get_mod_placeholder(mod)

Get Module Placeholder.

get_cls_placeholder staticmethod

get_cls_placeholder()

Get Class Placeholder.

search_modfilelists

search_modfilelists(modfilelists, name, target=None)

Search Matching File List.

Parameters:

Name	Type	Description	Default
modfilelists	Iterable[ModFileList]	ModFileLists.	required
name	str	Module name.	required
target	str | None	Implementation Target	None

resolve_modfilelist

resolve_modfilelist(mod, name, target=None, filelistparser=None, replace_envvars=False)

Create ModFileList for mod.

Parameters:

Name	Type	Description	Default
mod	BaseMod	Module.	required
name	str	Name.	required
target	str | None	Implementation Target	None
filelistparser	FileListParser | None	FileListParser	None
replace_envvars	bool	Resolve Environment Variables.	False

iter_modfilelists

iter_modfilelists(topmod, name, target=None, filelistparser=None, replace_envvars=False, maxlevel=None)

Iterate over ModFileLists.

Parameters:

Name	Type	Description	Default
topmod	BaseMod	Top Module.	required
name	str	Name.	required
target	str | None	Implementation Target	None
filelistparser	FileListParser | None	FileListParser	None
replace_envvars	bool	Resolve Environment Variables.	False
maxlevel	int | None	Stop at maximum iteration level.	None