volttron.utils package

class volttron.utils.FileReloader(filetowatch, callback)

Bases: watchdog.events.PatternMatchingEventHandler

on_any_event(event)

Catch-all event handler.

Parameters:event (FileSystemEvent) – The event object representing the file system event.

watchfile

volttron.utils.get_hostname()

volttron.utils.is_ip_private(vip_address)

Determines if the passed vip_address is a private ip address or not.

Parameters:vip_address – A valid ip address. Returns:True if an internal ip address.

Submodules

volttron.utils.docs module

doc_inherit decorator

Usage:

class Foo(object):

def foo(self):

“Frobber” pass

class Bar(Foo):

@doc_inherit def foo(self):

pass

Now, Bar.foo.__doc__ == Bar().foo.__doc__ == Foo.foo.__doc__ == “Frobber”

class volttron.utils.docs.DocInherit(mthd)

Bases: object

Docstring inheriting method descriptor

The class itself is also used as a decorator

get_no_inst(cls)

get_with_inst(obj, cls)

use_parent_doc(func, source)

volttron.utils.docs.doc_inherit

alias of volttron.utils.docs.DocInherit

volttron.utils.persistance module

class volttron.utils.persistance.PersistentDict(filename, flag='c', mode=None, format='pickle', *args, **kwds)

Bases: dict

Persistent dictionary with an API compatible with shelve and anydbm.

The dict is kept in memory, so the dictionary operations run as fast as a regular dictionary.

Write to disk is delayed until close or sync (similar to gdbm’s fast mode).

Input file format is automatically discovered. Output file format is selectable between pickle, json, and csv. All three serialization formats are backed by fast C implementations.

async_sync()

Write dict to disk via worker thread. Don’t mix with sync if it can be helped

close()

sync()

Write dict to disk

volttron.utils.persistance.load_create_store(filename)

volttron.utils.prompt module

volttron.utils.prompt.prompt_response(prompt, valid_answers=None, default=None, echo=True, mandatory=False)

volttron.utils.rmq_config_params module

volttron.utils.rmq_mgmt module

volttron.utils.rmq_setup module

volttron.utils.valid_uuid module

volttron.utils.valid_uuid.validate_uuid4(uuid_string)

Validate that a UUID string is in fact a valid uuid4. Happily, the uuid module does the actual checking for us. It is vital that the ‘version’ kwarg be passed to the UUID() call, otherwise any 32-character hex string is considered valid.