httpdomain.autohttp.flaskqref.QuickReferenceFlaskDirective Class Reference

Inheritance diagram for httpdomain.autohttp.flaskqref.QuickReferenceFlaskDirective:

Collaboration diagram for httpdomain.autohttp.flaskqref.QuickReferenceFlaskDirective:

Public Member Functions
def	run (self)
def	run (self)
Public Member Functions inherited from httpdomain.autohttp.flask_base.AutoflaskBase
def	endpoints (self)
def	undoc_endpoints (self)
def	blueprints (self)
def	undoc_blueprints (self)
def	modules (self)
def	undoc_modules (self)
def	order (self)
def	make_rst (self, qref=False)
def	endpoints (self)
def	undoc_endpoints (self)
def	blueprints (self)
def	undoc_blueprints (self)
def	modules (self)
def	undoc_modules (self)
def	order (self)
def	make_rst (self, qref=False)

Static Public Attributes
list	header
Static Public Attributes inherited from httpdomain.autohttp.flask_base.AutoflaskBase
bool	has_content = True
int	required_arguments = 1
dictionary	option_spec

Detailed Description

Definition at line 23 of file flaskqref.py.

Member Function Documentation

run() [1/2]

def httpdomain.autohttp.flaskqref.QuickReferenceFlaskDirective.run

(

self

)

Definition at line 36 of file flaskqref.py.

    def run(self):
        node = nodes.section()
        node.document = self.state.document
        result = ViewList()
        for line in QuickReferenceFlaskDirective.header:
            result.append(line, '<qrefflask>') 
        table={}
        table_sorted_names=[]
        
        for table_row in self.make_rst(qref=True):
            name = table_row['name']
            if table.get(name) is None:
                table[name]=[]
            table[name].append(table_row) 
            if name not in table_sorted_names:
                table_sorted_names.append(name)
 
        table_sorted_names.sort()
 
        for name in table_sorted_names:
            # Keep table display clean by not repeating duplicate
            # resource names and descriptions
            display_name = name
            previous_description=None
            for row in table[name]:
                result.append('    * - %s' % display_name, '<qrefflask>')
                display_name =""
                result.append(row['operation'], '<qrefflask>')
                description = row['description']
                if previous_description is not None and previous_description == description:
                    description =""
                else:
                    previous_description = description
 
                result.append('      - %s' % description,  '<qrefflask>')
 
        result.append('', '<qrefflask>')
        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:

run() [2/2]

def httpdomain.autohttp.flaskqref.QuickReferenceFlaskDirective.run

(

self

)

Definition at line 36 of file flaskqref.py.

    def run(self):
        node = nodes.section()
        node.document = self.state.document
        result = ViewList()
        for line in QuickReferenceFlaskDirective.header:
            result.append(line, '<qrefflask>') 
        table={}
        table_sorted_names=[]
        
        for table_row in self.make_rst(qref=True):
            name = table_row['name']
            if table.get(name) is None:
                table[name]=[]
            table[name].append(table_row) 
            if name not in table_sorted_names:
                table_sorted_names.append(name)
 
        table_sorted_names.sort()
 
        for name in table_sorted_names:
            # Keep table display clean by not repeating duplicate
            # resource names and descriptions
            display_name = name
            previous_description=None
            for row in table[name]:
                result.append('    * - %s' % display_name, '<qrefflask>')
                display_name =""
                result.append(row['operation'], '<qrefflask>')
                description = row['description']
                if previous_description is not None and previous_description == description:
                    description =""
                else:
                    previous_description = description
 
                result.append('      - %s' % description,  '<qrefflask>')
 
        result.append('', '<qrefflask>')
        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

header

list httpdomain.autohttp.flaskqref.QuickReferenceFlaskDirective.header

static

Initial value:

=  [ '',
              '.. list-table::',
              '    :widths: 20 45 35',
              '    :header-rows: 1',
              '',
              '    * - Resource',
              '      - Operation',
              '      - Description'
            ]

Definition at line 26 of file flaskqref.py.

---

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

• contrib/gana/_exts/httpdomain/autohttp/flaskqref.py
• contrib/handbook/_exts/httpdomain/autohttp/flaskqref.py