Classes
class	Code

Functions
bool	is_valid_language (str code_language)

Variables
list	__all__ = ["Code"]
list	_pygments_languages = []

Detailed Description

Typification of the *code* results.  Results of this type are rendered in
the :origin:`code.html <searx/templates/simple/result_templates/code.html>`
template.  For highlighting the code passages, Pygments_ is used.

.. _Pygments:  https://pygments.org

----

.. autoclass:: Code
   :members:
   :show-inheritance:

Function Documentation

◆ is_valid_language()

bool searx.result_types.code.is_valid_language ( str code_language )

Checks if the specified ``code_language`` is known in Pygments.

Definition at line 35 of file code.py.

def is_valid_language(code_language: str) -> bool:
    """Checks if the specified ``code_language`` is known in Pygments."""
    if not _pygments_languages:
        for l in LEXERS.values():
            # l[2] is the tuple with the alias names
            for alias_name in l[2]:
                _pygments_languages.append(alias_name.lower())
    return code_language.lower() in _pygments_languages
 
 
@t.final

Variable Documentation

◆ all

list searx.result_types.code.__all__ = ["Code"]

private

Definition at line 19 of file code.py.

◆ _pygments_languages

list searx.result_types.code._pygments_languages = []

protected

Definition at line 32 of file code.py.

Classes

Functions