language: document HasEnvironment.dbs

This commit is contained in:
Sebastien Bourdeauducq 2015-08-22 21:04:23 +08:00
parent d38f1e6796
commit 72616f6f29
1 changed files with 9 additions and 0 deletions

View File

@ -133,6 +133,15 @@ class HasEnvironment:
raise NotImplementedError raise NotImplementedError
def dbs(self): def dbs(self):
"""Returns the device manager, the parameter database and the result
database, in this order.
This is the same order that the constructor takes them, allowing
sub-objects to be created with this idiom to pass the environment
around: ::
sub_object = SomeLibrary(*self.dbs())
"""
return self.__dmgr, self.__pdb, self.__rdb return self.__dmgr, self.__pdb, self.__rdb
def get_argument(self, key, processor=None): def get_argument(self, key, processor=None):