Functions
	request (query, params)

	parse_lyric (hit)

	parse_artist (hit)

	parse_album (hit)

	response (resp)

Variables
dict	about

list	categories = ['music', 'lyrics']

bool	paging = True

int	page_size = 5

str	url = 'https://genius.com/api/'

str	search_url = url + 'search/{index}?{query}&page={pageno}&per_page={page_size}'

str	music_player = 'https://genius.com{api_path}/apple_music_player'

dict	parse = {'lyric': parse_lyric, 'song': parse_lyric, 'artist': parse_artist, 'album': parse_album}

Detailed Description

Genius

Function Documentation

◆ parse_album()

searx.engines.genius.parse_album ( hit )

Definition at line 76 of file genius.py.

def parse_album(hit):
    res = hit['result']
    content = res.get('name_with_artist', res.get('name', ''))
    x = res.get('release_date_components')
    if x:
        x = x.get('year')
        if x:
            content = "%s / %s" % (x, content)
    return {
        'url': res['url'],
        'title': res['full_title'],
        'img_src': res['cover_art_url'],
        'content': content.strip(),
    }
 
 

◆ parse_artist()

searx.engines.genius.parse_artist ( hit )

Definition at line 66 of file genius.py.

def parse_artist(hit):
    result = {
        'url': hit['result']['url'],
        'title': hit['result']['name'],
        'content': '',
        'img_src': hit['result']['image_url'],
    }
    return result
 
 

◆ parse_lyric()

searx.engines.genius.parse_lyric ( hit )

Definition at line 40 of file genius.py.

def parse_lyric(hit):
    content = ''
    highlights = hit['highlights']
    if highlights:
        content = hit['highlights'][0]['value']
    else:
        content = hit['result'].get('title_with_featured', '')
 
    timestamp = hit['result']['lyrics_updated_at']
    result = {
        'url': hit['result']['url'],
        'title': hit['result']['full_title'],
        'content': content,
        'img_src': hit['result']['song_art_image_thumbnail_url'],
    }
    if timestamp:
        result.update({'publishedDate': datetime.fromtimestamp(timestamp)})
    api_path = hit['result'].get('api_path')
    if api_path:
        # The players are just playing 30sec from the title.  Some of the player
        # will be blocked because of a cross-origin request and some players will
        # link to apple when you press the play button.
        result['iframe_src'] = music_player.format(api_path=api_path)
    return result
 
 

◆ request()

searx.engines.genius.request	(		query,
			params )

Definition at line 30 of file genius.py.

def request(query, params):
    params['url'] = search_url.format(
        query=urlencode({'q': query}),
        index='multi',
        page_size=page_size,
        pageno=params['pageno'],
    )
    return params
 
 

◆ response()

searx.engines.genius.response ( resp )

Definition at line 95 of file genius.py.

def response(resp):
    results = []
    for section in resp.json()['response']['sections']:
        for hit in section['hits']:
            func = parse.get(hit['type'])
            if func:
                results.append(func(hit))
    return results

Variable Documentation

◆ about

dict searx.engines.genius.about

Initial value:

=  {
    "website": 'https://genius.com/',
    "wikidata_id": 'Q3419343',
    "official_api_documentation": 'https://docs.genius.com/',
    "use_official_api": True,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 11 of file genius.py.

◆ categories

list searx.engines.genius.categories = ['music', 'lyrics']

Definition at line 21 of file genius.py.

◆ music_player

str searx.engines.genius.music_player = 'https://genius.com{api_path}/apple_music_player'

Definition at line 27 of file genius.py.

◆ page_size

int searx.engines.genius.page_size = 5

Definition at line 23 of file genius.py.

◆ paging

bool searx.engines.genius.paging = True

Definition at line 22 of file genius.py.

◆ parse

dict searx.engines.genius.parse = {'lyric': parse_lyric, 'song': parse_lyric, 'artist': parse_artist, 'album': parse_album}

Definition at line 92 of file genius.py.

◆ search_url

str searx.engines.genius.search_url = url + 'search/{index}?{query}&page={pageno}&per_page={page_size}'

Definition at line 26 of file genius.py.

◆ url

str searx.engines.genius.url = 'https://genius.com/api/'

Definition at line 25 of file genius.py.

Functions

Variables