Docs for CODE

[ Python Tutorial ] [ Python Libraries ] [ web2py epydoc ]

Description

<type 'type'> extends (<class 'gluon.html.DIV'>,)


    displays code in HTML with syntax highlighting.

    :param attributes: optional attributes:

        - language: indicates the language, otherwise PYTHON is assumed
        - link: can provide a link
        - styles: for styles

    Example::

        {{=CODE("print 'hello world'", language='python', link=None,
            counter=1, styles={})}}


    supported languages are "python", "html_plain", "c", "cpp",
    "web2py", "html".
    The "html" language interprets {{ and }} tags as "web2py" code,
    "html_plain" doesn't.

    if a link='/examples/global/vars/' is provided web2py keywords are linked to
    the online docs.

    the counter is used for line numbering, counter can be None or a prompt
    string.

Attributes


CODE.__class__	<type 'type'> extends (<type 'object'>,) belongs to class <type 'type'> type(object) -> the object's type type(name, bases, dict) -> a new type

CODE.__delattr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__delattr__('name') <==> del x.name

CODE.__delitem__	<type 'instancemethod'> belongs to class <type 'instancemethod'> deletes attribute with name 'i' or component #i. :param i: index if i is a string: the name of the attribute otherwise references to number of the component

CODE.__dict__	<type 'dictproxy'> belongs to class <type 'dictproxy'>

CODE.__doc__	<type 'str'> belongs to class <type 'str'> str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

CODE.__getattribute__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__getattribute__('name') <==> x.name

CODE.__getitem__	<type 'instancemethod'> belongs to class <type 'instancemethod'> gets attribute with name 'i' or component #i. If attribute 'i' is not found returns None :param i: index if i is a string: the name of the attribute otherwise references to number of the component

CODE.__hash__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__hash__() <==> hash(x)

CODE.__init__	<type 'instancemethod'> belongs to class <type 'instancemethod'> :param components: any components that should be nested in this element :param *attributes: any attributes you want to give to this element :raises SyntaxError: when a stand alone tag receives components

CODE.__len__	<type 'instancemethod'> belongs to class <type 'instancemethod'> returns the number of included components

CODE.__module__	<type 'str'> belongs to class <type 'str'> str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

CODE.__new__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> T.__new__(S, ...) -> a new object with type S, a subtype of T

CODE.__nonzero__	<type 'instancemethod'> belongs to class <type 'instancemethod'> always return True

CODE.__reduce__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> helper for pickle

CODE.__reduce_ex__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> helper for pickle

CODE.__repr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__repr__() <==> repr(x)

CODE.__setattr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__setattr__('name', value) <==> x.name = value

CODE.__setitem__	<type 'instancemethod'> belongs to class <type 'instancemethod'> sets attribute with name 'i' or component #i. :param i: index if i is a string: the name of the attribute otherwise references to number of the component :param value: the new value

CODE.__str__	<type 'instancemethod'> belongs to class <type 'instancemethod'> str(COMPONENT) returns equals COMPONENT.xml()

CODE.__weakref__	<type 'getset_descriptor'> belongs to class <type 'getset_descriptor'> list of weak references to the object (if defined)

CODE._fixup	<type 'instancemethod'> belongs to class <type 'instancemethod'> Handling of provided components. Nothing to fixup yet. May be overridden by subclasses, eg for wrapping some components in another component or blocking them.

CODE._postprocessing	<type 'instancemethod'> belongs to class <type 'instancemethod'> Handling of attributes (normally the ones not prefixed with '_'). Nothing to postprocess yet. May be overridden by subclasses

CODE._setnode	<type 'instancemethod'> belongs to class <type 'instancemethod'>

CODE._traverse	<type 'instancemethod'> belongs to class <type 'instancemethod'>

CODE._validate	<type 'instancemethod'> belongs to class <type 'instancemethod'> nothing to validate yet. May be overridden by subclasses

CODE._wrap_components	<type 'instancemethod'> belongs to class <type 'instancemethod'> helper for _fixup. Checks if a component is in allowed_parents, otherwise wraps it in wrap_parent :param allowed_parents: (tuple) classes that the component should be an instance of :param wrap_parent: the class to wrap the component in, if needed :param wrap_lambda: lambda to use for wrapping, if needed

CODE._xml	<type 'instancemethod'> belongs to class <type 'instancemethod'> helper for xml generation. Returns separately: - the component attributes - the generated xml of the inner components Component attributes start with an underscore ('_') and do not have a False or None value. The underscore is removed and the name will be in lower case. A value of True is replaced with the attribute name. :returns: tuple: (attributes, components)

CODE.append	<type 'instancemethod'> belongs to class <type 'instancemethod'> list style appending of components

CODE.element	<type 'instancemethod'> belongs to class <type 'instancemethod'> find the first component that matches the supplied attribute dictionary, or None if nothing could be found Also the components of the components are searched.

CODE.elements	<type 'instancemethod'> belongs to class <type 'instancemethod'> find all component that match the supplied attribute dictionary, or None if nothing could be found All components of the components are searched.

CODE.insert	<type 'instancemethod'> belongs to class <type 'instancemethod'> list style inserting of components

CODE.sibling	<type 'instancemethod'> belongs to class <type 'instancemethod'> find the first sibling component that match the supplied argument list and attribute dictionary, or None if nothing could be found

CODE.siblings	<type 'instancemethod'> belongs to class <type 'instancemethod'> find all sibling components that match the supplied argument list and attribute dictionary, or None if nothing could be found

CODE.tag	<type 'str'> belongs to class <type 'str'> str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

CODE.update	<type 'instancemethod'> belongs to class <type 'instancemethod'> dictionary like updating of the tag attributes

CODE.xml	<type 'instancemethod'> belongs to class <type 'instancemethod'>