vnc_cfg_api_server Package

vnc_cfg_api_server Package

The main modules in this package are:
  • vnc_cfg_api_server
  • gen.resource_common
  • gen.resource_xsd
  • vnc_cfg_ifmap
  • vnc_addr_mgmt
  • vnc_cfg_types
  • vnc_cpu_info

bottle Module

Bottle is a fast and simple micro-framework for small web applications. It offers request dispatching (Routes) with url parameter support, templates, a built-in HTTP Server and adapters for many third party WSGI/HTTP-server and template engines - all in a single file and with no dependencies other than the Python Standard Library.

Homepage and documentation: http://bottlepy.org/

Copyright (c) 2012, Marcel Hellkamp. License: MIT (see LICENSE for details)

class vnc_cfg_api_server.bottle.AppEngineServer(host='127.0.0.1', port=8080, **config)

Bases: vnc_cfg_api_server.bottle.ServerAdapter

Adapter for Google App Engine.

class vnc_cfg_api_server.bottle.AppStack

Bases: list

A stack-like list. Calling it returns the head of the stack.

push(value=None)

Add a new Bottle instance to the stack

class vnc_cfg_api_server.bottle.AutoServer(host='127.0.0.1', port=8080, **config)

Bases: vnc_cfg_api_server.bottle.ServerAdapter

Untested.

class vnc_cfg_api_server.bottle.BaseRequest(environ=None)

Bases: object

A wrapper for WSGI environment dictionaries that adds a lot of convenient access methods and properties. Most of them are read-only.

Adding new attributes to a request actually adds them to the environ dictionary (as ‘bottle.request.ext.<name>’). This is the recommended way to store and access request-specific data.

COOKIES

Alias for cookies (deprecated).

GET

An alias for query.

MAX_PARAMS = 100

Maximum number pr GET or POST parameters per request

MEMFILE_MAX = 102400

Maximum size of memory buffer for body in bytes.

POST

The values of forms and files combined into a single FormsDict. Values are either strings (form values) or instances of cgi.FieldStorage (file uploads).

app

Bottle application handling this request.

auth

HTTP authentication data as a (user, password) tuple. This implementation currently supports basic (not digest) authentication only. If the authentication happened at a higher level (e.g. in the front web-server or a middleware), the password field is None, but the user field is looked up from the REMOTE_USER environ variable. On any errors, None is returned.

body

The HTTP request body as a seek-able file-like object. Depending on MEMFILE_MAX, this is either a temporary file or a io.BytesIO instance. Accessing this property for the first time reads and replaces the wsgi.input environ variable. Subsequent accesses just do a seek(0) on the file object.

content_length

The request body length as an integer. The client is responsible to set this header. Otherwise, the real length of the body is unknown and -1 is returned. In this case, body will be empty.

content_type

The Content-Type header as a lowercase-string (default: empty).

cookies

Cookies parsed into a FormsDict. Signed cookies are NOT decoded. Use get_cookie() if you expect signed cookies.

copy()

Return a new Request with a shallow environ copy.

environ

The wrapped WSGI environ dictionary. This is the only real attribute. All other attributes actually are read-only properties.

files

File uploads parsed from an url-encoded or multipart/form-data encoded POST or PUT request body. The values are instances of cgi.FieldStorage. The most important attributes are:

filename
The filename, if specified; otherwise None; this is the client side filename, not the file name on which it is stored (that’s a temporary file you don’t deal with)
file
The file(-like) object from which you can read the data.
value
The value as a string; for file uploads, this transparently reads the file every time you request the value. Do not do this on big files.
forms

Form values parsed from an url-encoded or multipart/form-data encoded POST or PUT request body. The result is retuned as a FormsDict. All keys and values are strings. File uploads are stored separately in files.

fullpath

Request path including script_name (if present).

Return the content of a cookie. To read a Signed Cookie, the secret must match the one used to create the cookie (see BaseResponse.set_cookie()). If anything goes wrong (missing cookie or wrong signature), return a default value.

get_header(name, default=None)

Return the value of a request header, or a given default value.

headers

A WSGIHeaderDict that provides case-insensitive access to HTTP request headers.

is_ajax

Alias for is_xhr. “Ajax” is not the right term.

is_xhr

True if the request was triggered by a XMLHttpRequest. This only works with JavaScript libraries that support the X-Requested-With header (most of the popular libraries do).

json

If the Content-Type header is application/json, this property holds the parsed content of the request body. Only requests smaller than MEMFILE_MAX are processed to avoid memory exhaustion.

method

The REQUEST_METHOD value as an uppercase string.

params

A FormsDict with the combined values of query and forms. File uploads are stored in files.

path

The value of PATH_INFO with exactly one prefixed slash (to fix broken clients and avoid the “empty path” edge case).

path_shift(shift=1)

Shift path segments from path to script_name and vice versa.

Parameters:shift – The number of path segments to shift. May be negative to change the shift direction. (default: 1)
query

The query_string parsed into a FormsDict. These values are sometimes called “URL arguments” or “GET parameters”, but not to be confused with “URL wildcards” as they are provided by the Router.

query_string

The raw query part of the URL (everything in between ? and #) as a string.

remote_addr

The client IP as a string. Note that this information can be forged by malicious clients.

remote_route

A list of all IPs that were involved in this request, starting with the client IP and followed by zero or more proxies. This does only work if all proxies support the `X-Forwarded-For header. Note that this information can be forged by malicious clients.

script_name

The initial portion of the URL’s path that was removed by a higher level (server or routing middleware) before the application was called. This script path is returned with leading and tailing slashes.

url

The full request URI including hostname and scheme. If your app lives behind a reverse proxy or load balancer and you get confusing results, make sure that the X-Forwarded-Host header is set correctly.

urlparts

The url string as an urlparse.SplitResult tuple. The tuple contains (scheme, host, path, query_string and fragment), but the fragment is always empty because it is not visible to the server.

class vnc_cfg_api_server.bottle.BaseResponse(body='', status=None, **headers)

Bases: object

Storage class for a response body as well as headers and cookies.

This class does support dict-like case-insensitive item-access to headers, but is NOT a dict. Most notably, iterating over a response yields parts of the body and not the headers.

COOKIES

A dict-like SimpleCookie instance. This should not be used directly. See set_cookie().

add_header(name, value)

Add an additional response header, not removing duplicates.

charset

Return the charset specified in the content-type header (default: utf8).

content_length

Current value of the ‘Content-Length’ header.

content_type

Current value of the ‘Content-Type’ header.

copy()

Returns a copy of self.

Delete a cookie. Be sure to use the same domain and path settings as used to create the cookie.

get_header(name, default=None)

Return the value of a previously defined header. If there is no header with that name, return a default value.

headerlist

WSGI conform list of (header, value) tuples.

headers

An instance of HeaderDict, a case-insensitive dict-like view on the response headers.

iter_headers()

Yield (header, value) tuples, skipping headers that are not allowed with the current response status code.

Create a new cookie or replace an old one. If the secret parameter is set, create a Signed Cookie (described below).

Parameters:
  • name – the name of the cookie.
  • value – the value of the cookie.
  • secret – a signature key required for signed cookies.

Additionally, this method accepts all RFC 2109 attributes that are supported by cookie.Morsel, including:

Parameters:
  • max_age – maximum age in seconds. (default: None)
  • expires – a datetime object or UNIX timestamp. (default: None)
  • domain – the domain that is allowed to read the cookie. (default: current domain)
  • path – limits the cookie to a given path (default: current path)
  • secure – limit the cookie to HTTPS connections (default: off).
  • httponly – prevents client-side javascript to read this cookie (default: off, requires Python 2.6 or newer).

If neither expires nor max_age is set (default), the cookie will expire at the end of the browser session (as soon as the browser window is closed).

Signed cookies may store any pickle-able object and are cryptographically signed to prevent manipulation. Keep in mind that cookies are limited to 4kb in most browsers.

Warning: Signed cookies are not encrypted (the client can still see the content) and not copy-protected (the client can restore an old cookie). The main intention is to make pickling and unpickling save, not to store secret information at client side.

set_header(name, value)

Create a new response header, replacing any previously defined headers with the same name.

status

A writeable property to change the HTTP response status. It accepts either a numeric code (100-999) or a string with a custom reason phrase (e.g. “404 Brain not found”). Both status_line and status_code are updated accordingly. The return value is always a status string.

status_code

The HTTP status code as an integer (e.g. 404).

status_line

The HTTP status line as a string (e.g. 404 Not Found).

class vnc_cfg_api_server.bottle.BaseTemplate(source=None, name=None, lookup=[], encoding='utf8', **settings)

Bases: object

Base class and minimal API for template adapters

classmethod global_config(key, *args)

This reads or sets the global settings stored in class.settings.

prepare(**options)

Run preparations (parsing, caching, ...). It should be possible to call this again to refresh a template or to update settings.

render(*args, **kwargs)

Render the template with the specified local variables and return a single byte or unicode string. If it is a byte string, the encoding must match self.encoding. This method must be thread-safe! Local variables may be provided in dictionaries (*args) or directly, as keywords (**kwargs).

classmethod search(name, lookup=[])

Search name in all directories specified in lookup. First without, then with common extensions. Return first hit.

class vnc_cfg_api_server.bottle.BjoernServer(host='127.0.0.1', port=8080, **config)

Bases: vnc_cfg_api_server.bottle.ServerAdapter

Fast server written in C: https://github.com/jonashaag/bjoern

class vnc_cfg_api_server.bottle.Bottle(catchall=True, autojson=True)

Bases: object

Each Bottle object represents a single, distinct web application and consists of routes, callbacks, plugins, resources and configuration. Instances are callable WSGI applications.

Parameters:catchall – If true (default), handle all exceptions. Turn off to let debugging middleware handle exceptions.
add_route(route)

Add a route object, but do not change the Route.app attribute.

catchall = None

If true, most exceptions are caught and returned as HTTPError

close()

Close the application and all installed plugins.

config = None

A ConfigDict for app specific configuration.

delete(path=None, method='DELETE', **options)

Equals route() with a DELETE method parameter.

error(code=500)

Decorator: Register an output handler for a HTTP error code

get(path=None, method='GET', **options)

Equals route().

get_url(routename, **kargs)

Return a string that matches a named route

handle(path, method='GET')

(deprecated) Execute the first matching route callback and return the result. HTTPResponse exceptions are caught and returned. If Bottle.catchall is true, other exceptions are caught as well and returned as HTTPError instances (500).

hook(name)

Return a decorator that attaches a callback to a hook. Three hooks are currently implemented:

  • before_request: Executed once before each request
  • after_request: Executed once after each request
  • app_reset: Called whenever reset() is called.
install(plugin)

Add a plugin to the list of plugins and prepare it for being applied to all routes of this application. A plugin may be a simple decorator or an object that implements the Plugin API.

match(environ)

Search for a matching route and return a (Route , urlargs) tuple. The second value is a dictionary with parameters extracted from the URL. Raise HTTPError (404/405) on a non-match.

merge(routes)

Merge the routes of another Bottle application or a list of Route objects into this application. The routes keep their ‘owner’, meaning that the Route.app attribute is not changed.

mount(prefix, app, **options)

Mount an application (Bottle or plain WSGI) to a specific URL prefix. Example:

root_app.mount('/admin/', admin_app)
Parameters:
  • prefix – path prefix or mount-point. If it ends in a slash, that slash is mandatory.
  • app – an instance of Bottle or a WSGI application.

All other parameters are passed to the underlying route() call.

post(path=None, method='POST', **options)

Equals route() with a POST method parameter.

put(path=None, method='PUT', **options)

Equals route() with a PUT method parameter.

reset(route=None)

Reset all routes (force plugins to be re-applied) and clear all caches. If an ID or route object is given, only that specific route is affected.

resources = None

A ResourceManager for application files

route(path=None, method='GET', callback=None, name=None, apply=None, skip=None, **config)

A decorator to bind a function to a request URL. Example:

@app.route('/hello/:name')
def hello(name):
    return 'Hello %s' % name

The :name part is a wildcard. See Router for syntax details.

Parameters:
  • path – Request path or a list of paths to listen to. If no path is specified, it is automatically generated from the signature of the function.
  • method – HTTP method (GET, POST, PUT, ...) or a list of methods to listen to. (default: GET)
  • callback – An optional shortcut to avoid the decorator syntax. route(..., callback=func) equals route(...)(func)
  • name – The name for this route. (default: None)
  • apply – A decorator or plugin or a list of plugins. These are applied to the route callback in addition to installed plugins.
  • skip – A list of plugins, plugin classes or names. Matching plugins are not installed to this route. True skips all.

Any additional keyword arguments are stored as route-specific configuration and passed to plugins (see Plugin.apply()).

run(**kwargs)

Calls run() with the same parameters.

uninstall(plugin)

Uninstall plugins. Pass an instance to remove a specific plugin, a type object to remove all plugins that match that type, a string to remove all plugins with a matching name attribute or True to remove all plugins. Return the list of removed plugins.

wsgi(environ, start_response)

The bottle WSGI-interface.

exception vnc_cfg_api_server.bottle.BottleException

Bases: exceptions.Exception

A base class for exceptions used by bottle.

class vnc_cfg_api_server.bottle.ConfigDict

Bases: dict

A dict-subclass with some extras: You can access keys like attributes. Uppercase attributes create new ConfigDicts and act as name-spaces. Other missing attributes return None. Calling a ConfigDict updates its values and returns itself.

>>> cfg = ConfigDict()
>>> cfg.Namespace.value = 5
>>> cfg.OtherNamespace(a=1, b=2)
>>> cfg
{'Namespace': {'value': 5}, 'OtherNamespace': {'a': 1, 'b': 2}}
vnc_cfg_api_server.bottle.DictProperty

Property that maps to a key in a local dict-like attribute.

class vnc_cfg_api_server.bottle.DieselServer(host='127.0.0.1', port=8080, **config)

Bases: vnc_cfg_api_server.bottle.ServerAdapter

Untested.

vnc_cfg_api_server.bottle.ERROR_PAGE_TEMPLATE = '\n%try:\n %from vnc_cfg_api_server.bottle import DEBUG, HTTP_CODES, request, touni\n <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">\n <html>\n <head>\n <title>Error: {{e.status}}</title>\n <style type="text/css">\n html {background-color: #eee; font-family: sans;}\n body {background-color: #fff; border: 1px solid #ddd;\n padding: 15px; margin: 15px;}\n pre {background-color: #eee; border: 1px solid #ddd; padding: 5px;}\n </style>\n </head>\n <body>\n <h1>Error: {{e.status}}</h1>\n <p>Sorry, the requested URL <tt>{{repr(request.url)}}</tt>\n caused an error:</p>\n <pre>{{e.body}}</pre>\n %if DEBUG and e.exception:\n <h2>Exception:</h2>\n <pre>{{repr(e.exception)}}</pre>\n %end\n %if DEBUG and e.traceback:\n <h2>Traceback:</h2>\n <pre>{{e.traceback}}</pre>\n %end\n </body>\n </html>\n%except ImportError:\n <b>ImportError:</b> Could not generate the error page. Please add bottle to\n the import path.\n%end\n'

The default template used for error pages. Override with @error()

class vnc_cfg_api_server.bottle.EventletServer(host='127.0.0.1', port=8080, **config)

Bases: vnc_cfg_api_server.bottle.ServerAdapter

Untested

class vnc_cfg_api_server.bottle.FapwsServer(host='127.0.0.1', port=8080, **config)

Bases: vnc_cfg_api_server.bottle.ServerAdapter

Extremely fast webserver using libev. See http://www.fapws.org/

class vnc_cfg_api_server.bottle.FileCheckerThread(lockfile, interval)

Bases: threading.Thread

Interrupt main-thread as soon as a changed module file is detected, the lockfile gets deleted or gets to old.

status = None

Is one of ‘reload’, ‘error’ or ‘exit’

class vnc_cfg_api_server.bottle.FormsDict(*a, **k)

Bases: vnc_cfg_api_server.bottle.MultiDict

This MultiDict subclass is used to store request form data. Additionally to the normal dict-like item access methods (which return unmodified data as native strings), this container also supports attribute-like access to its values. Attributes are automatically de- or recoded to match input_encoding (default: ‘utf8’). Missing attributes default to an empty string.

decode(encoding=None)

Returns a copy with all keys and values de- or recoded to match input_encoding. Some libraries (e.g. WTForms) want a unicode dictionary.

input_encoding = 'utf8'

Encoding used for attribute values.

recode_unicode = True

If true (default), unicode strings are first encoded with latin1 and then decoded to match input_encoding.

class vnc_cfg_api_server.bottle.GeventServer(host='127.0.0.1', port=8080, **config)

Bases: vnc_cfg_api_server.bottle.ServerAdapter

Untested. Options:

  • fast (default: False) uses libevent’s http server, but has some issues: No streaming, no pipelining, no SSL.
class vnc_cfg_api_server.bottle.GunicornServer(host='127.0.0.1', port=8080, **config)

Bases: vnc_cfg_api_server.bottle.ServerAdapter

Untested. See http://gunicorn.org/configure.html for options.

vnc_cfg_api_server.bottle.HTTP_CODES = {300: 'Multiple Choices', 301: 'Moved Permanently', 302: 'Found', 303: 'See Other', 304: 'Not Modified', 305: 'Use Proxy', 306: '(Unused)', 307: 'Temporary Redirect', 100: 'Continue', 101: 'Switching Protocols', 400: 'Bad Request', 401: 'Unauthorized', 402: 'Payment Required', 403: 'Forbidden', 404: 'Not Found', 405: 'Method Not Allowed', 406: 'Not Acceptable', 407: 'Proxy Authentication Required', 408: 'Request Timeout', 409: 'Conflict', 410: 'Gone', 411: 'Length Required', 412: 'Precondition Failed', 413: 'Request Entity Too Large', 414: 'Request-URI Too Long', 415: 'Unsupported Media Type', 416: 'Requested Range Not Satisfiable', 417: 'Expectation Failed', 418: "I'm a teapot", 428: 'Precondition Required', 429: 'Too Many Requests', 431: 'Request Header Fields Too Large', 200: 'OK', 201: 'Created', 202: 'Accepted', 203: 'Non-Authoritative Information', 204: 'No Content', 205: 'Reset Content', 206: 'Partial Content', 500: 'Internal Server Error', 501: 'Not Implemented', 502: 'Bad Gateway', 503: 'Service Unavailable', 504: 'Gateway Timeout', 505: 'HTTP Version Not Supported', 511: 'Network Authentication Required'}

A dict to map HTTP status codes (e.g. 404) to phrases (e.g. ‘Not Found’)

class vnc_cfg_api_server.bottle.HeaderDict(*a, **ka)

Bases: vnc_cfg_api_server.bottle.MultiDict

A case-insensitive version of MultiDict that defaults to replace the old value instead of appending it.

class vnc_cfg_api_server.bottle.LocalRequest(environ=None)

Bases: vnc_cfg_api_server.bottle.BaseRequest

A thread-local subclass of BaseRequest with a different set of attribues for each thread. There is usually only one global instance of this class (request). If accessed during a request/response cycle, this instance always refers to the current request (even on a multithreaded server).

bind(environ=None)

Wrap a WSGI environ dictionary.

environ

Thread-local property stored in _lctx.request_environ

class vnc_cfg_api_server.bottle.LocalResponse(body='', status=None, **headers)

Bases: vnc_cfg_api_server.bottle.BaseResponse

A thread-local subclass of BaseResponse with a different set of attribues for each thread. There is usually only one global instance of this class (response). Its attributes are used to build the HTTP response at the end of the request/response cycle.

body

Thread-local property stored in _lctx.response_body

class vnc_cfg_api_server.bottle.MultiDict(*a, **k)

Bases: _abcoll.MutableMapping

This dict stores multiple values per key, but behaves exactly like a normal dict in that it returns only the newest value for any given key. There are special methods available to access the full list of values.

append(key, value)

Add a new value to the list of values for this key.

get(key, default=None, index=-1, type=None)

Return the most recent value for a key.

Parameters:
  • default – The default value to be returned if the key is not present or the type conversion fails.
  • index – An index for the list of available values.
  • type – If defined, this callable is used to cast the value into a specific type. Exception are suppressed and result in the default value to be returned.
getall(key)

Return a (possibly empty) list of values for a key.

getlist(key)

Return a (possibly empty) list of values for a key.

getone(key, default=None, index=-1, type=None)

Aliases for WTForms to mimic other multi-dict APIs (Django)

replace(key, value)

Replace the list of values with a single value.

vnc_cfg_api_server.bottle.Request

alias of BaseRequest

class vnc_cfg_api_server.bottle.ResourceManager(base='./', opener=<built-in function open>, cachemode='all')

Bases: object

This class manages a list of search paths and helps to find and open application-bound resources (files).

Parameters:
  • base – default value for add_path() calls.
  • opener – callable used to open resources.
  • cachemode – controls which lookups are cached. One of ‘all’, ‘found’ or ‘none’.
add_path(path, base=None, index=None, create=False)

Add a new path to the list of search paths. Return False if the path does not exist.

Parameters:
  • path – The new search path. Relative paths are turned into an absolute and normalized form. If the path looks like a file (not ending in /), the filename is stripped off.
  • base – Path used to absolutize relative search paths. Defaults to base which defaults to os.getcwd().
  • index – Position within the list of search paths. Defaults to last index (appends to the list).

The base parameter makes it easy to reference files installed along with a python module or package:

res.add_path('./resources/', __file__)
cache = None

A cache for resolved paths. res.cache.clear() clears the cache.

lookup(name)

Search for a resource and return an absolute file path, or None.

The path list is searched in order. The first match is returend. Symlinks are followed. The result is cached to speed up future lookups.

open(name, mode='r', *args, **kwargs)

Find a resource and return a file object, or raise IOError.

path = None

A list of search paths. See add_path() for details.

vnc_cfg_api_server.bottle.Response

alias of BaseResponse

class vnc_cfg_api_server.bottle.RocketServer(host='127.0.0.1', port=8080, **config)

Bases: vnc_cfg_api_server.bottle.ServerAdapter

Untested.

class vnc_cfg_api_server.bottle.Route(app, rule, method, callback, name=None, plugins=None, skiplist=None, **config)

Bases: object

This class wraps a route callback along with route specific metadata and configuration and applies Plugins on demand. It is also responsible for turing an URL path rule into a regular expression usable by the Router.

all_plugins()

Yield all Plugins affecting this route.

app = None

The application this route is installed to.

callback = None

The original callback with no plugins applied. Useful for introspection.

config = None

Additional keyword arguments passed to the Bottle.route() decorator are stored in this dictionary. Used for route-specific plugin configuration and meta-data.

method = None

The HTTP method as a string (e.g. GET).

name = None

The name of the route (if specified) or None.

plugins = None

A list of route-specific plugins (see Bottle.route()).

prepare()

Do all on-demand work immediately (useful for debugging).

reset()

Forget any cached values. The next time call is accessed, all plugins are re-applied.

rule = None

The path-rule string (e.g. /wiki/:page).

skiplist = None

A list of plugins to not apply to this route (see Bottle.route()).

exception vnc_cfg_api_server.bottle.RouteBuildError

Bases: vnc_cfg_api_server.bottle.RouteError

The route could not been built

exception vnc_cfg_api_server.bottle.RouteError

Bases: vnc_cfg_api_server.bottle.BottleException

This is a base class for all routing related exceptions

exception vnc_cfg_api_server.bottle.RouteReset

Bases: vnc_cfg_api_server.bottle.BottleException

If raised by a plugin or request handler, the route is reset and all plugins are re-applied.

exception vnc_cfg_api_server.bottle.RouteSyntaxError

Bases: vnc_cfg_api_server.bottle.RouteError

The route parser found something not supported by this router

class vnc_cfg_api_server.bottle.Router(strict=False)

Bases: object

A Router is an ordered collection of route->target pairs. It is used to efficiently match WSGI requests against a number of routes and return the first target that satisfies the request. The target may be anything, usually a string, ID or callable object. A route consists of a path-rule and a HTTP method.

The path-rule is either a static path (e.g. /contact) or a dynamic path that contains wildcards (e.g. /wiki/<page>). The wildcard syntax and details on the matching order are described in docs:routing.

add(rule, method, target, name=None)

Add a new route or replace the target for an existing route.

add_filter(name, func)

Add a filter. The provided function is called with the configuration string as parameter and must return a (regexp, to_python, to_url) tuple. The first element is a string, the last two are callables or None.

build(_name, *anons, **query)

Build an URL by filling the wildcards in a rule.

match(environ)

Return a (target, url_agrs) tuple or raise HTTPError(400/404/405).

parse_rule(rule)

Parses a rule into a (name, filter, conf) token stream. If mode is None, name contains a static rule part.

rule_syntax = <_sre.SRE_Pattern object at 0x3f17870>

Sorry for the mess. It works. Trust me.

strict_order = None

If true, static routes are no longer checked first.

class vnc_cfg_api_server.bottle.SimpleTALTemplate(source=None, name=None, lookup=[], encoding='utf8', **settings)

Bases: vnc_cfg_api_server.bottle.BaseTemplate

Deprecated, do not use.

class vnc_cfg_api_server.bottle.TemplatePlugin

Bases: object

This plugin applies the view() decorator to all routes with a template config parameter. If the parameter is a tuple, the second element must be a dict with additional options (e.g. template_engine) or default variables for the template.

class vnc_cfg_api_server.bottle.TornadoServer(host='127.0.0.1', port=8080, **config)

Bases: vnc_cfg_api_server.bottle.ServerAdapter

The super hyped asynchronous server by facebook. Untested.

class vnc_cfg_api_server.bottle.TwistedServer(host='127.0.0.1', port=8080, **config)

Bases: vnc_cfg_api_server.bottle.ServerAdapter

Untested.

class vnc_cfg_api_server.bottle.WSGIHeaderDict(environ)

Bases: _abcoll.MutableMapping

This dict-like class wraps a WSGI environ dict and provides convenient access to HTTP_* fields. Keys and values are native strings (2.x bytes or 3.x unicode) and keys are case-insensitive. If the WSGI environment contains non-native string values, these are de- or encoded using a lossless ‘latin1’ character set.

The API will remain stable even on changes to the relevant PEPs. Currently PEP 333, 444 and 3333 are supported. (PEP 444 is the only one that uses non-native strings.)

cgikeys = ('CONTENT_TYPE', 'CONTENT_LENGTH')

List of keys that do not have a HTTP_ prefix.

raw(key, default=None)

Return the header value as is (may be bytes or unicode).

vnc_cfg_api_server.bottle.abort(code=500, text='Unknown Error: Application stopped.')

Aborts execution and causes a HTTP error.

vnc_cfg_api_server.bottle.auth_basic(check, realm='private', text='Access denied')

Callback decorator to require HTTP auth (basic). TODO: Add route(check_auth=...) parameter.

vnc_cfg_api_server.bottle.cached_property

A property that is only computed once per instance and then replaces itself with an ordinary attribute. Deleting the attribute resets the property.

vnc_cfg_api_server.bottle.cookie_decode(data, key)

Verify and decode an encoded string. Return an object or None.

vnc_cfg_api_server.bottle.cookie_encode(data, key)

Encode and sign a pickle-able object. Return a (byte) string

vnc_cfg_api_server.bottle.cookie_is_encoded(data)

Return True if the argument looks like a encoded cookie.

vnc_cfg_api_server.bottle.debug(mode=True)

Change the debug level. There is only one debug level supported at the moment.

vnc_cfg_api_server.bottle.delete(*a, **ka)

Equals route() with a DELETE method parameter.

vnc_cfg_api_server.bottle.error(*a, **ka)

Decorator: Register an output handler for a HTTP error code

vnc_cfg_api_server.bottle.ext = <module 'vnc_cfg_api_server.bottle.ext' from '/home/rajreddy/ctrlplane/build/debug/cfgm/api-server/vnc_cfg_api_server/bottle.pyc'>

A virtual package that redirects import statements. Example: import bottle.ext.sqlite actually imports bottle_sqlite.

vnc_cfg_api_server.bottle.get(*a, **ka)

Equals route().

vnc_cfg_api_server.bottle.hook(*a, **ka)

Return a decorator that attaches a callback to a hook. Three hooks are currently implemented:

  • before_request: Executed once before each request
  • after_request: Executed once after each request
  • app_reset: Called whenever reset() is called.
vnc_cfg_api_server.bottle.html_escape(string)

Escape HTML special characters &<> and quotes '".

vnc_cfg_api_server.bottle.html_quote(string)

Escape and quote a string to be used as an HTTP attribute.

vnc_cfg_api_server.bottle.install(*a, **ka)

Add a plugin to the list of plugins and prepare it for being applied to all routes of this application. A plugin may be a simple decorator or an object that implements the Plugin API.

vnc_cfg_api_server.bottle.lazy_attribute

A property that caches itself to the class object.

vnc_cfg_api_server.bottle.load(target, **namespace)

Import a module or fetch an object from a module.

  • package.module returns module as a module object.
  • pack.mod:name returns the module variable name from pack.mod.
  • pack.mod:func() calls pack.mod.func() and returns the result.

The last form accepts not only function calls, but any type of expression. Keyword arguments passed to this function are available as local variables. Example: import_string('re:compile(x)', x='[a-z]')

vnc_cfg_api_server.bottle.load_app(target)

Load a bottle application from a module and make sure that the import does not affect the current default application, but returns a separate application object. See load() for the target parameter.

vnc_cfg_api_server.bottle.local = <thread._local object at 0x41a2a10>

A thread-safe namespace. Not used by Bottle.

vnc_cfg_api_server.bottle.make_default_app_wrapper(name)

Return a callable that relays calls to the current default app.

vnc_cfg_api_server.bottle.mount(*a, **ka)

Mount an application (Bottle or plain WSGI) to a specific URL prefix. Example:

root_app.mount('/admin/', admin_app)
Parameters:
  • prefix – path prefix or mount-point. If it ends in a slash, that slash is mandatory.
  • app – an instance of Bottle or a WSGI application.

All other parameters are passed to the underlying route() call.

vnc_cfg_api_server.bottle.parse_auth(header)

Parse rfc2617 HTTP authentication header string (basic) and return (user,pass) tuple or None

vnc_cfg_api_server.bottle.parse_date(ims)

Parse rfc1123, rfc850 and asctime timestamps and return UTC epoch.

vnc_cfg_api_server.bottle.parse_range_header(header, maxlen=0)

Yield (start, end) ranges parsed from a HTTP Range header. Skip unsatisfiable ranges. The end index is non-inclusive.

vnc_cfg_api_server.bottle.path_shift(script_name, path_info, shift=1)

Shift path fragments from PATH_INFO to SCRIPT_NAME and vice versa.

Returns:

The modified paths.

Parameters:
  • script_name – The SCRIPT_NAME path.
  • script_name – The PATH_INFO path.
  • shift – The number of path fragments to shift. May be negative to change the shift direction. (default: 1)
vnc_cfg_api_server.bottle.post(*a, **ka)

Equals route() with a POST method parameter.

vnc_cfg_api_server.bottle.put(*a, **ka)

Equals route() with a PUT method parameter.

vnc_cfg_api_server.bottle.redirect(url, code=None)

Aborts execution and causes a 303 or 302 redirect, depending on the HTTP protocol version.

vnc_cfg_api_server.bottle.request = <LocalRequest: GET http://127.0.0.1/>

A thread-safe instance of LocalRequest. If accessed from within a request callback, this instance always refers to the current request (even on a multithreaded server).

vnc_cfg_api_server.bottle.response = Content-Type: text/html; charset=UTF-8

A thread-safe instance of LocalResponse. It is used to change the HTTP response for the current request.

vnc_cfg_api_server.bottle.route(*a, **ka)

A decorator to bind a function to a request URL. Example:

@app.route('/hello/:name')
def hello(name):
    return 'Hello %s' % name

The :name part is a wildcard. See Router for syntax details.

Parameters:
  • path – Request path or a list of paths to listen to. If no path is specified, it is automatically generated from the signature of the function.
  • method – HTTP method (GET, POST, PUT, ...) or a list of methods to listen to. (default: GET)
  • callback – An optional shortcut to avoid the decorator syntax. route(..., callback=func) equals route(...)(func)
  • name – The name for this route. (default: None)
  • apply – A decorator or plugin or a list of plugins. These are applied to the route callback in addition to installed plugins.
  • skip – A list of plugins, plugin classes or names. Matching plugins are not installed to this route. True skips all.

Any additional keyword arguments are stored as route-specific configuration and passed to plugins (see Plugin.apply()).

vnc_cfg_api_server.bottle.run(app=None, server='wsgiref', host='127.0.0.1', port=8080, interval=1, reloader=False, quiet=False, plugins=None, debug=False, **kargs)

Start a server instance. This method blocks until the server terminates.

Parameters:
  • app – WSGI application or target string supported by load_app(). (default: default_app())
  • server – Server adapter to use. See server_names keys for valid names or pass a ServerAdapter subclass. (default: wsgiref)
  • host – Server address to bind to. Pass 0.0.0.0 to listens on all interfaces including the external one. (default: 127.0.0.1)
  • port – Server port to bind to. Values below 1024 require root privileges. (default: 8080)
  • reloader – Start auto-reloading server? (default: False)
  • interval – Auto-reloader interval in seconds (default: 1)
  • quiet – Suppress output to stdout and stderr? (default: False)
  • options – Options passed to the server adapter.
vnc_cfg_api_server.bottle.static_file(filename, root, mimetype='auto', download=False)

Open a file in a safe way and return HTTPResponse with status code 200, 305, 401 or 404. Set Content-Type, Content-Encoding, Content-Length and Last-Modified header. Obey If-Modified-Since header and HEAD requests.

vnc_cfg_api_server.bottle.template(*args, **kwargs)

Get a rendered template as a string iterator. You can use a name, a filename or a template string as first parameter. Template rendering arguments can be passed as dictionaries or directly (as keyword arguments).

vnc_cfg_api_server.bottle.uninstall(*a, **ka)

Uninstall plugins. Pass an instance to remove a specific plugin, a type object to remove all plugins that match that type, a string to remove all plugins with a matching name attribute or True to remove all plugins. Return the list of removed plugins.

vnc_cfg_api_server.bottle.url(*a, **ka)

Return a string that matches a named route

vnc_cfg_api_server.bottle.validate(**vkargs)

Validates and manipulates keyword arguments by user defined callables. Handles ValueError and missing arguments by raising HTTPError(403).

vnc_cfg_api_server.bottle.view(tpl_name, **defaults)

Decorator: renders a template for a handler. The handler can control its behavior like that:

  • return a dict of template vars to fill out the template
  • return something other than a dict and the view decorator will not process the template, but return the handler result as is. This includes returning a HTTPResponse(dict) to get, for instance, JSON with autojson or other castfilters.
vnc_cfg_api_server.bottle.yieldroutes(func)

Return a generator for routes that match the signature (name, args) of the func parameter. This may yield more than one route if the function takes optional keyword arguments. The output is best described by example:

a()         -> '/a'
b(x, y)     -> '/b/:x/:y'
c(x, y=5)   -> '/c/:x' and '/c/:x/:y'
d(x=5, y=6) -> '/d' and '/d/:x' and '/d/:x/:y'

provision_defaults Module

vnc_addr_mgmt Module

Attention

Fix the license string

class vnc_cfg_api_server.vnc_addr_mgmt.Subnet(name, prefix, prefix_len, gw=None, db_conn=None)

Bases: object

Create a subnet with prefix and len

Gateway (if provided) is made unavailable for assignment. Inuse mask represent addresses already assigned and in use during previous incarnations of api server. These are also taken out of free pool to prevent duplicate assignment.

vnc_auth Module

vnc_auth_keystone Module

vnc_cfg_api_server Module

This is the main module in vnc_cfg_api_server package. It manages interaction between http/rest, address management, authentication and database interfaces.

class vnc_cfg_api_server.vnc_cfg_api_server.VncApiServer(args_str=None)

Bases: vnc_cfg_api_server.gen.vnc_api_server_gen.VncApiServerGen

This is the manager class co-ordinating all classes present in the package

vnc_cfg_ifmap Module

Attention

Fix the license string

vnc_cfg_types Module

vnc_cpu_info Module

Attention

Fix the license string

vnc_perms Module

Subpackages