otfbot.services.auth.YamlWordsRealm : API documentation

Method	__init__	Undocumented
Method	userFactory	create a new User
Method	addUser	adds a user to userlist
Method	addGroup	adds a group
Method	requestAvatarId
Method	requestAvatar	Return avatar which provides one of the given interfaces.
Method	save	writes the userlist to a yaml file
Method	load	loads the userlist from a yaml file
Method	_checkpw	Undocumented

Method	itergroups	Return all groups available on this service.
Method	lookupUser	Undocumented
Method	lookupGroup	Retrieve a group by name.

Method	groupFactory	Undocumented
Method	logoutFactory	Undocumented
Method	getGroup	Retrieve the group by the given name.
Method	getUser	Retrieve the user by the given name.
Method	createUser	Create a new user with the given name.
Method	createGroup	Create a new group with the given name.

def __init__(self, name, file): (source)

Undocumented

def userFactory(self, name): (source)

create a new User

Parameters	name	the name of the new user (type: string )
Returns	a BotUser object

def addUser(self, user): (source)

adds a user to userlist

def addGroup(self, group): (source)

adds a group

def requestAvatarId(self, creds): (source)

Parameters	credentials	something which implements one of the interfaces in self.credentialInterfaces.
Returns	a Deferred which will fire a string which identifies an avatar, an empty tuple to specify an authenticated anonymous user (provided as checkers.ANONYMOUS) or fire a Failure(UnauthorizedLogin). Alternatively, return the result itself.
See Also	`twisted.cred.credentials`

def requestAvatar(self, avatarId, mind, *interfaces): (source)

Return avatar which provides one of the given interfaces.

Parameters	avatarId	a string that identifies an avatar, as returned by `ICredentialsChecker.requestAvatarId` (via a Deferred). Alternatively, it may be `twisted.cred.checkers.ANONYMOUS`.
	mind	usually None. See the description of mind in `Portal.login`.
	interfaces	the interface(s) the returned avatar should implement, e.g. `IMailAccount`. See the description of `Portal.login`.
Returns	a deferred which will fire a tuple of (interface, avatarAspect, logout), or the tuple itself. The interface will be one of the interfaces passed in the 'interfaces' argument. The 'avatarAspect' will implement that interface. The 'logout' object is a callable which will detach the mind from the avatar.

o.s.a.YamlWordsRealm(InMemoryWordsRealm) : class documentation