Module and Class Hierarchies

[show private | hide private]

[frames | no frames]

Module Hierarchy

dopal: DOPAL - DO Python Azureus Library (version 0.60)
- interact: Interactive Python application which initialises DOPAL to connect with a chosen Azureus server.
- main: Main module for using DOPAL with little effort.
- scripting: This module is designed to provide an 'environment' that allows small scripts to be written without having to deal with the setting up and exception handling that you would normally have to deal with.
- aztypes: Utilities used to convert basic values between DOPAL and Azureus.
- core: Contains the main objects and functions required for DOPAL to be useful.
- debug: Contains functions and objects useful for debugging DOPAL.
- errors: Module containing all errors defined in DOPAL.
- utils: General utility functions.
- xmlutils: XML utility functions.
- classes: Contains basic class definitions for objects - use this module when doing instance checking.
- class_defs: Defines all constants, variables and methods available on classes in Azureus's plugin API.
- convert: Contains classes used to convert an XML structure back into an object structure.
- objects: Defines the object layer framework.
- obj_impl: Implementation of classes defined by Azureus's plugin API.
- persistency: Support module containing code which supports the persistency functionality offered by DOPAL.
- logutils: Module containing various logging-related utilities and classes.

Class Hierarchy

__builtin__.object: The most base type
- dopal.aztypes.AzMethod
- dopal.core.AzureusLink
  - dopal.core.AzureusConnection
    - dopal.core.ExtendedAzureusConnection
      - dopal.objects.AzureusObjectConnection: This connection class generates remote representations of each object available in Azureus.
        
        dopal.main.DopalConnection: A subclass of AzureusObjectConnection which contains an extended API.
- dopal.aztypes.AzureusMethods
- dopal.core.AzureusResponse
  - dopal.core.AtomicResponse
  - dopal.core.ErrorResponse
  - dopal.core.NullResponse: A response class which is used when Azureus returns a response which contains no content at all.
  - dopal.core.StructuredResponse
- dopal.convert.Converter
  - dopal.convert.RemoteObjectConverter
- dopal.debug.DebugGrabber
- dopal.debug.DebugObject
  - dopal.debug.ConnectionDebugObject
    - dopal.debug.MethodRequestDebug
    - dopal.debug.MethodResponseDebug
  - dopal.debug.LinkDebugObject
- dopal.utils.MethodFactory
- dopal.convert.ReaderMixin
  - dopal.convert.XMLStructureReader
    - dopal.convert.RemoteObjectConverter
- dopal.objects.RemoteAttributesMixin
  - dopal.objects.AzureusObject
  - dopal.objects.TypelessRemoteObject
- dopal.objects.RemoteMethodMixin
  - dopal.objects.AzureusObject
  - dopal.objects.TypelessRemoteObject
- dopal.objects.RemoteObject
  - dopal.objects.AzureusObject
  - dopal.objects.TypelessRemoteObject
- dopal.scripting.ScriptEnvironment: The ScriptEnvironment class contains values and methods useful for a script to work with.
- dopal.utils.Sentinel
- __builtin__.type: type(object) -> the object's type type(name, bases, dict) -> a new type
- dopal.convert.WriterMixin
  - dopal.convert.ObjectWriterMixin
    - dopal.convert.RemoteObjectWriterMixin
      - dopal.convert.RemoteObjectConverter
- dopal.scripting._lazyattr
- dopal.aztypes._wrapobject
  - dopal.aztypes._wrapnative
- dopal.xmlutils._XMLObjectBase
  - dopal.xmlutils.UXMLObject: An object representing a block of XML.
  - dopal.xmlutils.XMLObject: Deprecated: An object representing a block of XML.
__builtin__.type: type(object) -> the object's type type(name, bases, dict) -> a new type
- dopal.objects.RemoteAttributeMetaclass
  - dopal.objects.AzureusObjectMetaclass
- dopal.objects.RemoteConstantsMetaclass
  - dopal.objects.AzureusObjectMetaclass
- dopal.objects.RemoteMethodMetaclass
  - dopal.objects.AzureusObjectMetaclass
dopal.aztypes.AzMethod
dopal.aztypes.AzureusMethods
dopal.aztypes.TypeWrapper
dopal.aztypes._wrapobject
- dopal.aztypes._wrapnative
dopal.class_defs.DiskManagerFileInfoDataType
- dopal.obj_impl.AzureusDiskManagerFileInfo
  - dopal.obj_impl.DopalDiskManagerFileInfo
dopal.class_defs.DownloadAnnounceResultDataType
- dopal.obj_impl.AzureusDownloadAnnounceResult
  - dopal.obj_impl.DopalDownloadAnnounceResult
dopal.class_defs.DownloadDataType
- dopal.obj_impl.AzureusDownload
  - dopal.obj_impl.DopalDownload
dopal.class_defs.DownloadScrapeResultDataType
- dopal.obj_impl.AzureusDownloadScrapeResult
  - dopal.obj_impl.DopalDownloadScrapeResult
dopal.class_defs.DownloadStatsDataType
- dopal.obj_impl.AzureusDownloadStats
  - dopal.obj_impl.DopalDownloadStats
dopal.class_defs.LoggerChannelDataType
- dopal.obj_impl.AzureusLoggerChannel
  - dopal.obj_impl.DopalLoggerChannel
dopal.class_defs.PeerDataType
- dopal.obj_impl.AzureusPeer
  - dopal.obj_impl.DopalPeer
dopal.class_defs.PluginConfigDataType
- dopal.obj_impl.AzureusPluginConfig
  - dopal.obj_impl.DopalPluginConfig
dopal.class_defs.PluginInterfaceDataType
- dopal.obj_impl.AzureusPluginInterface
  - dopal.obj_impl.DopalPluginInterface
dopal.class_defs.TorrentDataType
- dopal.obj_impl.AzureusTorrent
  - dopal.obj_impl.DopalTorrent
dopal.convert.Converter
- dopal.convert.RemoteObjectConverter
dopal.convert.ReaderMixin
- dopal.convert.XMLStructureReader
  - dopal.convert.RemoteObjectConverter
dopal.convert.WriterMixin
- dopal.convert.ObjectWriterMixin
  - dopal.convert.RemoteObjectWriterMixin
    - dopal.convert.RemoteObjectConverter
dopal.core.AzureusLink
- dopal.core.AzureusConnection
  - dopal.core.ExtendedAzureusConnection
    - dopal.objects.AzureusObjectConnection: This connection class generates remote representations of each object available in Azureus.
      - dopal.main.DopalConnection: A subclass of AzureusObjectConnection which contains an extended API.
dopal.core.AzureusResponse
- dopal.core.AtomicResponse
- dopal.core.ErrorResponse
- dopal.core.NullResponse: A response class which is used when Azureus returns a response which contains no content at all.
- dopal.core.StructuredResponse
dopal.debug.DebugGrabber
dopal.debug.DebugObject
- dopal.debug.ConnectionDebugObject
  - dopal.debug.MethodRequestDebug
  - dopal.debug.MethodResponseDebug
- dopal.debug.LinkDebugObject
dopal.obj_impl.DopalObjectMixin
- dopal.obj_impl.DopalDiskManagerFileInfo
- dopal.obj_impl.DopalDownload
- dopal.obj_impl.DopalDownloadStats
- dopal.obj_impl.DopalLoggerChannel
- dopal.obj_impl.DopalObjectStatsMixin
  - dopal.obj_impl.DopalDownloadAnnounceResult
  - dopal.obj_impl.DopalDownloadScrapeResult
- dopal.obj_impl.DopalPeer
- dopal.obj_impl.DopalPluginConfig
- dopal.obj_impl.DopalPluginInterface
- dopal.obj_impl.DopalTorrent
dopal.objects.RemoteAttributesMixin
- dopal.objects.AzureusObject
- dopal.objects.TypelessRemoteObject
dopal.objects.RemoteMethodMixin
- dopal.objects.AzureusObject
- dopal.objects.TypelessRemoteObject
dopal.objects.RemoteObject
- dopal.objects.AzureusObject
- dopal.objects.TypelessRemoteObject
dopal.scripting.ScriptEnvironment: The ScriptEnvironment class contains values and methods useful for a script to work with.
dopal.scripting._lazyattr
dopal.utils.MethodFactory
dopal.utils.Sentinel
dopal.xmlutils._XMLObjectBase
- dopal.xmlutils.UXMLObject: An object representing a block of XML.
- dopal.xmlutils.XMLObject: Deprecated: An object representing a block of XML.
exceptions.Exception: Common base class for all exceptions.
- dopal.errors.DopalError: Subclass of all errors in the Dopal library
  - dopal.errors.AzMethodError: Error selecting matching AzMethod
    - dopal.errors.ArgumentWrapError: Error wrapping argument for AzMethod
    - dopal.errors.IncorrectArgumentCountError: Wrong number of arguments given for AzMethod
    - dopal.errors.MethodArgumentWrapError: Error wrapping argument for multiple AzMethods
    - dopal.errors.NoSuchAzMethodError: No method of that name available
  - dopal.errors.AzureusResponseXMLError: Error while parsing XML returned by Azureus
  - dopal.errors.ConnectionlessObjectError: Object has no remote connection
    - dopal.errors.NonRefreshableConnectionlessObjectError: Object cannot be refreshed - no connection attached
  - dopal.errors.ConversionError: Error converting value (Azureus <--> Python)
    - dopal.errors.StructureConversionError: Error converting response structure
      - dopal.errors.ConversionControl: Base class for structured conversion control
        
        dopal.errors.AbortConversion: Structured conversion of object aborted
        dopal.errors.DelayConversion: Structured conversion of object delayed
        dopal.errors.HaltConversion: Structured conversion of object halted
        dopal.errors.SkipConversion: Structured conversion of object skipped
    - dopal.errors.UnwrapError: Error converting remote method result to Python value
      - dopal.errors.InvalidUnwrapTypeError: Invalid unwrap type given.
    - dopal.errors.WrapError: Error converting value to remote method argument
      - dopal.errors.InconsistentWrapTypeError: Object has wrap type different to requested type
      - dopal.errors.InvalidWrapTypeError: Invalid wrap type given.
  - dopal.errors.DopalDeprecationWarning
    - dopal.errors.DopalPendingDeprecationWarning
  - dopal.errors.InvalidRemoteClassTypeError: Invalid remote class type given
  - dopal.errors.LinkError: Error communicating with Azureus (low-level)
  - dopal.errors.MissingRemoteAttributeError: Object does not have remote attribute available
  - dopal.errors.NoDefaultScriptConnectionError
  - dopal.errors.NoEstablishedConnectionError: Connection object has no valid connection established
  - dopal.errors.NonRefreshableObjectError: Object cannot be refreshed - refresh not implemented
    - dopal.errors.NonRefreshableConnectionlessObjectError: Object cannot be refreshed - no connection attached
    - dopal.errors.NonRefreshableIncompleteObjectError: Object cannot be refreshed - insufficient information on object
    - dopal.errors.NonRefreshableObjectTypeError: Object cannot be refreshed - not implemented for this type
    - dopal.errors.StaleObjectReferenceError: Object used belongs to old connection, which doesn't have persistency enabled
  - dopal.errors.NoObjectIDGivenError: No object ID given when needed
  - dopal.errors.RemoteError: Error reported by Azureus
    - dopal.errors.RemoteInternalError: Internal error occurred during remote method invocation
    - dopal.errors.RemoteInvocationError: Unable to invoke remote method
      - dopal.errors.InvalidObjectIDError: Invalid remote object ID given (bad object or bad connection)
        
        dopal.errors.InvalidConnectionIDError: Invalid connection ID used
        dopal.errors.InvalidRemoteObjectError: Invalid remote object ID used
      - dopal.errors.MissingObjectIDError: Missing object ID
      - dopal.errors.NoSuchMethodError: This error is thrown when Azureus reports that the requested method does not exist, or is not allowed.
    - dopal.errors.RemoteMethodError: Error thrown by remote method
  - dopal.errors.ScriptFunctionError: Error occurred inside script function.
- exceptions.StandardError: Base class for all standard Python exceptions.
  - exceptions.AttributeError: Attribute not found.
    - dopal.errors.MissingRemoteAttributeError: Object does not have remote attribute available
    - dopal.errors.NoSuchAzMethodError: No method of that name available
  - exceptions.TypeError: Inappropriate argument type.
    - dopal.errors.InconsistentWrapTypeError: Object has wrap type different to requested type
    - dopal.errors.IncorrectArgumentCountError: Wrong number of arguments given for AzMethod
    - dopal.errors.InvalidRemoteClassTypeError: Invalid remote class type given
    - dopal.errors.InvalidUnwrapTypeError: Invalid unwrap type given.
    - dopal.errors.InvalidWrapTypeError: Invalid wrap type given.
    - dopal.errors.NoEstablishedConnectionError: Connection object has no valid connection established
  - exceptions.ValueError: Inappropriate argument value (of correct type).
    - dopal.errors.NoObjectIDGivenError: No object ID given when needed
- exceptions.Warning: Base class for warning categories.
  - exceptions.DeprecationWarning: Base class for warnings about deprecated features.
    - dopal.errors.DopalDeprecationWarning
      - dopal.errors.DopalPendingDeprecationWarning
  - exceptions.PendingDeprecationWarning: Base class for warnings about features which will be deprecated in the future.
    - dopal.errors.DopalPendingDeprecationWarning

Generated by Epydoc 2.1 on Wed May 03 14:22:34 2006

http://epydoc.sf.net