Kamaelia docs : Kamaelia.File.Writing

Simple File Writer

This component writes any data it receives to a file.

Example Usage

Copying a file:

from Kamaelia.File.Writing import SimpleFileWriter


More detail

Any data sent to this component's inbox is written to the specified file. Any existing file with the same name is overwritten.

The file is opened for writing when the component is activated, and is closed when it shuts down.

This component terminates, closing the file, if it receives a shutdownMicroprocess or producerFinished message on its "control" inbox. The message is passed on out of its "signal" outbox.

Development history

SimpleFileWriter - prototyped in /Sketches/filereading/WriteFileAdapter.py


class SimpleFileWriter(Axon.Component.component)

SimpleFileWriter(filename) -> component that writes data to the file

Writes any data sent to its inbox to the specified file.


  • control : to receive shutdown/finished messages
  • inbox : data to write to file


  • outbox : not used
  • signal : shutdown/finished signalling

Methods defined here


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.

__init__(self, filename[, mode])

x.__init__(...) initializes x; see x.__class__.__doc__ for signature


Closes the file handle


Main loop


Returns True if a shutdownMicroprocess or producerFinished message is received.

Also passes the message on out of the "signal" outbox.

writeData(self, data)

Writes the data to the file


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

Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved.

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)