Inheritance diagram for httpdomain.httpdomain.HTTPDomain:

Collaboration diagram for httpdomain.httpdomain.HTTPDomain:

Public Member Functions
def	routes (self)

def	clear_doc (self, docname)

def	resolve_xref (self, env, fromdocname, builder, typ, target, node, contnode)

def	resolve_any_xref (self, env, fromdocname, builder, target, node, contnode)

def	get_objects (self)

def	routes (self)

def	clear_doc (self, docname)

def	resolve_xref (self, env, fromdocname, builder, typ, target, node, contnode)

def	resolve_any_xref (self, env, fromdocname, builder, target, node, contnode)

def	get_objects (self)

Static Public Attributes
string	name = 'http'

string	label = 'HTTP'

dictionary	object_types

dictionary	directives

dictionary	roles

dictionary	initial_data

list	indices = []

Detailed Description

HTTP domain.

Definition at line 571 of file httpdomain.py.

Member Function Documentation

◆ routes() [1/2]

def httpdomain.httpdomain.HTTPDomain.routes ( self )

Definition at line 639 of file httpdomain.py.

    def routes(self):
        return dict((key, self.data[key]) for key in self.object_types)
 

References TcpContext.data, GNUNET_DATACACHE_Block.data, GNUNET_DNSPARSER_RawRecord.data, GNUNET_DNSPARSER_Record.data, GNUNET_FS_ProgressInfo.data, GNUNET_FS_ProgressInfo::GNUNET_FS_PublishStatusEvent::GNUNET_FS_PublishProgressEvent.data, GNUNET_FS_ProgressInfo::GNUNET_FS_DownloadStatusEvent::GNUNET_FS_DownloadProgressEvent.data, GNUNET_FS_ProgressInfo::GNUNET_FS_UnindexEvent::GNUNET_FS_UnindexProgressEvent.data, GNUNET_GNSRECORD_Data.data, GNUNET_MESSENGER_MessagePrivate.data, GNUNET_MESSENGER_MessageTranscript.data, GNUNET_PQ_QueryParam.data, GNUNET_RECLAIM_Attribute.data, GNUNET_RECLAIM_Credential.data, GNUNET_RECLAIM_Presentation.data, GNUNET_REST_RequestHandle.data, GNUNET_SET_Element.data, GNUNET_SETI_Element.data, GNUNET_SETU_Element.data, GNUNET_SQ_QueryParam.data, Buffer.data, Value.data, UpdateContext.data, RemoveContext.data, GNUNET_FS_Uri.data, GNUNET_FS_FileInformation.data, GetFullDataClosure.data, ProcessResultClosure.data, MetaCounter.data, HandleReplyClosure.data, ProcessReplyClosure.data, MetaItem.data, DnsResult.data, userdata.data, HostSet.data, GNUNET_NAT_Test.data, GNUNET_NAT_AUTO_TestMessage.data, GNUNET_NAT_AUTO_Test.data, GNUNET_NAT_TestMessage.data, TicketRecordsEntry.data, Result.data, RequestHandle.data, ego_sign_data_cls.data, WriteContext.data, and httpdomain.httpdomain.HTTPDomain.object_types.

Referenced by httpdomain.httpdomain.HTTPDomain.clear_doc(), and httpdomain.httpdomain.HTTPDomain.get_objects().

Here is the caller graph for this function:

◆ clear_doc() [1/2]

def httpdomain.httpdomain.HTTPDomain.clear_doc	(	self,
		docname
	)

Definition at line 642 of file httpdomain.py.

    def clear_doc(self, docname):
        for typ, routes in self.routes.items():
            for path, info in list(routes.items()):
                if info[0] == docname:
                    del routes[path]
 

References list, and httpdomain.httpdomain.HTTPDomain.routes().

Here is the call graph for this function:

◆ resolve_xref() [1/2]

def httpdomain.httpdomain.HTTPDomain.resolve_xref	(	self,
		env,
		fromdocname,
		builder,
		typ,
		target,
		node,
		contnode
	)

Definition at line 648 of file httpdomain.py.

                     node, contnode):
        try:
            info = self.data[str(typ)][target]
        except KeyError:
            text = contnode.rawsource
            role = self.roles.get(typ)
            if role is None:
                return None
 
            if fromdocname not in _doctree_cache:
                _doctree_cache[fromdocname] = env.get_doctree(fromdocname)
            doctree = _doctree_cache[fromdocname]
 
            resnode = role.result_nodes(doctree, env, node, None)[0][0]
            if isinstance(resnode, addnodes.pending_xref):
                text = node[0][0]
                reporter = doctree.reporter
                reporter.warning('Cannot resolve reference to %r' % text,
                                 line=node.line)
                return None
            return resnode
        else:
            anchor = http_resource_anchor(typ, target)
            title = typ.upper() + ' ' + target
            return make_refnode(builder, fromdocname, info[0], anchor,
                                contnode, title)
 

References TcpContext.data, GNUNET_DATACACHE_Block.data, GNUNET_DNSPARSER_RawRecord.data, GNUNET_DNSPARSER_Record.data, GNUNET_FS_ProgressInfo::GNUNET_FS_PublishStatusEvent::GNUNET_FS_PublishProgressEvent.data, GNUNET_FS_ProgressInfo.data, GNUNET_FS_ProgressInfo::GNUNET_FS_DownloadStatusEvent::GNUNET_FS_DownloadProgressEvent.data, GNUNET_FS_ProgressInfo::GNUNET_FS_UnindexEvent::GNUNET_FS_UnindexProgressEvent.data, GNUNET_GNSRECORD_Data.data, GNUNET_MESSENGER_MessagePrivate.data, GNUNET_MESSENGER_MessageTranscript.data, GNUNET_PQ_QueryParam.data, GNUNET_RECLAIM_Attribute.data, GNUNET_RECLAIM_Credential.data, GNUNET_RECLAIM_Presentation.data, GNUNET_REST_RequestHandle.data, GNUNET_SET_Element.data, GNUNET_SETI_Element.data, GNUNET_SETU_Element.data, GNUNET_SQ_QueryParam.data, Buffer.data, Value.data, UpdateContext.data, RemoveContext.data, GNUNET_FS_Uri.data, GNUNET_FS_FileInformation.data, GetFullDataClosure.data, ProcessResultClosure.data, MetaCounter.data, HandleReplyClosure.data, ProcessReplyClosure.data, MetaItem.data, DnsResult.data, userdata.data, HostSet.data, GNUNET_NAT_Test.data, GNUNET_NAT_AUTO_TestMessage.data, GNUNET_NAT_AUTO_Test.data, GNUNET_NAT_TestMessage.data, TicketRecordsEntry.data, Result.data, RequestHandle.data, ego_sign_data_cls.data, WriteContext.data, get, httpdomain.httpdomain.http_resource_anchor(), httpdomain.httpdomain.HTTPDomain.roles, and typescriptdomain.TypeScriptDomain.roles.

Here is the call graph for this function:

◆ resolve_any_xref() [1/2]

def httpdomain.httpdomain.HTTPDomain.resolve_any_xref	(	self,
		env,
		fromdocname,
		builder,
		target,
		node,
		contnode
	)

Resolve the pending_xref *node* with the given *target*.

The reference comes from an "any" or similar role, which means that Sphinx
don't know the type.

For now sphinxcontrib-httpdomain doesn't resolve any xref nodes.

:return:
   list of tuples ``('domain:role', newnode)``, where ``'domain:role'``
   is the name of a role that could have created the same reference,

Definition at line 676 of file httpdomain.py.

    def resolve_any_xref(self, env, fromdocname, builder, target, node, contnode):
        """Resolve the pending_xref *node* with the given *target*.
 
        The reference comes from an "any" or similar role, which means that Sphinx
        don't know the type.
 
        For now sphinxcontrib-httpdomain doesn't resolve any xref nodes.
 
        :return:
           list of tuples ``('domain:role', newnode)``, where ``'domain:role'``
           is the name of a role that could have created the same reference,
        """
        return []
 

◆ get_objects() [1/2]

def httpdomain.httpdomain.HTTPDomain.get_objects ( self )

Definition at line 690 of file httpdomain.py.

    def get_objects(self):
        for method, routes in self.routes.items():
            for path, info in routes.items():
                anchor = http_resource_anchor(method, path)
                yield (path, path, method, info[0], anchor, 1)
 
 

References httpdomain.httpdomain.http_resource_anchor(), and httpdomain.httpdomain.HTTPDomain.routes().

Here is the call graph for this function:

◆ routes() [2/2]

def httpdomain.httpdomain.HTTPDomain.routes ( self )

Definition at line 639 of file httpdomain.py.

    def routes(self):
        return dict((key, self.data[key]) for key in self.object_types)
 

References TcpContext.data, GNUNET_DATACACHE_Block.data, GNUNET_DNSPARSER_RawRecord.data, GNUNET_DNSPARSER_Record.data, GNUNET_FS_ProgressInfo.data, GNUNET_FS_ProgressInfo::GNUNET_FS_PublishStatusEvent::GNUNET_FS_PublishProgressEvent.data, GNUNET_FS_ProgressInfo::GNUNET_FS_DownloadStatusEvent::GNUNET_FS_DownloadProgressEvent.data, GNUNET_FS_ProgressInfo::GNUNET_FS_UnindexEvent::GNUNET_FS_UnindexProgressEvent.data, GNUNET_GNSRECORD_Data.data, GNUNET_MESSENGER_MessagePrivate.data, GNUNET_MESSENGER_MessageTranscript.data, GNUNET_PQ_QueryParam.data, GNUNET_RECLAIM_Attribute.data, GNUNET_RECLAIM_Credential.data, GNUNET_RECLAIM_Presentation.data, GNUNET_REST_RequestHandle.data, GNUNET_SET_Element.data, GNUNET_SETI_Element.data, GNUNET_SETU_Element.data, GNUNET_SQ_QueryParam.data, Buffer.data, Value.data, UpdateContext.data, RemoveContext.data, GNUNET_FS_Uri.data, GNUNET_FS_FileInformation.data, GetFullDataClosure.data, ProcessResultClosure.data, MetaCounter.data, HandleReplyClosure.data, ProcessReplyClosure.data, MetaItem.data, DnsResult.data, userdata.data, HostSet.data, GNUNET_NAT_Test.data, GNUNET_NAT_AUTO_TestMessage.data, GNUNET_NAT_AUTO_Test.data, GNUNET_NAT_TestMessage.data, TicketRecordsEntry.data, Result.data, RequestHandle.data, ego_sign_data_cls.data, WriteContext.data, and httpdomain.httpdomain.HTTPDomain.object_types.

Referenced by httpdomain.httpdomain.HTTPDomain.clear_doc(), and httpdomain.httpdomain.HTTPDomain.get_objects().

Here is the caller graph for this function:

◆ clear_doc() [2/2]

def httpdomain.httpdomain.HTTPDomain.clear_doc	(	self,
		docname
	)

Definition at line 642 of file httpdomain.py.

    def clear_doc(self, docname):
        for typ, routes in self.routes.items():
            for path, info in list(routes.items()):
                if info[0] == docname:
                    del routes[path]
 

References list, and httpdomain.httpdomain.HTTPDomain.routes().

Here is the call graph for this function:

◆ resolve_xref() [2/2]

def httpdomain.httpdomain.HTTPDomain.resolve_xref	(	self,
		env,
		fromdocname,
		builder,
		typ,
		target,
		node,
		contnode
	)

Definition at line 648 of file httpdomain.py.

                     node, contnode):
        try:
            info = self.data[str(typ)][target]
        except KeyError:
            text = contnode.rawsource
            role = self.roles.get(typ)
            if role is None:
                return None
 
            if fromdocname not in _doctree_cache:
                _doctree_cache[fromdocname] = env.get_doctree(fromdocname)
            doctree = _doctree_cache[fromdocname]
 
            resnode = role.result_nodes(doctree, env, node, None)[0][0]
            if isinstance(resnode, addnodes.pending_xref):
                text = node[0][0]
                reporter = doctree.reporter
                reporter.warning('Cannot resolve reference to %r' % text,
                                 line=node.line)
                return None
            return resnode
        else:
            anchor = http_resource_anchor(typ, target)
            title = typ.upper() + ' ' + target
            return make_refnode(builder, fromdocname, info[0], anchor,
                                contnode, title)
 

References TcpContext.data, GNUNET_DATACACHE_Block.data, GNUNET_DNSPARSER_RawRecord.data, GNUNET_DNSPARSER_Record.data, GNUNET_FS_ProgressInfo::GNUNET_FS_PublishStatusEvent::GNUNET_FS_PublishProgressEvent.data, GNUNET_FS_ProgressInfo.data, GNUNET_FS_ProgressInfo::GNUNET_FS_DownloadStatusEvent::GNUNET_FS_DownloadProgressEvent.data, GNUNET_FS_ProgressInfo::GNUNET_FS_UnindexEvent::GNUNET_FS_UnindexProgressEvent.data, GNUNET_GNSRECORD_Data.data, GNUNET_MESSENGER_MessagePrivate.data, GNUNET_MESSENGER_MessageTranscript.data, GNUNET_PQ_QueryParam.data, GNUNET_RECLAIM_Attribute.data, GNUNET_RECLAIM_Credential.data, GNUNET_RECLAIM_Presentation.data, GNUNET_REST_RequestHandle.data, GNUNET_SET_Element.data, GNUNET_SETI_Element.data, GNUNET_SETU_Element.data, GNUNET_SQ_QueryParam.data, Buffer.data, Value.data, UpdateContext.data, RemoveContext.data, GNUNET_FS_Uri.data, GNUNET_FS_FileInformation.data, GetFullDataClosure.data, ProcessResultClosure.data, MetaCounter.data, HandleReplyClosure.data, ProcessReplyClosure.data, MetaItem.data, DnsResult.data, userdata.data, HostSet.data, GNUNET_NAT_Test.data, GNUNET_NAT_AUTO_TestMessage.data, GNUNET_NAT_AUTO_Test.data, GNUNET_NAT_TestMessage.data, TicketRecordsEntry.data, Result.data, RequestHandle.data, ego_sign_data_cls.data, WriteContext.data, get, httpdomain.httpdomain.http_resource_anchor(), httpdomain.httpdomain.HTTPDomain.roles, and typescriptdomain.TypeScriptDomain.roles.

Here is the call graph for this function:

◆ resolve_any_xref() [2/2]

def httpdomain.httpdomain.HTTPDomain.resolve_any_xref	(	self,
		env,
		fromdocname,
		builder,
		target,
		node,
		contnode
	)

Resolve the pending_xref *node* with the given *target*.

The reference comes from an "any" or similar role, which means that Sphinx
don't know the type.

For now sphinxcontrib-httpdomain doesn't resolve any xref nodes.

:return:
   list of tuples ``('domain:role', newnode)``, where ``'domain:role'``
   is the name of a role that could have created the same reference,

Definition at line 676 of file httpdomain.py.

    def resolve_any_xref(self, env, fromdocname, builder, target, node, contnode):
        """Resolve the pending_xref *node* with the given *target*.
 
        The reference comes from an "any" or similar role, which means that Sphinx
        don't know the type.
 
        For now sphinxcontrib-httpdomain doesn't resolve any xref nodes.
 
        :return:
           list of tuples ``('domain:role', newnode)``, where ``'domain:role'``
           is the name of a role that could have created the same reference,
        """
        return []
 

◆ get_objects() [2/2]

def httpdomain.httpdomain.HTTPDomain.get_objects ( self )

Definition at line 690 of file httpdomain.py.

    def get_objects(self):
        for method, routes in self.routes.items():
            for path, info in routes.items():
                anchor = http_resource_anchor(method, path)
                yield (path, path, method, info[0], anchor, 1)
 
 

References httpdomain.httpdomain.http_resource_anchor(), and httpdomain.httpdomain.HTTPDomain.routes().

Here is the call graph for this function:

Field Documentation

◆ name

string httpdomain.httpdomain.HTTPDomain.name = 'http'

static

Definition at line 574 of file httpdomain.py.

◆ label

string httpdomain.httpdomain.HTTPDomain.label = 'HTTP'

static

Definition at line 575 of file httpdomain.py.

◆ object_types

dictionary httpdomain.httpdomain.HTTPDomain.object_types

static

Initial value:

=  {
        'options': ObjType('options', 'options', 'obj'),
        'head': ObjType('head', 'head', 'obj'),
        'post': ObjType('post', 'post', 'obj'),
        'get': ObjType('get', 'get', 'obj'),
        'put': ObjType('put', 'put', 'obj'),
        'patch': ObjType('patch', 'patch', 'obj'),
        'delete': ObjType('delete', 'delete', 'obj'),
        'trace': ObjType('trace', 'trace', 'obj'),
        'connect': ObjType('connect', 'connect', 'obj'),
        'copy': ObjType('copy', 'copy', 'obj'),
        'any': ObjType('any', 'any', 'obj')
    }

Definition at line 577 of file httpdomain.py.

Referenced by httpdomain.httpdomain.HTTPDomain.routes().

◆ directives

dictionary httpdomain.httpdomain.HTTPDomain.directives

static

Initial value:

=  {
        'options': HTTPOptions,
        'head': HTTPHead,
        'post': HTTPPost,
        'get': HTTPGet,
        'put': HTTPPut,
        'patch': HTTPPatch,
        'delete': HTTPDelete,
        'trace': HTTPTrace,
        'connect': HTTPConnect,
        'copy': HTTPCopy,
        'any': HTTPAny
    }

Definition at line 591 of file httpdomain.py.

◆ roles

dictionary httpdomain.httpdomain.HTTPDomain.roles

static

Initial value:

=  {
        'options': HTTPXRefRole('options'),
        'head': HTTPXRefRole('head'),
        'post': HTTPXRefRole('post'),
        'get': HTTPXRefRole('get'),
        'put': HTTPXRefRole('put'),
        'patch': HTTPXRefRole('patch'),
        'delete': HTTPXRefRole('delete'),
        'trace': HTTPXRefRole('trace'),
        'connect': HTTPXRefRole('connect'),
        'copy': HTTPXRefRole('copy'),
        'any': HTTPXRefRole('any'),
        'statuscode': HTTPXRefStatusRole(),
        'method': HTTPXRefMethodRole(),
        'header': HTTPXRefHeaderRole()
    }

Definition at line 605 of file httpdomain.py.

Referenced by httpdomain.httpdomain.HTTPDomain.resolve_xref().

◆ initial_data

dictionary httpdomain.httpdomain.HTTPDomain.initial_data

static

Initial value:

=  {
        'options': {},  # path: (docname, synopsis)
        'head': {},
        'post': {},
        'get': {},
        'put': {},
        'patch': {},
        'delete': {},
        'trace': {},
        'connect': {},
        'copy': {},
        'any': {}
    }

Definition at line 622 of file httpdomain.py.

◆ indices

list httpdomain.httpdomain.HTTPDomain.indices = []

static

Definition at line 636 of file httpdomain.py.

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

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

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ routes() [1/2]

◆ clear_doc() [1/2]

◆ resolve_xref() [1/2]

◆ resolve_any_xref() [1/2]

◆ get_objects() [1/2]

◆ routes() [2/2]

◆ clear_doc() [2/2]

◆ resolve_xref() [2/2]

◆ resolve_any_xref() [2/2]

◆ get_objects() [2/2]

Field Documentation

◆ name

◆ label

◆ object_types

◆ directives

◆ roles

◆ initial_data

◆ indices