searx.plugins.unit_converter Namespace Reference

Classes
class	SXNGPlugin

Functions
str|None	_parse_text_and_convert (from_query, to_query)

Variables
str	name = ""
	description = gettext("")
str	plugin_id = ""
str	preference_section = ""
list	CONVERT_KEYWORDS = ["in", "to", "as"]
str	RE_MEASURE

Detailed Description

A plugin for converting measured values from one unit to another unit (a
unit converter).

The plugin looks up the symbols (given in the query term) in a list of
converters, each converter is one item in the list (compare
:py:obj:`ADDITIONAL_UNITS`).  If the symbols are ambiguous, the matching units
of measurement are evaluated.  The weighting in the evaluation results from the
sorting of the :py:obj:`list of unit converters<symbol_to_si>`.

Function Documentation

_parse_text_and_convert()

str | None searx.plugins.unit_converter._parse_text_and_convert ( from_query, to_query )

protected

Definition at line 89 of file unit_converter.py.

def _parse_text_and_convert(from_query, to_query) -> str | None:
 
    # pylint: disable=too-many-branches, too-many-locals
 
    if not (from_query and to_query):
        return None
 
    measured = re.match(RE_MEASURE, from_query, re.VERBOSE)
    if not (measured and measured.group('number'), measured.group('unit')):
        return None
 
    # Symbols are not unique, if there are several hits for the from-unit, then
    # the correct one must be determined by comparing it with the to-unit
    # https://github.com/searxng/searxng/pull/3378#issuecomment-2080974863
 
    # first: collecting possible units
 
    source_list, target_list = [], []
 
    for symbol, si_name, from_si, to_si, orig_symbol in symbol_to_si():
 
        if symbol == measured.group('unit'):
            source_list.append((si_name, to_si))
        if symbol == to_query:
            target_list.append((si_name, from_si, orig_symbol))
 
    if not (source_list and target_list):
        return None
 
    source_to_si = target_from_si = target_symbol = None
 
    # second: find the right unit by comparing list of from-units with list of to-units
 
    for source in source_list:
        for target in target_list:
            if source[0] == target[0]:  # compare si_name
                source_to_si = source[1]
                target_from_si = target[1]
                target_symbol = target[2]
 
    if not (source_to_si and target_from_si):
        return None
 
    _locale = get_locale() or 'en_US'
 
    value = measured.group('sign') + measured.group('number') + (measured.group('E') or '')
    value = babel.numbers.parse_decimal(value, locale=_locale)
 
    # convert value to SI unit
 
    if isinstance(source_to_si, (float, int)):
        value = float(value) * source_to_si
    else:
        value = source_to_si(float(value))
 
    # convert value from SI unit to target unit
 
    if isinstance(target_from_si, (float, int)):
        value = float(value) * target_from_si
    else:
        value = target_from_si(float(value))
 
    if measured.group('E'):
        # when incoming notation is scientific, outgoing notation is scientific
        result = babel.numbers.format_scientific(value, locale=_locale)
    else:
        result = babel.numbers.format_decimal(value, locale=_locale, format='#,##0.##########;-#')
 
    return f'{result} {target_symbol}'

Referenced by searx.plugins.unit_converter.SXNGPlugin.post_search().

Here is the caller graph for this function:

Variable Documentation

CONVERT_KEYWORDS

list searx.plugins.unit_converter.CONVERT_KEYWORDS = ["in", "to", "as"]

Definition at line 34 of file unit_converter.py.

description

searx.plugins.unit_converter.description = gettext("")

Definition at line 29 of file unit_converter.py.

name

str searx.plugins.unit_converter.name = ""

Definition at line 28 of file unit_converter.py.

plugin_id

str searx.plugins.unit_converter.plugin_id = ""

Definition at line 31 of file unit_converter.py.

preference_section

str searx.plugins.unit_converter.preference_section = ""

Definition at line 32 of file unit_converter.py.

RE_MEASURE

str searx.plugins.unit_converter.RE_MEASURE

Initial value:

=  r'''
(?P<sign>[-+]?)         # +/- or nothing for positive
(\s*)                   # separator: white space or nothing
(?P<number>[\d\.,]*)    # number: 1,000.00 (en) or 1.000,00 (de)
(?P<E>[eE][-+]?\d+)?    # scientific notation: e(+/-)2 (*10^2)
(\s*)                   # separator: white space or nothing
(?P<unit>\S+)           # unit of measure
'''

Definition at line 79 of file unit_converter.py.