transitio.FeedBuilder.save

transitio.FeedBuilder.save#

FeedBuilder.save(path, *, check=True, change_log=True, **budgets)#

Write the feed zip atomically and validate it.

Parameters:

  • path (str or pathlib.Path) – Output feed zip.

  • check (bool, default True) – Raise InvalidFeedError when the validator reports ERROR-severity notices (the report is on the exception’s report attribute and the file is still written); False skips the gate but still returns the report.

  • change_log (bool, default True) – Write the change log to <path stem>.changes.txt beside the feed when it is non-empty (see changes); the sidecar records only changes made through the helpers and primitives — edits through the tables escape hatch are outside the log. False skips it. Either way a stale sidecar from an earlier save at this path is removed.

  • **budgets – validate_feed keyword arguments.

Returns:

The validate_feed report of the written feed.

Return type:

dict