Inheritance diagram for httpdomain.autohttp.tornado.AutoTornadoDirective:

Collaboration diagram for httpdomain.autohttp.tornado.AutoTornadoDirective:

Public Member Functions
def	endpoints (self)

def	undoc_endpoints (self)

def	make_rst (self)

def	run (self)

def	endpoints (self)

def	undoc_endpoints (self)

def	make_rst (self)

def	run (self)

Static Public Attributes
bool	has_content = True

int	required_arguments = 1

dictionary	option_spec

Detailed Description

Definition at line 71 of file tornado.py.

Member Function Documentation

◆ endpoints() [1/2]

def httpdomain.autohttp.tornado.AutoTornadoDirective.endpoints ( self )

Definition at line 80 of file tornado.py.

    def endpoints(self):
        endpoints = self.options.get('endpoints', None)
        if not endpoints:
            return None
        return frozenset(re.split(r'\s*,\s*', endpoints))
 

Referenced by httpdomain.autohttp.bottle.AutobottleDirective.make_rst(), httpdomain.autohttp.tornado.AutoTornadoDirective.make_rst(), and httpdomain.autohttp.flask_base.AutoflaskBase.make_rst().

Here is the caller graph for this function:

◆ undoc_endpoints() [1/2]

def httpdomain.autohttp.tornado.AutoTornadoDirective.undoc_endpoints ( self )

Definition at line 87 of file tornado.py.

    def undoc_endpoints(self):
        undoc_endpoints = self.options.get('undoc-endpoints', None)
        if not undoc_endpoints:
            return frozenset()
        return frozenset(re.split(r'\s*,\s*', undoc_endpoints))
 

Referenced by httpdomain.autohttp.bottle.AutobottleDirective.make_rst(), httpdomain.autohttp.tornado.AutoTornadoDirective.make_rst(), and httpdomain.autohttp.flask_base.AutoflaskBase.make_rst().

Here is the caller graph for this function:

◆ make_rst() [1/2]

def httpdomain.autohttp.tornado.AutoTornadoDirective.make_rst ( self )

Definition at line 93 of file tornado.py.

    def make_rst(self):
        app = import_object(self.arguments[0])
        for method, path, handler in get_routes(app):
            class_name = handler.__name__
            method_name = getattr(handler, method).__name__
            endpoint = '.'.join((class_name, method_name))
 
            if self.endpoints and endpoint not in self.endpoints:
                continue
            if endpoint in self.undoc_endpoints:
                continue
 
            docstring = getattr(handler, method).__doc__ or ''
            #if not isinstance(docstring, unicode):
            #    analyzer = ModuleAnalyzer.for_module(view.__module__)
            #    docstring = force_decode(docstring, analyzer.encoding)
            if not docstring and 'include-empty-docstring' not in self.options:
                continue
            docstring = prepare_docstring(docstring)
            for line in http_directive(method, normalize_path(path), docstring):
                yield line
 

Referenced by httpdomain.autohttp.bottle.AutobottleDirective.run(), httpdomain.autohttp.flask.AutoflaskDirective.run(), httpdomain.autohttp.flaskqref.QuickReferenceFlaskDirective.run(), and httpdomain.autohttp.tornado.AutoTornadoDirective.run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run() [1/2]

def httpdomain.autohttp.tornado.AutoTornadoDirective.run ( self )

Definition at line 115 of file tornado.py.

    def run(self):
        node = nodes.section()
        node.document = self.state.document
        result = ViewList()
        for line in self.make_rst():
            result.append(line, '<autotornado>')
        nested_parse_with_titles(self.state, result, node)
        return node.children
 
 

References httpdomain.autohttp.bottle.AutobottleDirective.make_rst(), httpdomain.autohttp.tornado.AutoTornadoDirective.make_rst(), httpdomain.autohttp.flask_base.AutoflaskBase.make_rst(), GNUNET_CONVERSATION_Caller.state, GNUNET_CONVERSATION_Phone.state, GNUNET_CONVERSATION_Call.state, Operation.state, Set.state, CadetChannel.state, CadetConnection.state, MonitorNotifyMessage.state, GNUNET_FS_UnindexContext.state, DownloadRequest.state, Socks5Request.state, GNUNET_MESSENGER_SrvRoom.state, GNUNET_MESSENGER_SrvTunnel.state, MhdConnectionHandle.state, OIDC_Variables.state, MonitoredPeer.state, and PeerResolutionContext.state.

Here is the call graph for this function:

◆ endpoints() [2/2]

def httpdomain.autohttp.tornado.AutoTornadoDirective.endpoints ( self )

Definition at line 80 of file tornado.py.

    def endpoints(self):
        endpoints = self.options.get('endpoints', None)
        if not endpoints:
            return None
        return frozenset(re.split(r'\s*,\s*', endpoints))
 

Referenced by httpdomain.autohttp.bottle.AutobottleDirective.make_rst(), httpdomain.autohttp.tornado.AutoTornadoDirective.make_rst(), and httpdomain.autohttp.flask_base.AutoflaskBase.make_rst().

Here is the caller graph for this function:

◆ undoc_endpoints() [2/2]

def httpdomain.autohttp.tornado.AutoTornadoDirective.undoc_endpoints ( self )

Definition at line 87 of file tornado.py.

    def undoc_endpoints(self):
        undoc_endpoints = self.options.get('undoc-endpoints', None)
        if not undoc_endpoints:
            return frozenset()
        return frozenset(re.split(r'\s*,\s*', undoc_endpoints))
 

Referenced by httpdomain.autohttp.bottle.AutobottleDirective.make_rst(), httpdomain.autohttp.tornado.AutoTornadoDirective.make_rst(), and httpdomain.autohttp.flask_base.AutoflaskBase.make_rst().

Here is the caller graph for this function:

◆ make_rst() [2/2]

def httpdomain.autohttp.tornado.AutoTornadoDirective.make_rst ( self )

Definition at line 93 of file tornado.py.

    def make_rst(self):
        app = import_object(self.arguments[0])
        for method, path, handler in get_routes(app):
            class_name = handler.__name__
            method_name = getattr(handler, method).__name__
            endpoint = '.'.join((class_name, method_name))
 
            if self.endpoints and endpoint not in self.endpoints:
                continue
            if endpoint in self.undoc_endpoints:
                continue
 
            docstring = getattr(handler, method).__doc__ or ''
            #if not isinstance(docstring, unicode):
            #    analyzer = ModuleAnalyzer.for_module(view.__module__)
            #    docstring = force_decode(docstring, analyzer.encoding)
            if not docstring and 'include-empty-docstring' not in self.options:
                continue
            docstring = prepare_docstring(docstring)
            for line in http_directive(method, normalize_path(path), docstring):
                yield line
 

Referenced by httpdomain.autohttp.bottle.AutobottleDirective.run(), httpdomain.autohttp.flask.AutoflaskDirective.run(), httpdomain.autohttp.flaskqref.QuickReferenceFlaskDirective.run(), and httpdomain.autohttp.tornado.AutoTornadoDirective.run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run() [2/2]

def httpdomain.autohttp.tornado.AutoTornadoDirective.run ( self )

Definition at line 115 of file tornado.py.

    def run(self):
        node = nodes.section()
        node.document = self.state.document
        result = ViewList()
        for line in self.make_rst():
            result.append(line, '<autotornado>')
        nested_parse_with_titles(self.state, result, node)
        return node.children
 
 

References httpdomain.autohttp.bottle.AutobottleDirective.make_rst(), httpdomain.autohttp.tornado.AutoTornadoDirective.make_rst(), httpdomain.autohttp.flask_base.AutoflaskBase.make_rst(), GNUNET_CONVERSATION_Caller.state, GNUNET_CONVERSATION_Phone.state, GNUNET_CONVERSATION_Call.state, Operation.state, Set.state, CadetChannel.state, CadetConnection.state, MonitorNotifyMessage.state, GNUNET_FS_UnindexContext.state, DownloadRequest.state, Socks5Request.state, GNUNET_MESSENGER_SrvRoom.state, GNUNET_MESSENGER_SrvTunnel.state, MhdConnectionHandle.state, OIDC_Variables.state, MonitoredPeer.state, and PeerResolutionContext.state.

Here is the call graph for this function:

Field Documentation

◆ has_content

bool httpdomain.autohttp.tornado.AutoTornadoDirective.has_content = True

static

Definition at line 73 of file tornado.py.

◆ required_arguments

int httpdomain.autohttp.tornado.AutoTornadoDirective.required_arguments = 1

static

Definition at line 74 of file tornado.py.

◆ option_spec

dictionary httpdomain.autohttp.tornado.AutoTornadoDirective.option_spec

static

Initial value:

=  {'endpoints': directives.unchanged,
                   'undoc-endpoints': directives.unchanged,
                   'include-empty-docstring': directives.unchanged}

Definition at line 75 of file tornado.py.

The documentation for this class was generated from the following files:

contrib/gana/_exts/httpdomain/autohttp/tornado.py
contrib/handbook/_exts/httpdomain/autohttp/tornado.py

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ endpoints() [1/2]

◆ undoc_endpoints() [1/2]

◆ make_rst() [1/2]

◆ run() [1/2]

◆ endpoints() [2/2]

◆ undoc_endpoints() [2/2]

◆ make_rst() [2/2]

◆ run() [2/2]

Field Documentation

◆ has_content

◆ required_arguments

◆ option_spec