GNUnet  last
Public Member Functions | Static Public Attributes
httpdomain.autohttp.flask_base.AutoflaskBase Class Reference
Inheritance diagram for httpdomain.autohttp.flask_base.AutoflaskBase:
[legend]
Collaboration diagram for httpdomain.autohttp.flask_base.AutoflaskBase:
[legend]

Public Member Functions

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

bool has_content = True
 
int required_arguments = 1
 
dictionary option_spec
 

Detailed Description

Definition at line 100 of file flask_base.py.

Member Function Documentation

◆ endpoints() [1/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.endpoints (   self)

Definition at line 115 of file flask_base.py.

115  def endpoints(self):
116  endpoints = self.options.get('endpoints', None)
117  if not endpoints:
118  return None
119  return re.split(r'\s*,\s*', endpoints)
120 
get
static int get
Get DID Documement for DID Flag.
Definition: gnunet-did.c:65

References get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, and StartMessage.options.

Referenced by httpdomain.autohttp.flask_base.AutoflaskBase.endpoints(), 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.flask_base.AutoflaskBase.undoc_endpoints (   self)

Definition at line 122 of file flask_base.py.

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

References get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, and StartMessage.options.

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

Here is the caller graph for this function:

◆ blueprints() [1/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.blueprints (   self)

Definition at line 129 of file flask_base.py.

129  def blueprints(self):
130  blueprints = self.options.get('blueprints', None)
131  if not blueprints:
132  return None
133  return frozenset(re.split(r'\s*,\s*', blueprints))
134 

References get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, and StartMessage.options.

Referenced by httpdomain.autohttp.flask_base.AutoflaskBase.blueprints(), and httpdomain.autohttp.flask_base.AutoflaskBase.make_rst().

Here is the caller graph for this function:

◆ undoc_blueprints() [1/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.undoc_blueprints (   self)

Definition at line 136 of file flask_base.py.

136  def undoc_blueprints(self):
137  undoc_blueprints = self.options.get('undoc-blueprints', None)
138  if not undoc_blueprints:
139  return frozenset()
140  return frozenset(re.split(r'\s*,\s*', undoc_blueprints))
141 

References get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, and StartMessage.options.

Referenced by httpdomain.autohttp.flask_base.AutoflaskBase.make_rst(), and httpdomain.autohttp.flask_base.AutoflaskBase.undoc_blueprints().

Here is the caller graph for this function:

◆ modules() [1/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.modules (   self)

Definition at line 143 of file flask_base.py.

143  def modules(self):
144  modules = self.options.get('modules', None)
145  if not modules:
146  return frozenset()
147  return frozenset(re.split(r'\s*,\s*', modules))
148 

References get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, and StartMessage.options.

Referenced by httpdomain.autohttp.flask_base.AutoflaskBase.make_rst(), and httpdomain.autohttp.flask_base.AutoflaskBase.modules().

Here is the caller graph for this function:

◆ undoc_modules() [1/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.undoc_modules (   self)

Definition at line 150 of file flask_base.py.

150  def undoc_modules(self):
151  undoc_modules = self.options.get('undoc-modules', None)
152  if not undoc_modules:
153  return frozenset()
154  return frozenset(re.split(r'\s*,\s*', undoc_modules))
155 

References get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, and StartMessage.options.

Referenced by httpdomain.autohttp.flask_base.AutoflaskBase.make_rst(), and httpdomain.autohttp.flask_base.AutoflaskBase.undoc_modules().

Here is the caller graph for this function:

◆ order() [1/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.order (   self)

Definition at line 157 of file flask_base.py.

157  def order(self):
158  order = self.options.get('order', None)
159  if order not in (None, 'path'):
160  raise ValueError('Invalid value for :order:')
161  return order
162 

References get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, and StartMessage.options.

Referenced by httpdomain.autohttp.flask_base.AutoflaskBase.make_rst(), and httpdomain.autohttp.flask_base.AutoflaskBase.order().

Here is the caller graph for this function:

◆ make_rst() [1/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.make_rst (   self,
  qref = False 
)

Definition at line 163 of file flask_base.py.

163  def make_rst(self, qref=False):
164  app = import_object(self.arguments[0])
165  if self.endpoints:
166  routes = itertools.chain(*[get_routes(app, endpoint, self.order)
167  for endpoint in self.endpoints])
168  else:
169  routes = get_routes(app, order=self.order)
170  for method, paths, endpoint in routes:
171  try:
172  blueprint, _, endpoint_internal = endpoint.rpartition('.')
173  if self.blueprints and blueprint not in self.blueprints:
174  continue
175  if blueprint in self.undoc_blueprints:
176  continue
177  except ValueError:
178  pass # endpoint is not within a blueprint
179 
180  if endpoint in self.undoc_endpoints:
181  continue
182  try:
183  static_url_path = app.static_url_path # Flask 0.7 or higher
184  except AttributeError:
185  static_url_path = app.static_path # Flask 0.6 or under
186  if ('undoc-static' in self.options and endpoint == 'static' and
187  static_url_path + '/(path:filename)' in paths):
188  continue
189  view = app.view_functions[endpoint]
190 
191  if self.modules and view.__module__ not in self.modules:
192  continue
193 
194  if self.undoc_modules and view.__module__ in self.modules:
195  continue
196 
197  docstring = view.__doc__ or ''
198  if hasattr(view, 'view_class'):
199  meth_func = getattr(view.view_class, method.lower(), None)
200  if meth_func and meth_func.__doc__:
201  docstring = meth_func.__doc__
202  if not isinstance(docstring, six.text_type):
203  analyzer = ModuleAnalyzer.for_module(view.__module__)
204  docstring = force_decode(docstring, analyzer.encoding)
205 
206  if not docstring and 'include-empty-docstring' not in self.options:
207  continue
208  docstring = prepare_docstring(docstring)
209  if qref == True:
210  for path in paths:
211  row = quickref_directive(method, path, docstring)
212  yield row
213  else:
214  for line in http_directive(method, paths, docstring):
215  yield line
httpdomain.autohttp.common.http_directive
def http_directive(method, path, content)
Definition: common.py:25
httpdomain.autohttp.common.import_object
def import_object(import_name)
Definition: common.py:15
httpdomain.autohttp.flask_base.get_routes
def get_routes(app, endpoint=None, order=None)
Definition: flask_base.py:47
httpdomain.autohttp.flask_base.quickref_directive
def quickref_directive(method, path, content)
Definition: flask_base.py:73

References httpdomain.autohttp.flask_base.AutoflaskBase.blueprints(), httpdomain.autohttp.bottle.AutobottleDirective.endpoints(), httpdomain.autohttp.flask_base.AutoflaskBase.endpoints(), httpdomain.autohttp.tornado.AutoTornadoDirective.endpoints(), httpdomain.autohttp.flask_base.get_routes(), httpdomain.autohttp.common.http_directive(), httpdomain.autohttp.common.import_object(), httpdomain.autohttp.flask_base.AutoflaskBase.modules(), GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, StartMessage.options, httpdomain.autohttp.flask_base.AutoflaskBase.order(), IBFMessage.order, GNUNET_CONTAINER_Heap.order, httpdomain.autohttp.flask_base.quickref_directive(), httpdomain.autohttp.flask_base.AutoflaskBase.undoc_blueprints(), httpdomain.autohttp.bottle.AutobottleDirective.undoc_endpoints(), httpdomain.autohttp.flask_base.AutoflaskBase.undoc_endpoints(), httpdomain.autohttp.tornado.AutoTornadoDirective.undoc_endpoints(), and httpdomain.autohttp.flask_base.AutoflaskBase.undoc_modules().

Referenced by httpdomain.autohttp.flask_base.AutoflaskBase.make_rst(), 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:

◆ endpoints() [2/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.endpoints (   self)

Definition at line 115 of file flask_base.py.

115  def endpoints(self):
116  endpoints = self.options.get('endpoints', None)
117  if not endpoints:
118  return None
119  return re.split(r'\s*,\s*', endpoints)
120 

References httpdomain.autohttp.flask_base.AutoflaskBase.endpoints(), get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, and StartMessage.options.

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 call graph for this function:
Here is the caller graph for this function:

◆ undoc_endpoints() [2/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.undoc_endpoints (   self)

Definition at line 122 of file flask_base.py.

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

References get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, StartMessage.options, and httpdomain.autohttp.flask_base.AutoflaskBase.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 call graph for this function:
Here is the caller graph for this function:

◆ blueprints() [2/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.blueprints (   self)

Definition at line 129 of file flask_base.py.

129  def blueprints(self):
130  blueprints = self.options.get('blueprints', None)
131  if not blueprints:
132  return None
133  return frozenset(re.split(r'\s*,\s*', blueprints))
134 

References httpdomain.autohttp.flask_base.AutoflaskBase.blueprints(), get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, and StartMessage.options.

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:

◆ undoc_blueprints() [2/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.undoc_blueprints (   self)

Definition at line 136 of file flask_base.py.

136  def undoc_blueprints(self):
137  undoc_blueprints = self.options.get('undoc-blueprints', None)
138  if not undoc_blueprints:
139  return frozenset()
140  return frozenset(re.split(r'\s*,\s*', undoc_blueprints))
141 

References get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, StartMessage.options, and httpdomain.autohttp.flask_base.AutoflaskBase.undoc_blueprints().

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:

◆ modules() [2/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.modules (   self)

Definition at line 143 of file flask_base.py.

143  def modules(self):
144  modules = self.options.get('modules', None)
145  if not modules:
146  return frozenset()
147  return frozenset(re.split(r'\s*,\s*', modules))
148 

References get, httpdomain.autohttp.flask_base.AutoflaskBase.modules(), GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, and StartMessage.options.

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:

◆ undoc_modules() [2/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.undoc_modules (   self)

Definition at line 150 of file flask_base.py.

150  def undoc_modules(self):
151  undoc_modules = self.options.get('undoc-modules', None)
152  if not undoc_modules:
153  return frozenset()
154  return frozenset(re.split(r'\s*,\s*', undoc_modules))
155 

References get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, StartMessage.options, and httpdomain.autohttp.flask_base.AutoflaskBase.undoc_modules().

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:

◆ order() [2/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.order (   self)

Definition at line 157 of file flask_base.py.

157  def order(self):
158  order = self.options.get('order', None)
159  if order not in (None, 'path'):
160  raise ValueError('Invalid value for :order:')
161  return order
162 

References get, GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, StartMessage.options, and httpdomain.autohttp.flask_base.AutoflaskBase.order().

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:

◆ make_rst() [2/2]

def httpdomain.autohttp.flask_base.AutoflaskBase.make_rst (   self,
  qref = False 
)

Definition at line 163 of file flask_base.py.

163  def make_rst(self, qref=False):
164  app = import_object(self.arguments[0])
165  if self.endpoints:
166  routes = itertools.chain(*[get_routes(app, endpoint, self.order)
167  for endpoint in self.endpoints])
168  else:
169  routes = get_routes(app, order=self.order)
170  for method, paths, endpoint in routes:
171  try:
172  blueprint, _, endpoint_internal = endpoint.rpartition('.')
173  if self.blueprints and blueprint not in self.blueprints:
174  continue
175  if blueprint in self.undoc_blueprints:
176  continue
177  except ValueError:
178  pass # endpoint is not within a blueprint
179 
180  if endpoint in self.undoc_endpoints:
181  continue
182  try:
183  static_url_path = app.static_url_path # Flask 0.7 or higher
184  except AttributeError:
185  static_url_path = app.static_path # Flask 0.6 or under
186  if ('undoc-static' in self.options and endpoint == 'static' and
187  static_url_path + '/(path:filename)' in paths):
188  continue
189  view = app.view_functions[endpoint]
190 
191  if self.modules and view.__module__ not in self.modules:
192  continue
193 
194  if self.undoc_modules and view.__module__ in self.modules:
195  continue
196 
197  docstring = view.__doc__ or ''
198  if hasattr(view, 'view_class'):
199  meth_func = getattr(view.view_class, method.lower(), None)
200  if meth_func and meth_func.__doc__:
201  docstring = meth_func.__doc__
202  if not isinstance(docstring, six.text_type):
203  analyzer = ModuleAnalyzer.for_module(view.__module__)
204  docstring = force_decode(docstring, analyzer.encoding)
205 
206  if not docstring and 'include-empty-docstring' not in self.options:
207  continue
208  docstring = prepare_docstring(docstring)
209  if qref == True:
210  for path in paths:
211  row = quickref_directive(method, path, docstring)
212  yield row
213  else:
214  for line in http_directive(method, paths, docstring):
215  yield line

References httpdomain.autohttp.flask_base.AutoflaskBase.blueprints(), httpdomain.autohttp.bottle.AutobottleDirective.endpoints(), httpdomain.autohttp.flask_base.AutoflaskBase.endpoints(), httpdomain.autohttp.tornado.AutoTornadoDirective.endpoints(), httpdomain.autohttp.flask_base.get_routes(), httpdomain.autohttp.common.http_directive(), httpdomain.autohttp.common.import_object(), httpdomain.autohttp.flask_base.AutoflaskBase.make_rst(), httpdomain.autohttp.flask_base.AutoflaskBase.modules(), GNUNET_SERVICE_Handle.options, GNUNET_CADET_ConnectionCreateMessage.options, InitMessage.options, GSC_Client.options, GNUNET_DHT_ClientGetMessage.options, GNUNET_DHT_ClientResultMessage.options, GNUNET_DHT_ClientPutMessage.options, GNUNET_DHT_MonitorPutMessage.options, GNUNET_DHT_MonitorGetMessage.options, GNUNET_DHT_MonitorGetRespMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.options, PeerPutMessage.options, PeerResultMessage.options, PeerGetMessage.options, RecentRequest.options, SearchMessage.options, GNUNET_FS_PublishContext.options, GNUNET_FS_SearchContext.options, GNUNET_FS_DownloadContext.options, GNUNET_FS_PublishKskContext.options, GSF_PendingRequestData.options, LookupMessage.options, GNUNET_GNS_LookupWithTldRequest.options, GNS_ResolverHandle.options, StoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, StartMessage.options, httpdomain.autohttp.flask_base.AutoflaskBase.order(), IBFMessage.order, GNUNET_CONTAINER_Heap.order, httpdomain.autohttp.flask_base.quickref_directive(), httpdomain.autohttp.flask_base.AutoflaskBase.undoc_blueprints(), httpdomain.autohttp.bottle.AutobottleDirective.undoc_endpoints(), httpdomain.autohttp.flask_base.AutoflaskBase.undoc_endpoints(), httpdomain.autohttp.tornado.AutoTornadoDirective.undoc_endpoints(), and httpdomain.autohttp.flask_base.AutoflaskBase.undoc_modules().

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:

Field Documentation

◆ has_content

bool httpdomain.autohttp.flask_base.AutoflaskBase.has_content = True
static

Definition at line 102 of file flask_base.py.

◆ required_arguments

int httpdomain.autohttp.flask_base.AutoflaskBase.required_arguments = 1
static

Definition at line 103 of file flask_base.py.

◆ option_spec

dictionary httpdomain.autohttp.flask_base.AutoflaskBase.option_spec
static
Initial value:
= {'endpoints': directives.unchanged,
'blueprints': directives.unchanged,
'modules': directives.unchanged,
'order': directives.unchanged,
'undoc-endpoints': directives.unchanged,
'undoc-blueprints': directives.unchanged,
'undoc-modules': directives.unchanged,
'undoc-static': directives.unchanged,
'include-empty-docstring': directives.unchanged}

Definition at line 104 of file flask_base.py.

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