Class s.c.d.BaseDomain(object):

Part of spamfighter.core.domain View Source View In Hierarchy

Домен - единица настроек, привязки локальных элементов внутренного устройства СпамоБорца.

Все домены связаны в дерево, начинающееся главным доменом (глобально известным серверу).

Базовый класс доменов представляет домены "в памяти", без какого-либо сохранения, а также без "детей".

Instance Variables_nameимя домена (type: str )
_keyключ домена (type: str )
_parentпредок данного домена (type: IDomain )
_dictхеш (словарь) атрибутов, заданных в данном домене (type: dict )
_childrenхэш поддоменов по их именам (type: dict )
Method __init__ Конструктор.
Method name Имя домена (относительно пути).
Method key Ключ домена. Уникальное и постоянное свойство
Method parent Получить предка данного домена.
Method children Получить список "дочерних" доменов.
Method createSubdomain Создать дочерний поддомен.
Method walk "Пройти" по пути от текущего домена.
Method get Получить значение свойства домена.
Method has Есть ли у домена указанное свойство?
Method delete Удалить свойство из домена.
Method set Установить значение свойства в домене.
Method list Получить список имён свойств домена.
def __init__(self, key=None, name=None, parent=None, dict=None): (source)
Конструктор.
Parametersparentпредок текущего домена (type: IDomain )
dictначальное значение домена (type: dict )
def name(self): (source)
Имя домена (относительно пути).

Если домен корневой или не содержится в пути, имя может быть None.

Returnsимя домена (type: str )
def key(self): (source)
Ключ домена. Уникальное и постоянное свойство каждого домена.
Returnsключ домена (type: str )
def parent(self): (source)
Получить предка данного домена.

Если предка нет, будет возвращено None.

Returns (type: IDomain )
def children(self): (source)
Получить список "дочерних" доменов.
ReturnsDeferred, результат - хэш (имя домена: домен) (dict(IDomain)) (type: twisted.internet.defer.Deferred )
def createSubdomain(self, name): (source)
Создать дочерний поддомен.
Parametersnameимя поддомена (type: str )
ReturnsDeferred с созданным поддоменом, IDomain (type: twisted.internet.defer.Deferred )
RaisesDomainDuplicateErrorдва поддомена с одинаковым именем не могут существовать
def walk(self, path): (source)
"Пройти" по пути от текущего домена.
Parameterspathпуть относительно текущего домена, строка со слэшами (type: str )
ReturnsDeferred, найденный домен (IDomain) (type: twisted.internet.defer.Deferred )
RaisesDomainPathErrorдомен не найден
def get(self, property): (source)
Получить значение свойства домена.

Если текущий домен не содержит информацию о данном свойстве, будет предпринято обращение к предку домена за данным свойством.

Parameterspropertyимя свойства (type: str )
Returnsзначение свойства
def has(self, property): (source)
Есть ли у домена указанное свойство?
Parameterspropertyимя свойства (type: str )
Returns (type: bool )
def delete(self, property): (source)
Удалить свойство из домена.

При следующем обращении к свойству оно будет получено через предка домена, т.е. это эквивалентно сбросу на "значение по умолчанию".

Parameterspropertyимя свойства (type: str )
ReturnsDeferred о результате операции (type: twisted.internet.defer.Deferred )
def set(self, property, value): (source)
Установить значение свойства в домене.

Данный метод может также создать свойство, если оно ранее не существовало и переопределить свойство домена-предка.

Parameterspropertyимя свойства (type: str )
valueзначение свойства
ReturnsDeferred о результате операции (type: twisted.internet.defer.Deferred )
def list(self): (source)
Получить список имён свойств домена.
Returnsсписок имён свойств (type: list(str) )
API Documentation for SpamFighter, generated by pydoctor at 2009-02-27 11:58:37.