Back to index

moin  1.9.0~rc2
Public Member Functions | Public Attributes | Private Member Functions
MoinMoin.datastruct.backends.LazyGroupsBackend Class Reference
Inheritance diagram for MoinMoin.datastruct.backends.LazyGroupsBackend:
Inheritance graph
[legend]
Collaboration diagram for MoinMoin.datastruct.backends.LazyGroupsBackend:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def is_group_name
def __contains__
def __iter__
def __getitem__
def __repr__
def groups_with_member
def get

Public Attributes

 request
 page_group_regex

Private Member Functions

def _iter_group_members
def _group_has_member

Detailed Description

Definition at line 158 of file __init__.py.


Member Function Documentation

def MoinMoin.datastruct.backends.BaseGroupsBackend.__contains__ (   self,
  group_name 
) [inherited]
Check if a group called <group_name> is available in this backend.

Reimplemented in MoinMoin.datastruct.backends.wiki_groups.WikiGroups, MoinMoin.datastruct.backends.composite_groups.CompositeGroups, MoinMoin.datastruct.backends.config_groups.ConfigGroups, and MoinMoin.datastruct.backends.config_lazy_groups.ConfigLazyGroups.

Definition at line 62 of file __init__.py.

00062 
00063     def __contains__(self, group_name):
00064         """
00065         Check if a group called <group_name> is available in this backend.
00066         """
00067         raise NotImplementedError()

def MoinMoin.datastruct.backends.BaseGroupsBackend.__getitem__ (   self,
  group_name 
) [inherited]
Get a group by its moin group name.

Reimplemented in MoinMoin.datastruct.backends.wiki_groups.WikiGroups, MoinMoin.datastruct.backends.config_groups.ConfigGroups, MoinMoin.datastruct.backends.config_lazy_groups.ConfigLazyGroups, and MoinMoin.datastruct.backends.composite_groups.CompositeGroups.

Definition at line 76 of file __init__.py.

00076 
00077     def __getitem__(self, group_name):
00078         """
00079         Get a group by its moin group name.
00080         """
00081         raise NotImplementedError()

Here is the caller graph for this function:

Iterate over moin group names of the groups defined in this backend.

@return: moin group names

Reimplemented in MoinMoin.datastruct.backends.wiki_groups.WikiGroups, MoinMoin.datastruct.backends.composite_groups.CompositeGroups, MoinMoin.datastruct.backends.config_groups.ConfigGroups, and MoinMoin.datastruct.backends.config_lazy_groups.ConfigLazyGroups.

Definition at line 68 of file __init__.py.

00068 
00069     def __iter__(self):
00070         """
00071         Iterate over moin group names of the groups defined in this backend.
00072 
00073         @return: moin group names
00074         """
00075         raise NotImplementedError()

Reimplemented in MoinMoin.datastruct.backends.composite_groups.CompositeGroups.

Definition at line 82 of file __init__.py.

00082 
00083     def __repr__(self):
00084         return "<%s groups=%s>" % (self.__class__, list(self))

def MoinMoin.datastruct.backends.LazyGroupsBackend._group_has_member (   self,
  group_name,
  member 
) [private]

Reimplemented in MoinMoin.datastruct.backends.config_lazy_groups.ConfigLazyGroups.

Definition at line 163 of file __init__.py.

00163 
00164     def _group_has_member(self, group_name, member):
00165         raise NotImplementedError()
00166 

def MoinMoin.datastruct.backends.LazyGroupsBackend._iter_group_members (   self,
  group_name 
) [private]

Reimplemented in MoinMoin.datastruct.backends.config_lazy_groups.ConfigLazyGroups.

Definition at line 160 of file __init__.py.

00160 
00161     def _iter_group_members(self, group_name):
00162         raise NotImplementedError()

def MoinMoin.datastruct.backends.BaseGroupsBackend.get (   self,
  key,
  default = None 
) [inherited]
Return the group named <key> if key is in the backend, else
default. If default is not given, it defaults to None, so that
this method never raises a GroupDoesNotExistError.

Definition at line 102 of file __init__.py.

00102 
00103     def get(self, key, default=None):
00104         """
00105         Return the group named <key> if key is in the backend, else
00106         default. If default is not given, it defaults to None, so that
00107         this method never raises a GroupDoesNotExistError.
00108         """
00109         try:
00110             return self[key]
00111         except GroupDoesNotExistError:
00112             return default
00113 

Here is the caller graph for this function:

List all group names of groups containing <member>.

@param member: member name [unicode]
@return: list of group names [unicode]

Definition at line 88 of file __init__.py.

00088 
00089     def groups_with_member(self, member):
00090         """
00091         List all group names of groups containing <member>.
00092 
00093         @param member: member name [unicode]
00094         @return: list of group names [unicode]
00095         """
00096         for group_name in self:
00097             try:
00098                 if member in self[group_name]:
00099                     yield group_name
00100             except GroupDoesNotExistError:
00101                 pass

def MoinMoin.datastruct.backends.BaseGroupsBackend.is_group_name (   self,
  member 
) [inherited]

Definition at line 59 of file __init__.py.

00059 
00060     def is_group_name(self, member):
00061         return self.page_group_regex.match(member)

Here is the caller graph for this function:


Member Data Documentation

Definition at line 57 of file __init__.py.

Definition at line 56 of file __init__.py.


The documentation for this class was generated from the following file: