searx.infopage.InfoPage Class Reference

Public Member Functions
	__init__ (self, fname)
	raw_content (self)
	content (self)
	title (self)
	html (self)
	get_ctx (self)
	__repr__ (self)

Public Attributes
	fname
	content

Detailed Description

A page of the :py:obj:`online documentation <InfoPageSet>`.

Definition at line 42 of file __init__.py.

Constructor & Destructor Documentation

__init__()

searx.infopage.InfoPage.__init__	(		self,
			fname )

Definition at line 45 of file __init__.py.

    def __init__(self, fname):
        self.fname = fname
 

Member Function Documentation

__repr__()

searx.infopage.InfoPage.__repr__

(

self

)

Definition at line 101 of file __init__.py.

    def __repr__(self):
        return f'<{self.__class__.__name__} fname={self.fname!r}>'
 
 

content()

searx.infopage.InfoPage.content

(

self

)

Content of the page (rendered in a Jinja context)

Definition at line 55 of file __init__.py.

    def content(self):
        """Content of the page (rendered in a Jinja context)"""
        ctx = self.get_ctx()
        template = jinja2.Environment().from_string(self.raw_content)
        return template.render(**ctx)
 

References searx.infopage.InfoPage.get_ctx(), and searx.infopage.InfoPage.raw_content().

Here is the call graph for this function:

get_ctx()

searx.infopage.InfoPage.get_ctx

(

self

)

Jinja context to render :py:obj:`InfoPage.content`

Definition at line 82 of file __init__.py.

    def get_ctx(self):
        """Jinja context to render :py:obj:`InfoPage.content`"""
 
        def _md_link(name, url):
            url = url_for(url, _external=True)
            return "[%s](%s)" % (name, url)
 
        def _md_search(query):
            url = '%s?q=%s' % (url_for('search', _external=True), urllib.parse.quote(query))
            return '[%s](%s)' % (query, url)
 
        ctx = {}
        ctx['GIT_URL'] = GIT_URL
        ctx['get_setting'] = get_setting
        ctx['link'] = _md_link
        ctx['search'] = _md_search
 
        return ctx
 

Referenced by searx.infopage.InfoPage.content().

Here is the caller graph for this function:

html()

searx.infopage.InfoPage.html

(

self

)

Render Markdown (CommonMark_) to HTML by using markdown-it-py_.

.. _CommonMark: https://commonmark.org/
.. _markdown-it-py: https://github.com/executablebooks/markdown-it-py

Definition at line 71 of file __init__.py.

    def html(self):
        """Render Markdown (CommonMark_) to HTML by using markdown-it-py_.
 
        .. _CommonMark: https://commonmark.org/
        .. _markdown-it-py: https://github.com/executablebooks/markdown-it-py
 
        """
        return (
            MarkdownIt("commonmark", {"typographer": True}).enable(["replacements", "smartquotes"]).render(self.content)
        )
 

raw_content()

searx.infopage.InfoPage.raw_content

(

self

)

Raw content of the page (without any jinja rendering)

Definition at line 49 of file __init__.py.

    def raw_content(self):
        """Raw content of the page (without any jinja rendering)"""
        with open(self.fname, 'r', encoding='utf-8') as f:
            return f.read()
 

References searx.infopage.InfoPage.fname.

Referenced by searx.infopage.InfoPage.content(), and searx.infopage.InfoPage.title().

Here is the caller graph for this function:

title()

searx.infopage.InfoPage.title

(

self

)

Title of the content (without any markup)

Definition at line 62 of file __init__.py.

    def title(self):
        """Title of the content (without any markup)"""
        t = ""
        for l in self.raw_content.split('\n'):
            if l.startswith('# '):
                t = l.strip('# ')
        return t
 

References searx.infopage.InfoPage.raw_content().

Here is the call graph for this function:

Member Data Documentation

content

searx.infopage.InfoPage.content

Definition at line 79 of file __init__.py.

fname

searx.infopage.InfoPage.fname

Definition at line 46 of file __init__.py.

Referenced by searx.infopage.InfoPage.raw_content().

---

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

• /home/andrew/Documents/code/public/searxng/searx/infopage/__init__.py