April 2024 - This site, and Kamaelia are being updated. There is significant work needed, and PRs are welcome.
This component accepts data from it's inbox "inbox" and appends the data to the end of the given file.
It takes four arguments, with these default values:
filename = None
forwarder = True
blat_file = False
hold_open = True
filename should be clear. If you don't supply this, it'll break.
forwarder - this component defaults to passing on a copy of the data it's appending to the file. This makes this component useful for dropping in between other components for logging/debugging what's going on.
blat_file - if this is true, the file is zapped before we start appending data.
hold_open - This determines if the file is closed between instances of data arriving.
Appender() -> component that incrementally append data to the end of a file (think logging)
Uses the following keyword argyments:
* filename - File to append to (required)
* forwarder - copy to outbox (default: True)
* blat_file - write empty file (default: False)
* hold_open - keep file open (default: True)
Warning!
You should be using the inbox/outbox interface, not these methods (except construction). This documentation is designed as a roadmap as to their functionalilty for maintainers and new component developers.
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!
Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.
-- Automatic documentation generator, 05 Jun 2009 at 03:01:38 UTC/GMT