check_file_status() — Fast Ref API Reference

Checks whether each reference's source file is up-to-date, changed, or missing.

Signature

api.check_file_status() -> dict

Return Value

{
    "success": True,
    "data": [
        {
            "name": str,
            "file_path": str,
            "status": str,
        },
        ...
    ]
}

Status Values (status)

Value	Meaning
`"latest"`	Source file matches the loaded snapshot
`"outdated"`	Source file has changed since loading
`"missing"`	Source file not found on disk
`"converted"`	Reference has been converted to scene objects
`"unknown"`	Status could not be determined

Example

from os_fast_ref.api import FastRefAPI

api = FastRefAPI()
status = api.check_file_status()

for s in status['data']:
    print(f"  {s['name']}: {s['status']}")

Usage Example — Reload Only If Changed

from os_fast_ref.api import FastRefAPI

api = FastRefAPI()
status = api.check_file_status()

if any(s['status'] == 'outdated' for s in status['data']):
    result = api.reload_all_references()
    print(result['message'])  # e.g. "Reload complete: 3 succeeded, 0 failed, 0 skipped"