httpdomain.httpdomain.HTTPResource Class Reference

Inheritance diagram for httpdomain.httpdomain.HTTPResource:

Collaboration diagram for httpdomain.httpdomain.HTTPResource:

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.

    def handle_signature(self, sig, signode):
        method = self.method.upper() + ' '
        signode += addnodes.desc_name(method, method)
        offset = 0
        path = None
        for match in http_sig_param_re.finditer(sig):
            path = sig[offset:match.start()]
            signode += addnodes.desc_name(path, path)
            params = addnodes.desc_parameterlist()
            typ = match.group('type')
            if typ:
                typ += ': '
                params += addnodes.desc_annotation(typ, typ)
            name = match.group('name')
            params += addnodes.desc_parameter(name, name)
            signode += params
            offset = match.end()
        if offset < len(sig):
            path = sig[offset:len(sig)]
            signode += addnodes.desc_name(path, path)
        assert path is not None, 'no matches for sig: %s' % sig
        fullname = self.method.upper() + ' ' + path
        signode['method'] = self.method
        signode['path'] = sig
        signode['fullname'] = fullname
        return (fullname, self.method, sig)
 

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, and GNUNET_SIGNAL_Context.method.

needs_arglist() [1/2]

def httpdomain.httpdomain.HTTPResource.needs_arglist

(

self

)

Definition at line 334 of file httpdomain.py.

    def needs_arglist(self):
        return False
 

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.

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

References GNUNET_ABD_Request.env, Channel.env, TransportPlugin.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, 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, 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.

    def get_index_text(self, modname, name):
        return ''
 
 

handle_signature() [2/2]

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

Definition at line 307 of file httpdomain.py.

    def handle_signature(self, sig, signode):
        method = self.method.upper() + ' '
        signode += addnodes.desc_name(method, method)
        offset = 0
        path = None
        for match in http_sig_param_re.finditer(sig):
            path = sig[offset:match.start()]
            signode += addnodes.desc_name(path, path)
            params = addnodes.desc_parameterlist()
            typ = match.group('type')
            if typ:
                typ += ': '
                params += addnodes.desc_annotation(typ, typ)
            name = match.group('name')
            params += addnodes.desc_parameter(name, name)
            signode += params
            offset = match.end()
        if offset < len(sig):
            path = sig[offset:len(sig)]
            signode += addnodes.desc_name(path, path)
        assert path is not None, 'no matches for sig: %s' % sig
        fullname = self.method.upper() + ' ' + path
        signode['method'] = self.method
        signode['path'] = sig
        signode['fullname'] = fullname
        return (fullname, self.method, sig)
 

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, and GNUNET_SIGNAL_Context.method.

needs_arglist() [2/2]

def httpdomain.httpdomain.HTTPResource.needs_arglist

(

self

)

Definition at line 334 of file httpdomain.py.

    def needs_arglist(self):
        return False
 

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.

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

References GNUNET_ABD_Request.env, Channel.env, TransportPlugin.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, 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, 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.

    def get_index_text(self, modname, name):
        return ''
 
 

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

httpdomain.httpdomain.HTTPResource.method = NotImplemented

static

Definition at line 305 of file httpdomain.py.

Referenced by httpdomain.httpdomain.HTTPXRefRole.__init__(), httpdomain.httpdomain.HTTPResource.add_target_and_index(), httpdomain.httpdomain.HTTPResource.handle_signature(), and httpdomain.httpdomain.HTTPXRefRole.process_link().

---

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

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