File: api.rst

package info (click to toggle)
python-wsme 0.6-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 956 kB
  • ctags: 1,831
  • sloc: python: 8,452; makefile: 138
file content (45 lines) | stat: -rw-r--r-- 831 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
33
34
35
36
37
38
39
40
41
42
43
44
45
API
===

Public API
----------

:mod:`wsme` -- Essentials
~~~~~~~~~~~~~~~~~~~~~~~~~

.. module:: wsme

.. autoclass:: signature([return_type, [arg0_type, [arg1_type, ... ] ] ], body=None, status=None)

.. autoclass:: wsme.types.Base
.. autoclass:: wsattr
.. autoclass:: wsproperty

.. data:: Unset

    Default value of the complex type attributes.

.. autoclass:: WSRoot
    :members:

Internals
---------

:mod:`wsme.types` -- Types
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: wsme.types
    :members: register_type

:mod:`wsme.api` -- API related api
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: wsme.api
    :members: FunctionArgument, FunctionDefinition

:mod:`wsme.rest.args` -- REST protocol argument handling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: wsme.rest.args
    :members: