httpdomain.httpdomain.HTTPIndex Class Reference

Inheritance diagram for httpdomain.httpdomain.HTTPIndex:

Collaboration diagram for httpdomain.httpdomain.HTTPIndex:

Public Member Functions
def	__init__ (self, *args, **kwargs)
def	grouping_prefix (self, path)
def	generate (self, docnames=None)
def	__init__ (self, *args, **kwargs)
def	grouping_prefix (self, path)
def	generate (self, docnames=None)

Data Fields
	ignore
	shortname
	localname

Static Public Attributes
string	name = 'routingtable'
string	localname = 'HTTP Routing Table'
string	shortname = 'routing table'

Detailed Description

Definition at line 524 of file httpdomain.py.

Constructor & Destructor Documentation

__init__() [1/2]

def httpdomain.httpdomain.HTTPIndex.__init__	(		self,
		*	args,
		**	kwargs
	)

Definition at line 530 of file httpdomain.py.

    def __init__(self, *args, **kwargs):
        super(HTTPIndex, self).__init__(*args, **kwargs)
 
        self.ignore = [
            [l for l in x.split('/') if l]
            for x in self.domain.env.config['http_index_ignore_prefixes']]
        self.ignore.sort(reverse=True)
 
        # During HTML generation these values pick from class,
        # not from instance so we have a little hack the system
        cls = self.__class__
        cls.shortname = self.domain.env.config['http_index_shortname']
        cls.localname = self.domain.env.config['http_index_localname']
 

References httpdomain.httpdomain.HTTPIndex.__init__().

Referenced by httpdomain.httpdomain.HTTPIndex.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

__init__() [2/2]

def httpdomain.httpdomain.HTTPIndex.__init__	(		self,
		*	args,
		**	kwargs
	)

Definition at line 530 of file httpdomain.py.

    def __init__(self, *args, **kwargs):
        super(HTTPIndex, self).__init__(*args, **kwargs)
 
        self.ignore = [
            [l for l in x.split('/') if l]
            for x in self.domain.env.config['http_index_ignore_prefixes']]
        self.ignore.sort(reverse=True)
 
        # During HTML generation these values pick from class,
        # not from instance so we have a little hack the system
        cls = self.__class__
        cls.shortname = self.domain.env.config['http_index_shortname']
        cls.localname = self.domain.env.config['http_index_localname']
 

References httpdomain.httpdomain.HTTPIndex.__init__(), Zone.domain, MhdHttpList.domain, Socks5Request.domain, httpdomain.httpdomain.HTTPIndex.ignore, httpdomain.httpdomain.HTTPIndex.localname, and httpdomain.httpdomain.HTTPIndex.shortname.

Here is the call graph for this function:

Member Function Documentation

grouping_prefix() [1/2]

def httpdomain.httpdomain.HTTPIndex.grouping_prefix	(		self,
			path
	)

Definition at line 544 of file httpdomain.py.

    def grouping_prefix(self, path):
        letters = [x for x in path.split('/') if x]
        for prefix in self.ignore:
            if letters[:len(prefix)] == prefix:
                return '/' + '/'.join(letters[:len(prefix) + 1])
        return '/%s' % (letters[0] if letters else '',)
 

References httpdomain.httpdomain.HTTPIndex.ignore.

Referenced by httpdomain.httpdomain.HTTPIndex.generate().

Here is the caller graph for this function:

generate() [1/2]

def httpdomain.httpdomain.HTTPIndex.generate	(		self,
			docnames = None
	)

Definition at line 551 of file httpdomain.py.

    def generate(self, docnames=None):
        content = {}
        items = ((method, path, info)
                 for method, routes in self.domain.routes.items()
                 for path, info in routes.items())
        items = sorted(items, key=lambda item: item[1])
        for method, path, info in items:
            entries = content.setdefault(self.grouping_prefix(path), [])
            entries.append([
                method.upper() + ' ' + path, 0, info[0],
                http_resource_anchor(method, path),
                '', 'Deprecated' if info[2] else '', info[1]
            ])
        items = sorted(
            (path, sort_by_method(entries))
            for path, entries in content.items()
        )
        return (items, True)
 
 

References Zone.domain, MhdHttpList.domain, Socks5Request.domain, httpdomain.httpdomain.HTTPIndex.grouping_prefix(), httpdomain.httpdomain.http_resource_anchor(), and httpdomain.httpdomain.sort_by_method().

Here is the call graph for this function:

grouping_prefix() [2/2]

def httpdomain.httpdomain.HTTPIndex.grouping_prefix	(		self,
			path
	)

Definition at line 544 of file httpdomain.py.

    def grouping_prefix(self, path):
        letters = [x for x in path.split('/') if x]
        for prefix in self.ignore:
            if letters[:len(prefix)] == prefix:
                return '/' + '/'.join(letters[:len(prefix) + 1])
        return '/%s' % (letters[0] if letters else '',)
 

References httpdomain.httpdomain.HTTPIndex.ignore.

Referenced by httpdomain.httpdomain.HTTPIndex.generate().

Here is the caller graph for this function:

generate() [2/2]

def httpdomain.httpdomain.HTTPIndex.generate	(		self,
			docnames = None
	)

Definition at line 551 of file httpdomain.py.

    def generate(self, docnames=None):
        content = {}
        items = ((method, path, info)
                 for method, routes in self.domain.routes.items()
                 for path, info in routes.items())
        items = sorted(items, key=lambda item: item[1])
        for method, path, info in items:
            entries = content.setdefault(self.grouping_prefix(path), [])
            entries.append([
                method.upper() + ' ' + path, 0, info[0],
                http_resource_anchor(method, path),
                '', 'Deprecated' if info[2] else '', info[1]
            ])
        items = sorted(
            (path, sort_by_method(entries))
            for path, entries in content.items()
        )
        return (items, True)
 
 

References Zone.domain, MhdHttpList.domain, Socks5Request.domain, httpdomain.httpdomain.HTTPIndex.grouping_prefix(), httpdomain.httpdomain.http_resource_anchor(), and httpdomain.httpdomain.sort_by_method().

Here is the call graph for this function:

Field Documentation

name

string httpdomain.httpdomain.HTTPIndex.name = 'routingtable'

static

Definition at line 526 of file httpdomain.py.

localname [1/2]

string httpdomain.httpdomain.HTTPIndex.localname = 'HTTP Routing Table'

static

Definition at line 527 of file httpdomain.py.

Referenced by httpdomain.httpdomain.HTTPIndex.__init__().

shortname [1/2]

string httpdomain.httpdomain.HTTPIndex.shortname = 'routing table'

static

Definition at line 528 of file httpdomain.py.

Referenced by httpdomain.httpdomain.HTTPIndex.__init__().

ignore

httpdomain.httpdomain.HTTPIndex.ignore

Definition at line 533 of file httpdomain.py.

Referenced by httpdomain.httpdomain.HTTPIndex.__init__(), and httpdomain.httpdomain.HTTPIndex.grouping_prefix().

shortname [2/2]

httpdomain.httpdomain.HTTPIndex.shortname

Definition at line 541 of file httpdomain.py.

Referenced by httpdomain.httpdomain.HTTPIndex.__init__().

localname [2/2]

httpdomain.httpdomain.HTTPIndex.localname

Definition at line 542 of file httpdomain.py.

Referenced by httpdomain.httpdomain.HTTPIndex.__init__().

---

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

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