Public Member Functions
	__init__ (self, typing.Optional[typing.Type[InfoPage]] page_class=None, typing.Optional[str] info_folder=None)

	get_page (self, str pagename, typing.Optional[str] locale=None)

	iter_pages (self, typing.Optional[str] locale=None, fallback_to_default=False)

Public Attributes
	page_class = page_class or InfoPage

str	folder = info_folder or _INFO_FOLDER

dict	CACHE = {}

str	locale_default = 'en'

list	locales

list	toc

tuple	locales = (pagename, locale)

str	CACHE = os.path.join(self.folder, locale.replace('-', '_'), pagename) + '.md'

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,
		typing.Optional[typing.Type[InfoPage]]	page_class = None,
		typing.Optional[str]	info_folder = None )

Definition at line 127 of file __init__.py.

    ):
        self.page_class = page_class or InfoPage
        self.folder: str = info_folder or _INFO_FOLDER
        """location of the Markdown files"""
 
        self.CACHE: typing.Dict[tuple, typing.Optional[InfoPage]] = {}
 
        self.locale_default: str = 'en'
        """default language"""
 
        self.locales: typing.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: typing.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,
		typing.Optional[str]	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 151 of file __init__.py.

    def get_page(self, pagename: str, locale: typing.Optional[str] = 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 searx.infopage.InfoPageSet.locale_default, and searx.infopage.InfoPageSet.toc.

Referenced by searx.infopage.InfoPageSet.iter_pages().

Here is the caller graph for this function:

◆ iter_pages()

searx.infopage.InfoPageSet.iter_pages	(		self,
		typing.Optional[str]	locale = None,
			fallback_to_default = False )

Iterate over all pages of the TOC

Definition at line 186 of file __init__.py.

    def iter_pages(self, locale: typing.Optional[str] = None, fallback_to_default=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 searx.infopage.InfoPageSet.get_page(), searx.infopage.InfoPageSet.locale_default, and searx.infopage.InfoPageSet.toc.

Here is the call graph for this function:

Member Data Documentation

◆ CACHE [1/2]

dict searx.infopage.InfoPageSet.CACHE = {}

Definition at line 134 of file __init__.py.

◆ CACHE [2/2]

str searx.infopage.InfoPageSet.CACHE = os.path.join(self.folder, locale.replace('-', '_'), pagename) + '.md'

Definition at line 171 of file __init__.py.

◆ folder

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

Definition at line 131 of file __init__.py.

◆ locale_default

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

Definition at line 136 of file __init__.py.

Referenced by searx.infopage.InfoPageSet.get_page(), and searx.infopage.InfoPageSet.iter_pages().

◆ locales [1/2]

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 139 of file __init__.py.

◆ locales [2/2]

tuple searx.infopage.InfoPageSet.locales = (pagename, locale)

Definition at line 166 of file __init__.py.

◆ page_class

searx.infopage.InfoPageSet.page_class = page_class or InfoPage

Definition at line 130 of file __init__.py.

◆ toc

searx.infopage.InfoPageSet.toc