File: ex_declare_function.rst

package info (click to toggle)
python-enaml 0.19.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 13,284 kB
  • sloc: python: 31,443; cpp: 4,499; makefile: 140; javascript: 68; lisp: 53; sh: 20
file content (32 lines) | stat: -rw-r--r-- 1,159 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
..
  NOTE: This RST file was generated by `make examples`.
  Do not edit it directly.
  See docs/source/examples/example_doc_generator.py

Declare Function Example
===============================================================================

An example which demonstrates the use of the ``func`` keyword.

Code in the body of the function has access to the same scope as a bound
expression. This consists of an implicity ``self`` which resolves to the
object on which the function was declared, as well as the identifiers
declared in the enclosing ``enamldef`` block. It also has access to the
dynamic scope which is rooted on ``self``.

.. TIP:: To see this example in action, download it from
 :download:`declare_function <../../../examples/functions/declare_function.enaml>`
 and run::

   $ enaml-run declare_function.enaml


Screenshot
-------------------------------------------------------------------------------

.. image:: images/ex_declare_function.png

Example Enaml Code
-------------------------------------------------------------------------------
.. literalinclude:: ../../../examples/functions/declare_function.enaml
    :language: enaml