[hide private]
[frames] | no frames]

[ Module Hierarchy | Class Hierarchy ]

# Class Hierarchy

- Queue.Queue: Create a queue object with a given maximum size.
  - web2py.gluon.debug.Pipe
- email.message.Message: Basic message object.
  - email.mime.base.MIMEBase: Base class for MIME specializations.
    - web2py.gluon.tools.Mail.Attachment: Email attachment Arguments: payload: path to file or file-like object with read() method filename: name of the attachment stored in message; if set to None, it will be fetched from payload path; file-like object payload must have explicit filename specified content_id: id of the attachment; automatically contained within < and > content_type: content type of the attachment; if set to None, it will be fetched from filename using gluon.contenttype module encoding: encoding of all strings passed to this function (except attachment body) Content ID is used to identify attachments within the html body; in example, attached image with content ID 'photo' may be used in html message as a source of img tag <img src="cid:photo" />.
- google.appengine.ext.db.Property
- imaplib.IMAP4: IMAP4 client class.
  - imaplib.IMAP4_SSL: IMAP4 client class over SSL connection Instantiate with: IMAP4_SSL([host[, port[, keyfile[, certfile]]]]) host - host's name (default: localhost); port - port number (default: standard IMAP4 SSL port).
  - imaplib.IMAP4_stream: IMAP4 client class over a stream Instantiate with: IMAP4_stream(command) where "command" is a string that can be passed to os.popen2() for more documentation see the docstring of the parent class IMAP4.
- imaplib._Authenticator: Private class to provide en/decoding for base64-based authentication conversation.
- logging.Filterer: A base class for loggers and handlers which allows them to share common code.
  - logging.Handler: Handler instances dispatch logging events to specific destinations.
    - web2py.gluon.rocket.NullHandler: A Logging handler to prevent library errors.
- markupbase.ParserBase: Parser base class which provides some common support methods used by the SGML/HTML and XHTML parsers.
  - HTMLParser.HTMLParser: Find tags and other markup and call handler functions.
    - web2py.gluon.html.web2pyHTMLParser: obj = web2pyHTMLParser(text) parses and html/xml text into web2py helpers.
  - sgmllib.SGMLParser
    - htmllib.HTMLParser: This is the basic HTML parser class.
      - web2py.gluon.sanitizer.XssCleaner
- object: The most base type
  - web2py.gluon.portalocker.LockedFile
  - web2py.gluon.main.HttpServer: the web2py web server (Rocket)
  - web2py.gluon.validators.Validator: Root for all validators, mainly for documentation purposes.
    - web2py.gluon.validators.IS_EXPR: example:
    - web2py.gluon.validators.IS_NOT_EMPTY: example:
    - web2py.gluon.validators.IS_SLUG: convert arbitrary text string to a slug
    - web2py.gluon.validators.IS_DATE: example:
      - web2py.gluon.validators.IS_DATE_IN_RANGE: example:
    - web2py.gluon.validators.IS_EMAIL: Checks if field's value is a valid email address.
    - web2py.gluon.validators.IS_UPPER: convert to upper case
    - web2py.gluon.validators.IS_EMPTY_OR: dummy class for testing IS_EMPTY_OR
    - web2py.gluon.validators.IS_DATETIME: example:
      - web2py.gluon.validators.IS_DATETIME_IN_RANGE: example:
    - web2py.gluon.validators.IS_IN_DB: example:
    - web2py.gluon.validators.IS_LOWER: convert to lower case
    - web2py.gluon.validators.IS_NOT_IN_DB: example:
    - web2py.gluon.validators.IS_EQUAL_TO: example:
    - web2py.gluon.validators.IS_MATCH: example:
      - web2py.gluon.validators.IS_ALPHANUMERIC: example:
    - web2py.gluon.validators.IS_INT_IN_RANGE: Determine that the argument is (or can be represented as) an int, and that it falls within the specified range.
    - web2py.gluon.validators.IS_IN_SET: example:
      - web2py.gluon.validators.IS_IN_SUBSET
    - web2py.gluon.validators.IS_LIST_OF
    - web2py.gluon.validators.IS_DECIMAL_IN_RANGE: Determine that the argument is (or can be represented as) a Python Decimal, and that it falls within the specified inclusive range.
    - web2py.gluon.validators.IS_TIME: example:
    - web2py.gluon.validators.CLEANUP: example:
    - web2py.gluon.validators.IS_LENGTH: Checks if length of field's value fits between given boundaries.
    - web2py.gluon.validators.IS_IPV4: Checks if field's value is an IP version 4 address in decimal form.
    - web2py.gluon.validators.IS_GENERIC_URL: Rejects a URL string if any of the following is true: * The string is empty or None * The string uses characters that are not allowed in a URL * The URL scheme specified (if one is specified) is not valid Based on RFC 2396: http://www.faqs.org/rfcs/rfc2396.html This function only checks the URL's syntax.
    - web2py.gluon.validators.IS_UPLOAD_FILENAME: Checks if name and extension of file uploaded through file input matches given criteria.
    - web2py.gluon.validators.IS_FLOAT_IN_RANGE: Determine that the argument is (or can be represented as) a float, and that it falls within the specified inclusive range.
    - web2py.gluon.validators.IS_URL: Rejects a URL string if any of the following is true: * The string is empty or None * The string uses characters that are not allowed in a URL * The string breaks any of the HTTP syntactic rules * The URL scheme specified (if one is specified) is not 'http' or 'https' * The top-level domain (if a host name is specified) does not exist (These rules are based on RFC 2616: http://www.faqs.org/rfcs/rfc2616.html) This function only checks the URL's syntax.
    - web2py.gluon.validators.IS_HTTP_URL: Rejects a URL string if any of the following is true: * The string is empty or None * The string uses characters that are not allowed in a URL * The string breaks any of the HTTP syntactic rules * The URL scheme specified (if one is specified) is not 'http' or 'https' * The top-level domain (if a host name is specified) does not exist Based on RFC 2616: http://www.faqs.org/rfcs/rfc2616.html This function only checks the URL's syntax.
    - web2py.gluon.validators.IS_IMAGE: Checks if file uploaded through file input was saved in one of selected image formats and has dimensions (width and height) within given boundaries.
  - web2py.gluon.rocket.FileLikeSocket
  - int: int(x[, base]) -> integer
    - web2py.gluon.dal.Reference
  - web2py.gluon.cache.CacheAbstract: Abstract class for cache implementations.
    - web2py.gluon.cache.CacheInRam: Ram based caching
    - web2py.gluon.cache.CacheOnDisk: Disk based cache
  - web2py.gluon.compileapp.LoadFactory: Attention: this helper is new and experimental
  - web2py.gluon.compileapp.mybuiltin: NOTE could simple use a dict and populate it, NOTE not sure if this changes things though if monkey patching import.....
  - dict: dict() -> new empty dictionary.
    - web2py.gluon.dal.DAL: an instance of this class represents a database connection
    - web2py.gluon.dal.Table: an instance of this class represents a database table
    - web2py.gluon.dal.Row: a dictionary that lets you do d['a'] as well as d.a this is only used to store a Row
    - web2py.gluon.storage.Storage: A Storage object is like a dictionary except `obj.foo` can be used in addition to `obj['foo']`, and setting obj.foo = None deletes item foo.
      - web2py.gluon.storage.Settings
      - web2py.gluon.globals.Response: defines the response object and the default values of its members response.write( ) can be used to write in the output html
      - web2py.gluon.storage.StorageList: like Storage but missing elements default to [] instead of None
      - web2py.gluon.storage.Messages
      - web2py.gluon.globals.Session: defines the session object and the default values of its members (None)
      - web2py.gluon.globals.Request: defines the request object and the default values of its members...
      - web2py.gluon.restricted.TicketStorage: defines the ticket object and the default values of its members (None)
  - list: list() -> new list list(sequence) -> new list initialized from sequence's items
    - web2py.gluon.dal.SQLCallableList
    - web2py.gluon.storage.List: Like a regular python list but a[i] if i is out of bounds return None instead of IndexOutOfBounds
  - web2py.gluon.newcron.Token
  - web2py.gluon.scheduler.Task
  - web2py.gluon.sqlhtml.FormWidget: helper for SQLFORM to generate form input fields (widget), related to the fieldtype
    - web2py.gluon.sqlhtml.PasswordWidget
    - web2py.gluon.sqlhtml.OptionsWidget
      - web2py.gluon.sqlhtml.CheckboxesWidget
      - web2py.gluon.sqlhtml.MultipleOptionsWidget
      - web2py.gluon.sqlhtml.RadioWidget
    - web2py.gluon.sqlhtml.StringWidget
      - web2py.gluon.sqlhtml.DateWidget
      - web2py.gluon.sqlhtml.DoubleWidget
      - web2py.gluon.sqlhtml.TimeWidget
      - web2py.gluon.sqlhtml.DatetimeWidget
      - web2py.gluon.sqlhtml.IntegerWidget
      - web2py.gluon.sqlhtml.ListWidget
      - web2py.gluon.sqlhtml.DecimalWidget
    - web2py.gluon.sqlhtml.BooleanWidget
    - web2py.gluon.sqlhtml.TextWidget
    - web2py.gluon.sqlhtml.UploadWidget
  - web2py.gluon.dal.GAEF
  - web2py.gluon.tools.PluginManager: Plugin Manager is similar to a storage object but it is a single level singleton this means that multiple instances within the same thread share the same attributes Its constructor is also special.
  - web2py.gluon.rocket.Rocket: The Rocket class is responsible for handling threads and accepting and dispatching connections.
  - web2py.gluon.dal.VirtualCommand
  - web2py.gluon.sqlhtml.AutocompleteWidget
  - web2py.gluon.dal.ConnectionPool
    - web2py.gluon.dal.BaseAdapter
      - web2py.gluon.dal.NoSQLAdapter
        - web2py.gluon.dal.CouchDBAdapter
        - web2py.gluon.dal.GoogleDatastoreAdapter
        - web2py.gluon.dal.IMAPAdapter: IMAP server adapter This class is intended as an interface with email IMAP servers to perform simple queries in the web2py DAL query syntax, so email read, search and other related IMAP mail services (as those implemented by brands like Google(r), and Yahoo!(r) can be managed from web2py applications.
        - web2py.gluon.dal.MongoDBAdapter
      - web2py.gluon.dal.DB2Adapter
      - web2py.gluon.dal.SAPDBAdapter
      - web2py.gluon.dal.FireBirdAdapter
        - web2py.gluon.dal.FireBirdEmbeddedAdapter
      - web2py.gluon.dal.MySQLAdapter
        - web2py.gluon.dal.CubridAdapter
        - web2py.gluon.dal.GoogleSQLAdapter
      - web2py.gluon.dal.MSSQLAdapter
        - web2py.gluon.dal.MSSQL2Adapter
      - web2py.gluon.dal.IngresAdapter
        - web2py.gluon.dal.IngresUnicodeAdapter
      - web2py.gluon.dal.OracleAdapter
      - web2py.gluon.dal.InformixAdapter
      - web2py.gluon.dal.SQLiteAdapter
        - web2py.gluon.dal.JDBCSQLiteAdapter
      - web2py.gluon.dal.TeradataAdapter
      - web2py.gluon.dal.PostgreSQLAdapter
        - web2py.gluon.dal.JDBCPostgreSQLAdapter
  - web2py.gluon.tools.Expose
  - gluon.html.XmlComponent: Abstract root for all Html components
    - gluon.html.DIV: HTML helper, for easy generating and manipulating a DOM structure.
      - web2py.gluon.tools.Recaptcha
  - web2py.gluon.widget.IO
  - web2py.gluon.tools.Service
  - frozenset: frozenset(iterable) --> frozenset object
    - web2py.gluon.contrib.pymysql.DBAPISet
  - exceptions.BaseException: Common base class for all exceptions
    - web2py.gluon.http.HTTP
    - exceptions.Exception: Common base class for all non-exit exceptions.
      - exceptions.Warning: Base class for warning categories.
        - web2py.gluon.contrib.pymysql.err.Warning: Exception raised for important warnings like data truncations while inserting, etc.
      - web2py.gluon.rocket.BadRequest: Exception for when a client sends an incomprehensible request.
      - web2py.gluon.tools.Service.JsonRpcException
      - web2py.gluon.contrib.pymysql.err.MySQLError: Exception related to operation with MySQL.
        - web2py.gluon.contrib.pymysql.err.Error: Exception that is the base class of all other error exceptions (not Warning).
          - web2py.gluon.contrib.pymysql.err.DatabaseError: Exception raised for errors that are related to the database.
            - web2py.gluon.contrib.pymysql.err.NotSupportedError: Exception raised in case a method or database API was used which is not supported by the database, e.g.
            - web2py.gluon.contrib.pymysql.err.IntegrityError: Exception raised when the relational integrity of the database is affected, e.g.
            - web2py.gluon.contrib.pymysql.err.DataError: Exception raised for errors that are due to problems with the processed data like division by zero, numeric value out of range, etc.
            - web2py.gluon.contrib.pymysql.err.InternalError: Exception raised when the database encounters an internal error, e.g.
            - web2py.gluon.contrib.pymysql.err.ProgrammingError: Exception raised for programming errors, e.g.
            - web2py.gluon.contrib.pymysql.err.OperationalError: Exception raised for errors that are related to the database's operation and not necessarily under the control of the programmer, e.g.
          - web2py.gluon.contrib.pymysql.err.InterfaceError: Exception raised for errors that are related to the database interface rather than the database itself.
        - web2py.gluon.contrib.pymysql.err.Warning: Exception raised for important warnings like data truncations while inserting, etc.
      - web2py.gluon.rocket.SocketClosed: Exception for when a socket is closed by the client.
      - socket.error
        - web2py.gluon.rocket.SSLError
      - imaplib.IMAP4.error
        - imaplib.IMAP4.abort
          - imaplib.IMAP4.readonly
      - web2py.gluon.rocket.SocketTimeout: Exception for when a socket times out between requests.
      - web2py.gluon.restricted.RestrictedError: class used to wrap an exception that occurs in the restricted environment below.
      - web2py.gluon.http.HTTP
  - web2py.gluon.dal.SQLALL: Helper class providing a comma-separated string having all the field names (prefixed by table name and '.')
  - web2py.gluon.template.TemplateParser
  - web2py.gluon.dal.Query: a query object necessary to define a set.
  - threading._Verbose
    - threading.Thread
      - web2py.gluon.rocket.Monitor
      - web2py.gluon.rocket.Listener: The Listener class is a class responsible for accepting connections and queuing them to be processed by a worker thread.
      - web2py.gluon.newcron.softcron
      - web2py.gluon.newcron.hardcron
      - web2py.gluon.newcron.extcron
      - web2py.gluon.rocket.Worker: The Worker class is a base class responsible for receiving connections and (a subclass) will run an application to process the the connection
        - web2py.gluon.rocket.FileSystemWorker
        - web2py.gluon.rocket.WSGIWorker
      - web2py.gluon.newcron.cronlauncher
  - web2py.gluon.dal.Rows: A wrapper for the return value of a select.
  - web2py.gluon.validators.CRYPT: example:
  - web2py.gluon.rocket.FuturesMiddleware: Futures middleware that adds a Futures Executor to the environment
  - web2py.gluon.dal.SQLCustomType: allows defining of custom SQL types...
  - web2py.gluon.rewrite.MapUrlOut: logic for mapping outgoing URLs
  - web2py.gluon.cache.Cache: Sets up generic caching, creating an instance of both CacheInRam and CacheOnDisk.
  - web2py.gluon.tools.Auth: Class for authentication, authorization, role based access control.
  - web2py.gluon.languages.lazyT: never to be called explicitly, returned by translator.__call__
  - web2py.gluon.dal.FieldLazy
  - web2py.gluon.highlight.Highlighter: Do syntax highlighting.
  - web2py.gluon.validators.IS_STRONG: example:
  - web2py.gluon.html.XmlComponent: Abstract root for all Html components
    - web2py.gluon.html.DIV: HTML helper, for easy generating and manipulating a DOM structure.
      - web2py.gluon.html.H6
      - web2py.gluon.html.META
      - web2py.gluon.html.SPAN
      - web2py.gluon.html.TH
      - web2py.gluon.html.STYLE
      - web2py.gluon.html.OPTION
      - web2py.gluon.html.B
      - web2py.gluon.html.I
      - web2py.gluon.html.UL: UL Component.
        - web2py.gluon.html.OL
      - web2py.gluon.html.THEAD
      - web2py.gluon.html.TR: TR Component.
      - web2py.gluon.html.INPUT: INPUT Component examples:: >>> INPUT(_type='text', _name='name', value='Max').xml() '<input name="name" type="text" value="Max" />' >>> INPUT(_type='checkbox', _name='checkbox', value='on').xml() '<input checked="checked" name="checkbox" type="checkbox" value="on" />' >>> INPUT(_type='radio', _name='radio', _value='yes', value='yes').xml() '<input checked="checked" name="radio" type="radio" value="yes" />' >>> INPUT(_type='radio', _name='radio', _value='no', value='yes').xml() '<input name="radio" type="radio" value="no" />' the input helper takes two special attributes value= and requires=.
        - web2py.gluon.html.SELECT: example:
        - web2py.gluon.html.TEXTAREA: example:
      - web2py.gluon.html.FIELDSET
      - web2py.gluon.html.EMBED
      - web2py.gluon.html.LI
      - web2py.gluon.html.COLGROUP
      - web2py.gluon.html.IFRAME
      - web2py.gluon.html.OBJECT
      - web2py.gluon.html.CAT
      - web2py.gluon.html.HTML: There are four predefined document type definitions.
      - web2py.gluon.html.LABEL
      - web2py.gluon.html.A
      - web2py.gluon.html.PRE
      - web2py.gluon.html.H4
      - web2py.gluon.html.P: Will replace ``\n`` by ``<br />`` if the `cr2br` attribute is provided.
      - web2py.gluon.html.FORM: example:
        - web2py.gluon.sqlhtml.SQLFORM: SQLFORM is used to map a table (and a current record) into an HTML form given a SQLTable stored in db.table generates an insert form:: SQLFORM(db.table) generates an update form:: record=db.table[some_id] SQLFORM(db.table, record) generates an update with a delete button:: SQLFORM(db.table, record, deletable=True) if record is an int:: record=db.table[record] optional arguments: :param fields: a list of fields that should be placed in the form, default is all.
      - web2py.gluon.html.CENTER
      - web2py.gluon.html.H2
      - web2py.gluon.html.BODY
      - web2py.gluon.html.TBODY
      - web2py.gluon.html.XHTML: This is XHTML version of the HTML helper.
      - web2py.gluon.html.H5
      - web2py.gluon.html.OPTGROUP
      - web2py.gluon.html.IMG
      - web2py.gluon.html.H1
      - web2py.gluon.html.TFOOT
      - web2py.gluon.html.COL
      - web2py.gluon.html.MENU: Used to build menus...
      - web2py.gluon.html.TT
      - web2py.gluon.html.BEAUTIFY: example:: >>> BEAUTIFY(['a', 'b', {'hello': 'world'}]).xml() '<div><table><tr><td><div>a</div></td></tr><tr><td><div>b</div></td></tr><tr><td><div><table><tr><td style="font-weight:bold;">hello</td><td valign="top">:</td><td><div>world</div></td></tr></table></div></td></tr></table></div>' turns any list, dictionary, etc into decent looking html.
      - web2py.gluon.html.HR
      - web2py.gluon.html.TITLE
      - web2py.gluon.html.H3
      - web2py.gluon.html.EM
      - web2py.gluon.html.BR
      - web2py.gluon.html.HEAD
      - web2py.gluon.html.LINK
      - web2py.gluon.html.TD
      - web2py.gluon.html.TABLE: TABLE Component.
        - web2py.gluon.sqlhtml.SQLTABLE: given a Rows object, as returned by a db().select(), generates an html table with the rows.
      - web2py.gluon.html.BUTTON
      - web2py.gluon.html.CODE: displays code in HTML with syntax highlighting.
      - web2py.gluon.html.SCRIPT
      - web2py.gluon.html.LEGEND
    - web2py.gluon.html.MARKMIN: For documentation: http://web2py.com/examples/static/markmin.html
    - web2py.gluon.html.__TAG__: TAG factory example:
    - web2py.gluon.html.XML: use it to wrap a string that contains XML/HTML so that it will not be escaped by the template
  - web2py.gluon.widget.web2pyDialog: Main window dialog
  - web2py.gluon.dal.FieldVirtual
  - web2py.gluon.rocket._WorkItem
  - web2py.gluon.tools.Mail: Class for configuring and sending emails with alternative text / html body, multiple attachments and encryption support
  - gluon.contrib.qdb.Frontend: Qdb generic Frontend interface
    - web2py.gluon.debug.WebDebugger: Qdb web2py interface
  - datetime.time: time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object
  - web2py.gluon.tools.Crud
  - web2py.gluon.languages.translator: this class is instantiated by gluon.compileapp.build_environment as the T object
  - web2py.gluon.rocket.ChunkedReader
  - web2py.gluon.scheduler.TYPE: validator that check whether field is valid json and validate its type
  - web2py.gluon.rewrite.MapUrlIn: logic for mapping incoming URLs
  - web2py.gluon.dal.Set: a Set represents a set of records in the database, the records are identified by the query=Query(...) object.
  - datetime.date: date(year, month, day) --> date object
    - datetime.datetime: datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])
  - web2py.gluon.template.Node: Basic Container Object
    - web2py.gluon.template.BlockNode: Block Container.
      - web2py.gluon.template.Content: Parent Container -- Used as the root level BlockNode.
    - web2py.gluon.template.SuperNode
  - web2py.gluon.rocket.Connection
  - web2py.gluon.scheduler.TaskReport
  - web2py.gluon.dal.Expression
    - web2py.gluon.dal.Field
  - web2py.gluon.custom_import._BaseImporter: The base importer.
    - web2py.gluon.custom_import._DateTrackerImporter: An importer tracking the date of the module files and reloading them when they have changed.
      - web2py.gluon.custom_import._Web2pyDateTrackerImporter: Like _Web2pyImporter but using a _DateTrackerImporter.
    - web2py.gluon.custom_import._Web2pyImporter: The standard web2py importer.
      - web2py.gluon.custom_import._Web2pyDateTrackerImporter: Like _Web2pyImporter but using a _DateTrackerImporter.
- web2py.gluon.dal.DatabaseStoredFile
- web2py.gluon.dal.UseDatabaseStoredFile
  - web2py.gluon.dal.GoogleSQLAdapter
- web2py.gluon.rocket.Future
  - web2py.gluon.rocket.WSGIFuture
- web2py.gluon.rocket.ThreadPool: The ThreadPool class is a container class for all the worker threads.
- web2py.gluon.rocket.ThreadPoolExecutor
  - web2py.gluon.rocket.WSGIExecutor
- win32serviceutil.ServiceFramework
- wsgiref.util.FileWrapper: Wrapper to convert file-like objects to iterables
  - web2py.gluon.rocket.LimitingFileWrapper