searx.infopage.InfoPageSet Class Reference

Collaboration diagram for searx.infopage.InfoPageSet:

Public Member Functions
	__init__ (self, type[InfoPage]|None page_class=None, str|None info_folder=None)
	get_page (self, str pagename, str|None locale=None)
	iter_pages (self, str|None locale=None, bool fallback_to_default=False)

Public Attributes
type[InfoPage]	page_class = page_class or InfoPage
str	folder = info_folder or _INFO_FOLDER
dict	CACHE = {}
str	locale_default = 'en'
list	locales
list	toc

Detailed Description

Cached rendering of the online documentation a SearXNG instance has.

:param page_class: render online documentation by :py:obj:`InfoPage` parser.
:type page_class: :py:obj:`InfoPage`

:param info_folder: information directory
:type info_folder: str

Definition at line 117 of file __init__.py.

Constructor & Destructor Documentation

__init__()

searx.infopage.InfoPageSet.__init__	(		self,
		type[InfoPage] | None	page_class = None,
		str | None	info_folder = None )

Definition at line 127 of file __init__.py.

    def __init__(self, page_class: type[InfoPage] | None = None, info_folder: str | None = None):
        self.page_class: type[InfoPage] = page_class or InfoPage
        self.folder: str = info_folder or _INFO_FOLDER
        """location of the Markdown files"""
 
        self.CACHE: dict[tuple[str, str], InfoPage | None] = {}
 
        self.locale_default: str = 'en'
        """default language"""
 
        self.locales: list[str] = [
            locale.replace('_', '-') for locale in os.listdir(_INFO_FOLDER) if locale.replace('_', '-') in LOCALE_NAMES
        ]
        """list of supported languages (aka locales)"""
 
        self.toc: list[str] = [
            'search-syntax',
            'about',
            'donate',
        ]
        """list of articles in the online documentation"""
 

Member Function Documentation

get_page()

searx.infopage.InfoPageSet.get_page	(		self,
		str	pagename,
		str | None	locale = None )

Return ``pagename`` instance of :py:obj:`InfoPage`

:param pagename: name of the page, a value from :py:obj:`InfoPageSet.toc`
:type pagename: str

:param locale: language of the page, e.g. ``en``, ``zh_Hans_CN``
               (default: :py:obj:`InfoPageSet.i18n_origin`)
:type locale: str

Definition at line 149 of file __init__.py.

    def get_page(self, pagename: str, locale: str | None = None):
        """Return ``pagename`` instance of :py:obj:`InfoPage`
 
        :param pagename: name of the page, a value from :py:obj:`InfoPageSet.toc`
        :type pagename: str
 
        :param locale: language of the page, e.g. ``en``, ``zh_Hans_CN``
                       (default: :py:obj:`InfoPageSet.i18n_origin`)
        :type locale: str
 
        """
        locale = locale or self.locale_default
 
        if pagename not in self.toc:
            return None
        if locale not in self.locales:
            return None
 
        cache_key = (pagename, locale)
 
        if cache_key in self.CACHE:
            return self.CACHE[cache_key]
 
        # not yet instantiated
 
        fname = os.path.join(self.folder, locale.replace('-', '_'), pagename) + '.md'
        if not os.path.exists(fname):
            logger.info('file %s does not exists', fname)
            self.CACHE[cache_key] = None
            return None
 
        page = self.page_class(fname)
        self.CACHE[cache_key] = page
        return page
 

References CACHE, folder, locale_default, locales, page_class, and toc.

Referenced by iter_pages().

Here is the caller graph for this function:

iter_pages()

searx.infopage.InfoPageSet.iter_pages	(		self,
		str | None	locale = None,
		bool	fallback_to_default = False )

Iterate over all pages of the TOC

Definition at line 184 of file __init__.py.

    def iter_pages(self, locale: str | None = None, fallback_to_default: bool = False):
        """Iterate over all pages of the TOC"""
        locale = locale or self.locale_default
        for page_name in self.toc:
            page_locale = locale
            page = self.get_page(page_name, locale)
            if fallback_to_default and page is None:
                page_locale = self.locale_default
                page = self.get_page(page_name, self.locale_default)
            if page is not None:
                # page is None if the page was deleted by the administrator
                yield page_name, page_locale, page

References get_page(), locale_default, and toc.

Here is the call graph for this function:

Member Data Documentation

CACHE

dict searx.infopage.InfoPageSet.CACHE = {}

Definition at line 132 of file __init__.py.

Referenced by get_page().

folder

str searx.infopage.InfoPageSet.folder = info_folder or _INFO_FOLDER

Definition at line 129 of file __init__.py.

Referenced by get_page().

locale_default

str searx.infopage.InfoPageSet.locale_default = 'en'

Definition at line 134 of file __init__.py.

Referenced by get_page(), and iter_pages().

locales

list searx.infopage.InfoPageSet.locales

Initial value:

=  [
            locale.replace('_', '-') for locale in os.listdir(_INFO_FOLDER) if locale.replace('_', '-') in LOCALE_NAMES
        ]

Definition at line 137 of file __init__.py.

Referenced by get_page().

page_class

type[InfoPage] searx.infopage.InfoPageSet.page_class = page_class or InfoPage

Definition at line 128 of file __init__.py.

Referenced by get_page().

toc

list searx.infopage.InfoPageSet.toc

Initial value:

=  [
            'search-syntax',
            'about',
            'donate',
        ]

Definition at line 142 of file __init__.py.

Referenced by get_page(), and iter_pages().

---

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

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