Welcome to lucidity_files’s documentation!
Lucidity Files is a project for listing files and folders using the popular Lucidity templating module.
Made this for another project called Lucidity Browser (Aka Browser) that handles files listing and contextual actions across many folders and templates. This was tested with good results in the production Bad Dinos at Able & Baker studios .
Since the focus was on the Browser part, this end up not being a great thing, but it works. I have not tested this in Mac or Linux, although I plan to do it soon.
Installation
Install module with pip
python -m pip install lucidity_files
(You can also target a folder like this)
python -m pip install --target=P:\my\path lucidity_files
Example
import os
import lucidity_files
# create 'asset' file template -------
# define roots for files (useful for different os or the farm)
roots = {'root': 'C:'}
# define a relative path from the root
pattern = '{root:[\w_.\-:]+}/{project}/{entitytype}/{entity}/{step}/{task}/{entity}_{step}_{task}_{name}_v{version}.{ext}'
lf_template = lucidity_files.TemplateFile.create('assets', pattern, roots=roots)
# lets create a file to be listed
path = r"C:\test\asset\car\mod\hi\car_mod_hi_default_v001.txt"
# we could also use the template to do this!
input_data = {'entity': 'car', 'entitytype': 'asset', 'ext': 'txt', 'name': 'default',
'project': 'test', 'root': 'C:', 'step': 'mod', 'task': 'hi', 'version': '001'}
path2 = lf_template.format(input_data)
print(path == path2)
# will print True
os.makedirs(os.path.dirname(path), exist_ok=True)
with open(path, 'w'):
pass
# list all assets in project 'test'
paths_found = lf_template.getPaths({'project': 'test'})
# now get each path's data
for path in paths_found:
data = lf_template.parse(path)
print(path)
print('\t', data)
# # will print something like
# C:\test\asset\car\mod\hi\car_mod_hi_default_v001.txt
# {'entity': 'car', 'entitytype': 'asset', 'ext': 'txt', 'name': 'default',
# 'project': 'test', 'root': 'C:', 'step': 'mod', 'task': 'hi', 'version': '001'}
# lets get a partial template to the entity folder
partial_template = lf_template.getPartialTemplateFile('entity')
# list all entity folders. Will use the strict check to make sure that what get listed
# is parsable with the same template (some other folders might match the glob but
# not the specifics of the template, and we want to avoid those)
paths_found = partial_template.getPaths({'project': 'test'}, strict_check=True)
# now get each path's data
for path in paths_found:
print(path)
data = partial_template.parse(path)
print('\t', data)
# # will print something like
# C:\test\asset\car
# {'entity': 'car', 'entitytype': 'asset', 'project': 'test', 'root': 'C:'}
# ...
Features
List files with full or partial keys
Create partial templates for listing folders (key to browser functionality)
GitLab Project
Contents: