mirror of
https://github.com/correl/SleekXMPP.git
synced 2024-11-27 19:19:54 +00:00
Updated sleekxmpp.exceptions with PEP8 style and docs.
This commit is contained in:
parent
48ba7292bc
commit
c09e9c702c
1 changed files with 37 additions and 8 deletions
|
@ -3,11 +3,40 @@
|
||||||
Copyright (C) 2010 Nathanael C. Fritz
|
Copyright (C) 2010 Nathanael C. Fritz
|
||||||
This file is part of SleekXMPP.
|
This file is part of SleekXMPP.
|
||||||
|
|
||||||
See the file LICENSE for copying permission.
|
See the file LICENSE for copying permission.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
class XMPPError(Exception):
|
class XMPPError(Exception):
|
||||||
def __init__(self, condition='undefined-condition', text=None, etype=None, extension=None, extension_ns=None, extension_args=None):
|
|
||||||
|
"""
|
||||||
|
A generic exception that may be raised while processing an XMPP stanza
|
||||||
|
to indicate that an error response stanza should be sent.
|
||||||
|
|
||||||
|
The exception method for stanza objects extending RootStanza will create
|
||||||
|
an error stanza and initialize any additional substanzas using the
|
||||||
|
extension information included in the exception.
|
||||||
|
|
||||||
|
Meant for use in SleekXMPP plugins and applications using SleekXMPP.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, condition='undefined-condition', text=None, etype=None,
|
||||||
|
extension=None, extension_ns=None, extension_args=None):
|
||||||
|
"""
|
||||||
|
Create a new XMPPError exception.
|
||||||
|
|
||||||
|
Extension information can be included to add additional XML elements
|
||||||
|
to the generated error stanza.
|
||||||
|
|
||||||
|
Arguments:
|
||||||
|
condition -- The XMPP defined error condition.
|
||||||
|
text -- Human readable text describing the error.
|
||||||
|
etype -- The XMPP error type, such as cancel or modify.
|
||||||
|
extension -- Tag name of the extension's XML content.
|
||||||
|
extension_ns -- XML namespace of the extensions' XML content.
|
||||||
|
extension_args -- Content and attributes for the extension
|
||||||
|
element. Same as the additional arguments to
|
||||||
|
the ET.Element constructor.
|
||||||
|
"""
|
||||||
self.condition = condition
|
self.condition = condition
|
||||||
self.text = text
|
self.text = text
|
||||||
self.etype = etype
|
self.etype = etype
|
||||||
|
|
Loading…
Reference in a new issue