Functions
	get_imdb_url_id (imdb_item_id)

	get_wikimedia_image_id (url)

	get_external_url (url_id, item_id, alternative="default")

	get_earth_coordinates_url (latitude, longitude, osm_zoom, alternative='default')

	area_to_osm_zoom (area)

Variables
dict	IMDB_PREFIX_TO_URL_ID

str	HTTP_WIKIMEDIA_IMAGE = 'http://commons.wikimedia.org/wiki/Special:FilePath/'

Function Documentation

◆ area_to_osm_zoom()

searx.external_urls.area_to_osm_zoom ( area )

Convert an area in km² into an OSM zoom. Less reliable if the shape is not round.

logarithm regression using these data:
 * 9596961 -> 4 (China)
 * 3287263 -> 5 (India)
 * 643801 -> 6 (France)
 * 6028 -> 9
 * 1214 -> 10
 * 891 -> 12
 * 12 -> 13

In WolframAlpha:
    >>> log fit {9596961,15},{3287263, 14},{643801,13},{6028,10},{1214,9},{891,7},{12,6}

with 15 = 19-4 (China); 14 = 19-5 (India) and so on

Args:
    area (int,float,str): area in km²

Returns:
    int: OSM zoom or 19 in area is not a number

Definition at line 66 of file external_urls.py.

def area_to_osm_zoom(area):
    """Convert an area in km² into an OSM zoom. Less reliable if the shape is not round.
 
    logarithm regression using these data:
     * 9596961 -> 4 (China)
     * 3287263 -> 5 (India)
     * 643801 -> 6 (France)
     * 6028 -> 9
     * 1214 -> 10
     * 891 -> 12
     * 12 -> 13
 
    In WolframAlpha:
        >>> log fit {9596961,15},{3287263, 14},{643801,13},{6028,10},{1214,9},{891,7},{12,6}
 
    with 15 = 19-4 (China); 14 = 19-5 (India) and so on
 
    Args:
        area (int,float,str): area in km²
 
    Returns:
        int: OSM zoom or 19 in area is not a number
    """
    try:
        amount = float(area)
        return max(0, min(19, round(19 - 0.688297 * math.log(226.878 * amount))))
    except ValueError:
        return 19

◆ get_earth_coordinates_url()

searx.external_urls.get_earth_coordinates_url	(	latitude,
		longitude,
		osm_zoom,
		alternative = 'default' )

Definition at line 56 of file external_urls.py.

def get_earth_coordinates_url(latitude, longitude, osm_zoom, alternative='default'):
    url = (
        get_external_url('map', None, alternative)
        .replace('${latitude}', str(latitude))
        .replace('${longitude}', str(longitude))
        .replace('${zoom}', str(osm_zoom))
    )
    return url
 
 

◆ get_external_url()

searx.external_urls.get_external_url	(	url_id,
		item_id,
		alternative = "default" )

Return an external URL or None if url_id is not found.

url_id can take value from data/external_urls.json
The "imdb_id" value is automatically converted according to the item_id value.

If item_id is None, the raw URL with the $1 is returned.

Definition at line 32 of file external_urls.py.

def get_external_url(url_id, item_id, alternative="default"):
    """Return an external URL or None if url_id is not found.
 
    url_id can take value from data/external_urls.json
    The "imdb_id" value is automatically converted according to the item_id value.
 
    If item_id is None, the raw URL with the $1 is returned.
    """
    if item_id is not None:
        if url_id == 'imdb_id':
            url_id = get_imdb_url_id(item_id)
        elif url_id == 'wikimedia_image':
            item_id = get_wikimedia_image_id(item_id)
 
    url_description = EXTERNAL_URLS.get(url_id)
    if url_description:
        url_template = url_description["urls"].get(alternative)
        if url_template is not None:
            if item_id is not None:
                return url_template.replace('$1', item_id)
            return url_template
    return None
 
 

References searx.external_urls.get_imdb_url_id(), and searx.external_urls.get_wikimedia_image_id().

Here is the call graph for this function:

◆ get_imdb_url_id()

searx.external_urls.get_imdb_url_id ( imdb_item_id )

Definition at line 19 of file external_urls.py.

def get_imdb_url_id(imdb_item_id):
    id_prefix = imdb_item_id[:2]
    return IMDB_PREFIX_TO_URL_ID.get(id_prefix)
 
 

Referenced by searx.external_urls.get_external_url().

Here is the caller graph for this function:

◆ get_wikimedia_image_id()

searx.external_urls.get_wikimedia_image_id ( url )

Definition at line 24 of file external_urls.py.

def get_wikimedia_image_id(url):
    if url.startswith(HTTP_WIKIMEDIA_IMAGE):
        return url[len(HTTP_WIKIMEDIA_IMAGE) :]
    if url.startswith('File:'):
        return url[len('File:') :]
    return url
 
 

Referenced by searx.external_urls.get_external_url().

Here is the caller graph for this function:

Variable Documentation

◆ HTTP_WIKIMEDIA_IMAGE

str searx.external_urls.HTTP_WIKIMEDIA_IMAGE = 'http://commons.wikimedia.org/wiki/Special:FilePath/'

Definition at line 16 of file external_urls.py.

◆ IMDB_PREFIX_TO_URL_ID

dict searx.external_urls.IMDB_PREFIX_TO_URL_ID

Initial value:

=  {
    'tt': 'imdb_title',
    'mn': 'imdb_name',
    'ch': 'imdb_character',
    'co': 'imdb_company',
    'ev': 'imdb_event',
}

Definition at line 9 of file external_urls.py.

Functions

Variables