GNUnet 0.22.1
httpdomain.httpdomain.HTTPResource Class Reference
Inheritance diagram for httpdomain.httpdomain.HTTPResource:
[legend]
Collaboration diagram for httpdomain.httpdomain.HTTPResource:
[legend]

Public Member Functions

def handle_signature (self, sig, signode)
 
def needs_arglist (self)
 
def add_target_and_index (self, name_cls, sig, signode)
 
def get_index_text (self, modname, name)
 
def handle_signature (self, sig, signode)
 
def needs_arglist (self)
 
def add_target_and_index (self, name_cls, sig, signode)
 
def get_index_text (self, modname, name)
 

Static Public Attributes

list doc_field_types
 
dictionary option_spec
 
 method = NotImplemented
 

Detailed Description

Definition at line 259 of file httpdomain.py.

Member Function Documentation

◆ handle_signature() [1/2]

def httpdomain.httpdomain.HTTPResource.handle_signature (   self,
  sig,
  signode 
)

Definition at line 307 of file httpdomain.py.

307 def handle_signature(self, sig, signode):
308 method = self.method.upper() + ' '
309 signode += addnodes.desc_name(method, method)
310 offset = 0
311 path = None
312 for match in http_sig_param_re.finditer(sig):
313 path = sig[offset:match.start()]
314 signode += addnodes.desc_name(path, path)
315 params = addnodes.desc_parameterlist()
316 typ = match.group('type')
317 if typ:
318 typ += ': '
319 params += addnodes.desc_annotation(typ, typ)
320 name = match.group('name')
321 params += addnodes.desc_parameter(name, name)
322 signode += params
323 offset = match.end()
324 if offset < len(sig):
325 path = sig[offset:len(sig)]
326 signode += addnodes.desc_name(path, path)
327 assert path is not None, 'no matches for sig: %s' % sig
328 fullname = self.method.upper() + ' ' + path
329 signode['method'] = self.method
330 signode['path'] = sig
331 signode['fullname'] = fullname
332 return (fullname, self.method, sig)
333

References httpdomain.httpdomain.HTTPResource.method, httpdomain.httpdomain.HTTPOptions.method, httpdomain.httpdomain.HTTPHead.method, httpdomain.httpdomain.HTTPPatch.method, httpdomain.httpdomain.HTTPPost.method, httpdomain.httpdomain.HTTPGet.method, httpdomain.httpdomain.HTTPPut.method, httpdomain.httpdomain.HTTPDelete.method, httpdomain.httpdomain.HTTPTrace.method, httpdomain.httpdomain.HTTPConnect.method, httpdomain.httpdomain.HTTPCopy.method, httpdomain.httpdomain.HTTPAny.method, httpdomain.httpdomain.HTTPXRefRole.method, GNUNET_REST_RequestHandle.method, GNUNET_REST_RequestHandler.method, GNUNET_SIGNAL_Context.method, and Stream.method.

◆ needs_arglist() [1/2]

def httpdomain.httpdomain.HTTPResource.needs_arglist (   self)

Definition at line 334 of file httpdomain.py.

334 def needs_arglist(self):
335 return False
336

◆ add_target_and_index() [1/2]

def httpdomain.httpdomain.HTTPResource.add_target_and_index (   self,
  name_cls,
  sig,
  signode 
)

Definition at line 337 of file httpdomain.py.

337 def add_target_and_index(self, name_cls, sig, signode):
338 signode['ids'].append(http_resource_anchor(*name_cls[1:]))
339 if 'noindex' not in self.options:
340 self.env.domaindata['http'][self.method][sig] = (
341 self.env.docname,
342 self.options.get('synopsis', ''),
343 'deprecated' in self.options)
344
static int get
Get DID Documement for DID Flag.
Definition: gnunet-did.c:62
def http_resource_anchor(method, path)
Definition: httpdomain.py:254

References GNUNET_ABD_Request.env, Channel.env, Plugin.env, CadetOutOfOrderMessage.env, CadetConnection.env, GCP_MessageQueueManager.env, CadetTunnelQueueEntry.env, PeerRecord.env, GNUNET_DATACACHE_Handle.env, GNUNET_DATASTORE_QueueEntry.env, DatastorePlugin.env, GNUNET_DHT_PutHandle.env, GDS_Underlay.env, GSF_PeerTransmitHandle.env, GSF_DelayedHandle.env, PeerPlan.env, MigrationReadyPeer.env, GNUNET_GNS_LookupRequest.env, GNUNET_NAMESTORE_QueueEntry.env, GNUNET_NAMESTORE_ZoneIterator.env, GNUNET_PEERSTORE_StoreContext.env, GNUNET_PEERSTORE_IterateContext.env, RequestContext.env, GNUNET_RECLAIM_Operation.env, GNUNET_RECLAIM_TicketIterator.env, GNUNET_RECLAIM_AttributeIterator.env, GNUNET_RECLAIM_CredentialIterator.env, Neighbour.env, get, httpdomain.httpdomain.http_resource_anchor(), httpdomain.httpdomain.HTTPResource.method, httpdomain.httpdomain.HTTPOptions.method, httpdomain.httpdomain.HTTPHead.method, httpdomain.httpdomain.HTTPPatch.method, httpdomain.httpdomain.HTTPPost.method, httpdomain.httpdomain.HTTPGet.method, httpdomain.httpdomain.HTTPPut.method, httpdomain.httpdomain.HTTPDelete.method, httpdomain.httpdomain.HTTPTrace.method, httpdomain.httpdomain.HTTPConnect.method, httpdomain.httpdomain.HTTPCopy.method, httpdomain.httpdomain.HTTPAny.method, httpdomain.httpdomain.HTTPXRefRole.method, GNUNET_REST_RequestHandle.method, GNUNET_REST_RequestHandler.method, GNUNET_SIGNAL_Context.method, Stream.method, 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, PeerPutMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.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, PeerstoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, and StartMessage.options.

Here is the call graph for this function:

◆ get_index_text() [1/2]

def httpdomain.httpdomain.HTTPResource.get_index_text (   self,
  modname,
  name 
)

Definition at line 345 of file httpdomain.py.

345 def get_index_text(self, modname, name):
346 return ''
347
348

◆ handle_signature() [2/2]

def httpdomain.httpdomain.HTTPResource.handle_signature (   self,
  sig,
  signode 
)

Definition at line 307 of file httpdomain.py.

307 def handle_signature(self, sig, signode):
308 method = self.method.upper() + ' '
309 signode += addnodes.desc_name(method, method)
310 offset = 0
311 path = None
312 for match in http_sig_param_re.finditer(sig):
313 path = sig[offset:match.start()]
314 signode += addnodes.desc_name(path, path)
315 params = addnodes.desc_parameterlist()
316 typ = match.group('type')
317 if typ:
318 typ += ': '
319 params += addnodes.desc_annotation(typ, typ)
320 name = match.group('name')
321 params += addnodes.desc_parameter(name, name)
322 signode += params
323 offset = match.end()
324 if offset < len(sig):
325 path = sig[offset:len(sig)]
326 signode += addnodes.desc_name(path, path)
327 assert path is not None, 'no matches for sig: %s' % sig
328 fullname = self.method.upper() + ' ' + path
329 signode['method'] = self.method
330 signode['path'] = sig
331 signode['fullname'] = fullname
332 return (fullname, self.method, sig)
333

References httpdomain.httpdomain.HTTPResource.method, httpdomain.httpdomain.HTTPOptions.method, httpdomain.httpdomain.HTTPHead.method, httpdomain.httpdomain.HTTPPatch.method, httpdomain.httpdomain.HTTPPost.method, httpdomain.httpdomain.HTTPGet.method, httpdomain.httpdomain.HTTPPut.method, httpdomain.httpdomain.HTTPDelete.method, httpdomain.httpdomain.HTTPTrace.method, httpdomain.httpdomain.HTTPConnect.method, httpdomain.httpdomain.HTTPCopy.method, httpdomain.httpdomain.HTTPAny.method, httpdomain.httpdomain.HTTPXRefRole.method, GNUNET_REST_RequestHandle.method, GNUNET_REST_RequestHandler.method, GNUNET_SIGNAL_Context.method, and Stream.method.

◆ needs_arglist() [2/2]

def httpdomain.httpdomain.HTTPResource.needs_arglist (   self)

Definition at line 334 of file httpdomain.py.

334 def needs_arglist(self):
335 return False
336

◆ add_target_and_index() [2/2]

def httpdomain.httpdomain.HTTPResource.add_target_and_index (   self,
  name_cls,
  sig,
  signode 
)

Definition at line 337 of file httpdomain.py.

337 def add_target_and_index(self, name_cls, sig, signode):
338 signode['ids'].append(http_resource_anchor(*name_cls[1:]))
339 if 'noindex' not in self.options:
340 self.env.domaindata['http'][self.method][sig] = (
341 self.env.docname,
342 self.options.get('synopsis', ''),
343 'deprecated' in self.options)
344

References GNUNET_ABD_Request.env, Channel.env, Plugin.env, CadetOutOfOrderMessage.env, CadetConnection.env, GCP_MessageQueueManager.env, CadetTunnelQueueEntry.env, PeerRecord.env, GNUNET_DATACACHE_Handle.env, GNUNET_DATASTORE_QueueEntry.env, DatastorePlugin.env, GNUNET_DHT_PutHandle.env, GDS_Underlay.env, GSF_PeerTransmitHandle.env, GSF_DelayedHandle.env, PeerPlan.env, MigrationReadyPeer.env, GNUNET_GNS_LookupRequest.env, GNUNET_NAMESTORE_QueueEntry.env, GNUNET_NAMESTORE_ZoneIterator.env, GNUNET_PEERSTORE_StoreContext.env, GNUNET_PEERSTORE_IterateContext.env, RequestContext.env, GNUNET_RECLAIM_Operation.env, GNUNET_RECLAIM_TicketIterator.env, GNUNET_RECLAIM_AttributeIterator.env, GNUNET_RECLAIM_CredentialIterator.env, Neighbour.env, get, httpdomain.httpdomain.http_resource_anchor(), httpdomain.httpdomain.HTTPResource.method, httpdomain.httpdomain.HTTPOptions.method, httpdomain.httpdomain.HTTPHead.method, httpdomain.httpdomain.HTTPPatch.method, httpdomain.httpdomain.HTTPPost.method, httpdomain.httpdomain.HTTPGet.method, httpdomain.httpdomain.HTTPPut.method, httpdomain.httpdomain.HTTPDelete.method, httpdomain.httpdomain.HTTPTrace.method, httpdomain.httpdomain.HTTPConnect.method, httpdomain.httpdomain.HTTPCopy.method, httpdomain.httpdomain.HTTPAny.method, httpdomain.httpdomain.HTTPXRefRole.method, GNUNET_REST_RequestHandle.method, GNUNET_REST_RequestHandler.method, GNUNET_SIGNAL_Context.method, Stream.method, 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, PeerPutMessage.options, GNUNET_DHT_GetHandle.options, GetActionContext.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, PeerstoreRecordMessage.options, GNUNET_PEERSTORE_StoreContext.options, and StartMessage.options.

Here is the call graph for this function:

◆ get_index_text() [2/2]

def httpdomain.httpdomain.HTTPResource.get_index_text (   self,
  modname,
  name 
)

Definition at line 345 of file httpdomain.py.

345 def get_index_text(self, modname, name):
346 return ''
347
348

Field Documentation

◆ doc_field_types

list httpdomain.httpdomain.HTTPResource.doc_field_types
static

Definition at line 261 of file httpdomain.py.

◆ option_spec

dictionary httpdomain.httpdomain.HTTPResource.option_spec
static
Initial value:
= {
'deprecated': directives.flag,
'noindex': directives.flag,
'synopsis': lambda x: x,
}

Definition at line 299 of file httpdomain.py.

◆ method


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