HowTo: Determine Available Files for the Current Compass Project

Version: 16.2

Table of Contents

Problem
Solution
Dicussion

Problem

I need to get a list of available files defined by the Project Control File (PCF) within the current Compass Project. I would also like to get a list of all files, regardless of their availability.

Solution

The first part, getting the list of currently available files by type within the Compass project works as follows,

from grail.compass import cmpsys

file15s = cmpsys.getfilelistbytype(15)

and file15s will be a complete listing of available files. That is all files that are available on the disk.

The second part, determining all defined files, regardless of availablity, can be done by querying the Pcf directly. You can do this with the following snippet,

from grail.compass import cmpsys

p = cmpsys.getpcf()

file15s = p.filelistbytype(15)

now file15s will be a list containing all files defined in the PCF, regardless of their availablity on the disk.

Dicussion

If you want to get the current listing of file use the grail.compass.cmpsys getfilelistbytype. If you want to get all defined files, regardless of their availablity, use the grail.data.pcf Pcf class to query the Project Control File directly.

Keep in mind that the grail.compass.cmpsys routines are only availabe from within the context of Compass Style Script.