Framework.OSS package

Submodules

Framework.OSS.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) 2015, Marcel Hellkamp. License: MIT (see LICENSE for details)

class Framework.OSS.bottle.AiohttpServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

Untested. aiohttp https://pypi.python.org/pypi/aiohttp/

run(handler)

class Framework.OSS.bottle.AppEngineServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

Adapter for Google App Engine.

quiet = True

run(handler)

class Framework.OSS.bottle.AppStack

Bases: list

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

default

new_app(value=None)

Add a new Bottle instance to the stack

push(value=None)

Add a new Bottle instance to the stack

class Framework.OSS.bottle.AutoServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

Untested.

adapters = [<class 'Framework.OSS.bottle.WaitressServer'>, <class 'Framework.OSS.bottle.PasteServer'>, <class 'Framework.OSS.bottle.TwistedServer'>, <class 'Framework.OSS.bottle.CherryPyServer'>, <class 'Framework.OSS.bottle.WSGIRefServer'>]

run(handler)

class Framework.OSS.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.

GET

An alias for query.

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.

chunked

True if Chunked transfer encoding was.

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 multipart/form-data encoded POST or PUT request body. The values are instances of FileUpload.

forms

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

fullpath

Request path including script_name (if present).

get(value, default=None)

get_cookie(key, default=None, secret=None)

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 or application/json-rpc, this property holds the parsed content of the request body. Only requests smaller than MEMFILE_MAX are processed to avoid memory exhaustion. Invalid JSON raises a 400 error response.

keys()

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.

route

The bottle Route object that matches this request.

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.

url_args

The arguments extracted from the URL.

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 Framework.OSS.bottle.BaseResponse(body='', status=None, headers=None, **more_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.

Parameters:

• body – The response body as one of the supported types.
• status – Either an HTTP status code (e.g. 200) or a status line including the reason phrase (e.g. ‘200 OK’).
• headers – A dictionary or a list of name-value pairs.

Additional keyword arguments are added to the list of headers. Underscores in the header name are replaced with dashes.

add_header(name, value)

Add an additional response header, not removing duplicates.

bad_headers = {204: set(['Content-Length', 'Content-Type']), 304: set(['Allow', 'Content-Encoding', 'Content-Language', 'Content-Length', 'Content-Md5', 'Content-Range', 'Content-Type', 'Last-Modified'])}

charset

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

close()

content_length

Current value of the ‘Content-Length’ header.

content_type

Current value of the ‘Content-Type’ header.

copy(cls=None)

Returns a copy of self.

default_content_type = 'text/html; charset=UTF-8'

default_status = 200

delete_cookie(key, **kwargs)

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

expires

Current value of the ‘Expires’ header.

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.

set_cookie(name, value, secret=None, **options)

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 Framework.OSS.bottle.BaseTemplate(source=None, name=None, lookup=None, encoding='utf8', **settings)

Bases: object

Base class and minimal API for template adapters

defaults = {}

extensions = ['tpl', 'html', 'thtml', 'stpl']

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=None)

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

settings = {}

class Framework.OSS.bottle.BjoernServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

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

run(handler)

class Framework.OSS.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_hook(name, func)

Attach a callback to a hook. Three hooks are currently implemented:

before_request

Executed once before each request. The request context is available, but no routing has happened yet.

after_request

Executed once after each request regardless of its outcome.

app_reset

Called whenever Bottle.reset() is called.

add_route(route)

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

catchall

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.

default_error_handler(res)

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

hook(name)

Return a decorator that attaches a callback to a hook. See add_hook() for details.

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:

parent_app.mount('/prefix/', child_app)

Parameters:

• prefix – path prefix or mount-point.
• app – an instance of Bottle or a WSGI application.

Plugins from the parent application are not applied to the routes of the mounted child application. If you need plugins in the child application, install them separately.

While it is possible to use path wildcards within the prefix path (Bottle childs only), it is highly discouraged.

The prefix path must end with a slash. If you want to access the root of the child application via /prefix in addition to /prefix/, consider adding a route with a 307 redirect to the parent application.

patch(path=None, method='PATCH', **options)

Equals route() with a PATCH method parameter.

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.

remove_hook(name, func)

Remove a callback from a hook.

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.

trigger_hook(_Bottle__name, *args, **kwargs)

Trigger a hook and return a list of results.

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 Framework.OSS.bottle.BottleException

Bases: exceptions.Exception

A base class for exceptions used by bottle.

class Framework.OSS.bottle.CGIServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

quiet = True

run(handler)

class Framework.OSS.bottle.CheetahTemplate(source=None, name=None, lookup=None, encoding='utf8', **settings)

Bases: Framework.OSS.bottle.BaseTemplate

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).

class Framework.OSS.bottle.CherryPyServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

run(handler)

class Framework.OSS.bottle.ConfigDict

Bases: dict

A dict-like configuration storage with additional support for namespaces, validators, meta-data, on_change listeners and more.

load_config(filename)

Load values from an *.ini style config file.

If the config file contains sections, their names are used as namespaces for the values within. The two special sections DEFAULT and bottle refer to the root namespace (no prefix).

load_dict(source, namespace='')

Load values from a dictionary structure. Nesting can be used to represent namespaces.

>>> c = ConfigDict()
>>> c.load_dict({'some': {'namespace': {'key': 'value'} } })
{'some.namespace.key': 'value'}

load_module(path, squash)

Load values from a Python module. :param squash: Squash nested dicts into namespaces by using

load_dict(), otherwise use update()

Example: load_config(‘my.app.settings’, True) Example: load_config(‘my.app.settings’, False)

meta_get(key, metafield, default=None)

Return the value of a meta field for a key.

meta_list(key)

Return an iterable of meta field names defined for a key.

meta_set(key, metafield, value)

Set the meta field for a key to a new value.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

update(*a, **ka)

If the first parameter is a string, all keys are prefixed with this namespace. Apart from that it works just as the usual dict.update(). Example: update('some.namespace', key='value')

class Framework.OSS.bottle.DictProperty(attr, key=None, read_only=False)

Bases: object

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

class Framework.OSS.bottle.DieselServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

Untested.

run(handler)

Framework.OSS.bottle.ERROR_PAGE_TEMPLATE = '\n%try:\n %from Framework.OSS.bottle import DEBUG, request\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-serif;}\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 Framework.OSS.bottle.EventletServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

Untested. Options:

• backlog adjust the eventlet backlog parameter which is the maximum number of queued connections. Should be at least 1; the maximum value is system-dependent.
• family: (default is 2) socket family, optional. See socket documentation for available families.

run(handler)

class Framework.OSS.bottle.FapwsServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

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

run(handler)

class Framework.OSS.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 too old.

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

status = None

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

class Framework.OSS.bottle.FileUpload(fileobj, name, filename, headers=None)

Bases: object

content_length

Current value of the ‘Content-Length’ header.

content_type

Current value of the ‘Content-Type’ header.

file = None

Open file(-like) object (BytesIO buffer or temporary file)

filename

Name of the file on the client file system, but normalized to ensure file system compatibility. An empty filename is returned as ‘empty’.

Only ASCII letters, digits, dashes, underscores and dots are allowed in the final filename. Accents are removed, if possible. Whitespace is replaced by a single dash. Leading or tailing dots or dashes are removed. The filename is limited to 255 characters.

headers = None

A HeaderDict with additional headers (e.g. content-type)

name = None

Name of the upload form field

raw_filename = None

Raw filename as sent by the client (may contain unsafe characters)

save(destination, overwrite=False, chunk_size=65536)

Save file to disk or copy its content to an open file(-like) object. If destination is a directory, filename is added to the path. Existing files are not overwritten by default (IOError).

Parameters:

• destination – File path, directory or file(-like) object.
• overwrite – If True, replace existing files. (default: False)
• chunk_size – Bytes to read at a time. (default: 64kb)

class Framework.OSS.bottle.FlupFCGIServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

run(handler)

class Framework.OSS.bottle.FormsDict(*a, **k)

Bases: Framework.OSS.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.

getunicode(name, default=None, encoding=None)

Return the value as a unicode string, or the default.

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 Framework.OSS.bottle.GeventServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

Untested. Options:

• See gevent.wsgi.WSGIServer() documentation for more options.

run(handler)

class Framework.OSS.bottle.GeventSocketIOServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

run(handler)

class Framework.OSS.bottle.GunicornServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

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

run(handler)

exception Framework.OSS.bottle.HTTPError(status=None, body=None, exception=None, traceback=None, **more_headers)

Bases: Framework.OSS.bottle.HTTPResponse

default_status = 500

exception Framework.OSS.bottle.HTTPResponse(body='', status=None, headers=None, **more_headers)

Bases: Framework.OSS.bottle.BaseResponse, Framework.OSS.bottle.BottleException

apply(other)

Framework.OSS.bottle.HTTP_CODES = {100: 'Continue', 101: 'Switching Protocols', 200: 'OK', 201: 'Created', 202: 'Accepted', 203: 'Non-Authoritative Information', 204: 'No Content', 205: 'Reset Content', 206: 'Partial Content', 300: 'Multiple Choices', 301: 'Moved Permanently', 302: 'Found', 303: 'See Other', 304: 'Not Modified', 305: 'Use Proxy', 306: '(Unused)', 307: 'Temporary Redirect', 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', 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 Framework.OSS.bottle.HeaderDict(*a, **ka)

Bases: Framework.OSS.bottle.MultiDict

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

append(key, value)

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

filter(names)

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

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.

replace(key, value)

Replace the list of values with a single value.

class Framework.OSS.bottle.HeaderProperty(name, reader=None, writer=<type 'str'>, default='')

Bases: object

class Framework.OSS.bottle.JSONPlugin(json_dumps=<function dumps>)

Bases: object

api = 2

apply(callback, _)

name = 'json'

class Framework.OSS.bottle.Jinja2Template(source=None, name=None, lookup=None, encoding='utf8', **settings)

Bases: Framework.OSS.bottle.BaseTemplate

loader(name)

prepare(filters=None, tests=None, globals={}, **kwargs)

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).

class Framework.OSS.bottle.LocalRequest(environ=None)

Bases: Framework.OSS.bottle.BaseRequest

A thread-local subclass of BaseRequest with a different set of attributes 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

class Framework.OSS.bottle.LocalResponse(body='', status=None, headers=None, **more_headers)

Bases: Framework.OSS.bottle.BaseResponse

A thread-local subclass of BaseResponse with a different set of attributes 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.

bind(body='', status=None, headers=None, **more_headers)

x.__init__(…) initializes x; see help(type(x)) for signature

body

Thread-local property

class Framework.OSS.bottle.MakoTemplate(source=None, name=None, lookup=None, encoding='utf8', **settings)

Bases: Framework.OSS.bottle.BaseTemplate

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).

class Framework.OSS.bottle.MeinheldServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

run(handler)

class Framework.OSS.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.

allitems()

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)

items() → list of D's (key, value) pairs, as 2-tuples

iterallitems()

iteritems() → an iterator over the (key, value) items of D

iterkeys() → an iterator over the keys of D

itervalues() → an iterator over the values of D

keys() → list of D's keys

replace(key, value)

Replace the list of values with a single value.

values() → list of D's values

class Framework.OSS.bottle.PasteServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

run(handler)

exception Framework.OSS.bottle.PluginError

Bases: Framework.OSS.bottle.BottleException

Framework.OSS.bottle.Request

alias of Framework.OSS.bottle.BaseRequest

class Framework.OSS.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.

Framework.OSS.bottle.Response

alias of Framework.OSS.bottle.BaseResponse

class Framework.OSS.bottle.RocketServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

Untested.

run(handler)

class Framework.OSS.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.

call

The route callback with all plugins applied. This property is created on demand and then cached to speed up subsequent requests.

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.

get_callback_args()

Return a list of argument names the callback (most likely) accepts as keyword arguments. If the callback is a decorated function, try to recover the original function before inspection.

get_config(key, default=None)

Lookup a config field and return its value, first checking the route.config, then route.app.config.

get_undecorated_callback()

Return the callback. If the callback is a decorated function, try to recover the original function.

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 Framework.OSS.bottle.RouteBuildError

Bases: Framework.OSS.bottle.RouteError

The route could not be built.

exception Framework.OSS.bottle.RouteError

Bases: Framework.OSS.bottle.BottleException

This is a base class for all routing related exceptions

exception Framework.OSS.bottle.RouteReset

Bases: Framework.OSS.bottle.BottleException

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

exception Framework.OSS.bottle.RouteSyntaxError

Bases: Framework.OSS.bottle.RouteError

The route parser found something not supported by this router.

class Framework.OSS.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 rule or replace the target for an existing rule.

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.

default_filter = 're'

default_pattern = '[^/]+'

match(environ)

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

rule_syntax = <_sre.SRE_Pattern object>

strict_order = None

If true, static routes are no longer checked first.

exception Framework.OSS.bottle.RouterUnknownModeError

Bases: Framework.OSS.bottle.RouteError

class Framework.OSS.bottle.ServerAdapter(host='127.0.0.1', port=8080, **options)

Bases: object

quiet = False

run(handler)

class Framework.OSS.bottle.SimpleTemplate(source=None, name=None, lookup=None, encoding='utf8', **settings)

Bases: Framework.OSS.bottle.BaseTemplate

co

code

execute(_stdout, kwargs)

prepare(escape_func=<function html_escape>, noescape=False, syntax=None, **ka)

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 using keyword arguments as local variables.

class Framework.OSS.bottle.StplParser(source, syntax=None, encoding='utf8')

Bases: object

Parser for stpl templates.

default_syntax = '<% %> % {{ }}'

flush_text()

get_syntax()

Tokens as a space separated string (default: <% %> % {{ }})

static process_inline(chunk)

read_code(pysource, multiline)

set_syntax(syntax)

syntax

Tokens as a space separated string (default: <% %> % {{ }})

translate()

write_code(line, comment='')

exception Framework.OSS.bottle.StplSyntaxError(message)

Bases: Framework.OSS.bottle.TemplateError

exception Framework.OSS.bottle.TemplateError(message)

Bases: Framework.OSS.bottle.HTTPError

class Framework.OSS.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.

api = 2

apply(callback, route)

name = 'template'

setup(app)

class Framework.OSS.bottle.TornadoServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

The super hyped asynchronous server by facebook. Untested.

run(handler)

class Framework.OSS.bottle.TwistedServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

Untested.

run(handler)

class Framework.OSS.bottle.WSGIFileWrapper(fp, buffer_size=65536)

Bases: object

class Framework.OSS.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.

keys() → list of D's keys

raw(key, default=None)

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

class Framework.OSS.bottle.WSGIRefServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

run(app)

class Framework.OSS.bottle.WaitressServer(host='127.0.0.1', port=8080, **options)

Bases: Framework.OSS.bottle.ServerAdapter

run(handler)

Framework.OSS.bottle.abort(code=500, text='Unknown Error.')

Aborts execution and causes a HTTP error.

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

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

class Framework.OSS.bottle.cached_property(func)

Bases: object

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

Framework.OSS.bottle.cheetah_template()

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).

Framework.OSS.bottle.cheetah_view()

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.

Framework.OSS.bottle.cookie_decode(data, key, digestmod=None)

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

Framework.OSS.bottle.cookie_encode(data, key, digestmod=None)

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

Framework.OSS.bottle.cookie_is_encoded(data)

Return True if the argument looks like a encoded cookie.

Framework.OSS.bottle.debug(mode=True)

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

Framework.OSS.bottle.delete(*a, **ka)

Equals route() with a DELETE method parameter.

Framework.OSS.bottle.depr(major, minor, cause, fix)

Framework.OSS.bottle.error(*a, **ka)

Decorator: Register an output handler for a HTTP error code

Framework.OSS.bottle.ext = <module 'Framework.OSS.bottle.ext' from '/home/docs/checkouts/readthedocs.org/user_builds/warriorframework/checkouts/stable/warrior/Framework/OSS/bottle.py'>

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

Framework.OSS.bottle.get(*a, **ka)

Equals route().

Framework.OSS.bottle.hook(*a, **ka)

Return a decorator that attaches a callback to a hook. See add_hook() for details.

Framework.OSS.bottle.html_escape(string)

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

Framework.OSS.bottle.html_quote(string)

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

Framework.OSS.bottle.http_date(value)

Framework.OSS.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.

Framework.OSS.bottle.jinja2_template()

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).

Framework.OSS.bottle.jinja2_view()

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.

class Framework.OSS.bottle.lazy_attribute(func)

Bases: object

A property that caches itself to the class object.

Framework.OSS.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]')

Framework.OSS.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.

Framework.OSS.bottle.local = <thread._local object>

A thread-safe namespace. Not used by Bottle.

Framework.OSS.bottle.make_default_app_wrapper(name)

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

Framework.OSS.bottle.makelist(data)

Framework.OSS.bottle.mako_template()

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).

Framework.OSS.bottle.mako_view()

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.

Framework.OSS.bottle.mount(*a, **ka)

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

parent_app.mount('/prefix/', child_app)

Parameters:

• prefix – path prefix or mount-point.
• app – an instance of Bottle or a WSGI application.

Plugins from the parent application are not applied to the routes of the mounted child application. If you need plugins in the child application, install them separately.

While it is possible to use path wildcards within the prefix path (Bottle childs only), it is highly discouraged.

The prefix path must end with a slash. If you want to access the root of the child application via /prefix in addition to /prefix/, consider adding a route with a 307 redirect to the parent application.

Framework.OSS.bottle.parse_auth(header)

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

Framework.OSS.bottle.parse_date(ims)

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

Framework.OSS.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.

Framework.OSS.bottle.patch(*a, **ka)

Equals route() with a PATCH method parameter.

Framework.OSS.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)

Framework.OSS.bottle.post(*a, **ka)

Equals route() with a POST method parameter.

Framework.OSS.bottle.put(*a, **ka)

Equals route() with a PUT method parameter.

Framework.OSS.bottle.redirect(url, code=None)

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

Framework.OSS.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 multi-threaded server).

Framework.OSS.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.

Framework.OSS.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()).

Framework.OSS.bottle.run(app=None, server='wsgiref', host='127.0.0.1', port=8080, interval=1, reloader=False, quiet=False, plugins=None, debug=None, config=None, **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.

Framework.OSS.bottle.static_file(filename, root, mimetype=True, download=False, charset='UTF-8', etag=None)

Open a file in a safe way and return an instance of HTTPResponse that can be sent back to the client.

Parameters:

• filename – Name or path of the file to send, relative to root.
• root – Root path for file lookups. Should be an absolute directory path.
• mimetype – Provide the content-type header (default: guess from file extension)
• download – If True, ask the browser to open a Save as… dialog instead of opening the file with the associated program. You can specify a custom filename as a string. If not specified, the original filename is used (default: False).
• charset – The charset for files with a text/* mime-type. (default: UTF-8)
• etag – Provide a pre-computed ETag header. If set to False, ETag handling is disabled. (default: auto-generate ETag header)

While checking user input is always a good idea, this function provides additional protection against malicious filename parameters from breaking out of the root directory and leaking sensitive information to an attacker.

Read-protected files or files outside of the root directory are answered with 403 Access Denied. Missing files result in a 404 Not Found response. Conditional requests (If-Modified-Since, If-None-Match) are answered with 304 Not Modified whenever possible. HEAD and Range requests (used by download managers to check or continue partial downloads) are also handled automatically.

Framework.OSS.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).

Framework.OSS.bottle.tob(s, enc='utf8')

Framework.OSS.bottle.tonat(s, enc='utf8')

Framework.OSS.bottle.touni(s, enc='utf8', err='strict')

Framework.OSS.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.

Framework.OSS.bottle.update_wrapper(wrapper, wrapped, *a, **ka)

Framework.OSS.bottle.url(*a, **ka)

Return a string that matches a named route

Framework.OSS.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.

Framework.OSS.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>'

Framework.OSS.xmltodict module

Makes working with XML feel like you are working with JSON

exception Framework.OSS.xmltodict.ParsingInterrupted

Bases: exceptions.Exception

Framework.OSS.xmltodict.parse(xml_input, encoding=None, expat=<module 'xml.parsers.expat' from '/home/docs/.pyenv/versions/2.7.18/lib/python2.7/xml/parsers/expat.pyc'>, process_namespaces=False, namespace_separator=':', **kwargs)

Parse the given XML input and convert it into a dictionary.

xml_input can either be a string or a file-like object.

If xml_attribs is True, element attributes are put in the dictionary among regular child elements, using @ as a prefix to avoid collisions. If set to False, they are just ignored.

Simple example:

>>> import xmltodict
>>> doc = xmltodict.parse("""
... <a prop="x">
...   <b>1</b>
...   <b>2</b>
... </a>
... """)
>>> doc['a']['@prop']
u'x'
>>> doc['a']['b']
[u'1', u'2']

If item_depth is 0, the function returns a dictionary for the root element (default behavior). Otherwise, it calls item_callback every time an item at the specified depth is found and returns None in the end (streaming mode).

The callback function receives two parameters: the path from the document root to the item (name-attribs pairs), and the item (dict). If the callback’s return value is false-ish, parsing will be stopped with the ParsingInterrupted exception.

Streaming example:

>>> def handle(path, item):
...     print 'path:%s item:%s' % (path, item)
...     return True
...
>>> xmltodict.parse("""
... <a prop="x">
...   <b>1</b>
...   <b>2</b>
... </a>""", item_depth=2, item_callback=handle)
path:[(u'a', {u'prop': u'x'}), (u'b', None)] item:1
path:[(u'a', {u'prop': u'x'}), (u'b', None)] item:2

The optional argument postprocessor is a function that takes path, key and value as positional arguments and returns a new (key, value) pair where both key and value may have changed. Usage example:

>>> def postprocessor(path, key, value):
...     try:
...         return key + ':int', int(value)
...     except (ValueError, TypeError):
...         return key, value
>>> xmltodict.parse('<a><b>1</b><b>2</b><b>x</b></a>',
...                 postprocessor=postprocessor)
OrderedDict([(u'a', OrderedDict([(u'b:int', [1, 2]), (u'b', u'x')]))])

You can pass an alternate version of expat (such as defusedexpat) by using the expat parameter. E.g:

>>> import defusedexpat
>>> xmltodict.parse('<a>hello</a>', expat=defusedexpat.pyexpat)
OrderedDict([(u'a', u'hello')])

You can use the force_list argument to force lists to be created even when there is only a single child of a given level of hierarchy. The force_list argument is a tuple of keys. If the key for a given level of hierarchy is in the force_list argument, that level of hierarchy will have a list as a child (even if there is only one sub-element). The index_keys operation takes precendence over this. This is applied after any user-supplied postprocessor has already run.

For example, given this input: <servers>

<server>

<name>host1</name> <os>Linux</os> <interfaces>

<interface>

<name>em0</name> <ip_address>10.0.0.1</ip_address>

</interface>

</interfaces>

</server>

</servers>

If called with force_list=(‘interface’,), it will produce this dictionary: {‘servers’:

{‘server’:

{‘name’: ‘host1’,

‘os’: ‘Linux’}, ‘interfaces’:

{‘interface’:

[ {‘name’: ‘em0’, ‘ip_address’: ‘10.0.0.1’ } ] } } }

force_list can also be a callable that receives path, key and value. This is helpful in cases where the logic that decides whether a list should be forced is more complex.

Framework.OSS.xmltodict.unparse(input_dict, output=None, encoding='utf-8', full_document=True, **kwargs)

Emit an XML document for the given input_dict (reverse of parse).

The resulting XML document is returned as a string, but if output (a file-like object) is specified, it is written there instead.

Dictionary keys prefixed with attr_prefix (default=`’@’) are interpreted as XML node attributes, whereas keys equal to `cdata_key (default=`’#text’`) are treated as character data.

The pretty parameter (default=`False`) enables pretty-printing. In this mode, lines are terminated with `’

‘` and indented with ‘ ‘, but this

can be customized with the newl and indent parameters.

Module contents

Copyright 2017, Fujitsu Network Communications, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.