httpdomain.autohttp.flask_base Namespace Reference

Data Structures
class	AutoflaskBase

Functions
def	translate_werkzeug_rule (rule)
def	get_routes (app, endpoint=None, order=None)
def	quickref_directive (method, path, content)

Detailed Description

    sphinxcontrib.autohttp.flask
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    The sphinx.ext.autodoc-style HTTP API reference builder (from Flask)
    for sphinxcontrib.httpdomain.

    :copyright: Copyright 2011 by Hong Minhee
    :license: BSD, see LICENSE for details.

Function Documentation

translate_werkzeug_rule()

def httpdomain.autohttp.flask_base.translate_werkzeug_rule

(

rule

)

Definition at line 31 of file flask_base.py.

def translate_werkzeug_rule(rule):
    from werkzeug.routing import parse_rule
    buf = six.StringIO()
    for conv, arg, var in parse_rule(rule):
        if conv:
            buf.write('(')
            if conv != 'default':
                buf.write(conv)
                buf.write(':')
            buf.write(var)
            buf.write(')')
        else:
            buf.write(var)
    return buf.getvalue()
 
 

Referenced by httpdomain.autohttp.flask_base.get_routes().

Here is the caller graph for this function:

get_routes()

def httpdomain.autohttp.flask_base.get_routes	(		app,
			endpoint = None,
			order = None
	)

Definition at line 47 of file flask_base.py.

def get_routes(app, endpoint=None, order=None):
    endpoints = []
    for rule in app.url_map.iter_rules(endpoint):
        url_with_endpoint = (
            six.text_type(next(app.url_map.iter_rules(rule.endpoint))),
            rule.endpoint
        )
        if url_with_endpoint not in endpoints:
            endpoints.append(url_with_endpoint)
    if order == 'path':
        endpoints.sort()
    endpoints = [e for _, e in endpoints]
    for endpoint in endpoints:
        methodrules = {}
        for rule in app.url_map.iter_rules(endpoint):
            methods = rule.methods.difference(['OPTIONS', 'HEAD'])
            path = translate_werkzeug_rule(rule.rule)
            for method in methods:
                if method in methodrules:
                    methodrules[method].append(path)
                else:
                    methodrules[method] = [path]
        for method, paths in methodrules.items():
            yield method, paths, endpoint
 
 

References httpdomain.autohttp.flask_base.translate_werkzeug_rule().

Referenced by httpdomain.autohttp.flask_base.AutoflaskBase.make_rst().

Here is the call graph for this function:

Here is the caller graph for this function:

quickref_directive()

def httpdomain.autohttp.flask_base.quickref_directive	(		method,
			path,
			content
	)

Definition at line 73 of file flask_base.py.

def quickref_directive(method, path, content):
    rcomp = re.compile("^\s*.. :quickref:\s*(?P<quick>.*)$")
    method = method.lower().strip()
    if isinstance(content, six.string_types):
         content = content.splitlines()
    description=""
    name=""
    ref = path.replace("<","(").replace(">",")").replace("/","-").replace(":","-")
    for line in content:
         qref = rcomp.match(line)
         if qref:
            quickref = qref.group("quick")
            parts = quickref.split(";",1)
            if len(parts)>1:
                name = parts[0]
                description= parts[1]
            else:
                description= quickref
            break
 
    row ={}
    row['name'] = name
    row['operation'] = '      - `%s %s <#%s-%s>`_' % (method.upper(), path, method.lower(), ref)
    row['description'] = description
 
    return row
 

References replace.

Referenced by httpdomain.autohttp.flask_base.AutoflaskBase.make_rst().

Here is the caller graph for this function: