Public Member Functions
def	__init__ (self, apikey, debug=False)

def	massageText (self, text)

def	textUtf8 (self, text)

def	ampReplace (self, text)

def	htmlToString (self, context, html)

def	getHtmlData (self, context, *args)

def	pubDate (self, context, *inputArgs)

def	futureReleaseDate (self, context, gameElement)

def	findImages (self, context, *args)

def	getImages (self, context, arg)

def	supportedJobs (self, context, *inputArgs)

def	translateName (self, context, *inputArgs)

def	buildFuncDict (self)

def	gameSearch (self, gameTitle)

def	gameData (self, gameId)

Public Attributes
	config

	error_messages

	baseProcessingDir

	pubDateFormat

	xmlParser

	supportedJobList

	tagTranslations

	imageElements

	FuncDict

Detailed Description

Methods that query api.giantbomb.com for metadata and outputs the results to stdout any errors are output
to stderr.

Definition at line 90 of file giantbomb_api.py.

Constructor & Destructor Documentation

◆ init()

def giantbomb.giantbomb_api.gamedbQueries.__init__	(	self,
		apikey,
		debug = `False`
	)

apikey (str/unicode):
    Specify the api.giantbomb.com API key. Applications need their own key.
    See https://www.giantbomb.com/api/ to get your own API key

debug (True/False):
     shows verbose debugging information

Definition at line 94 of file giantbomb_api.py.

Member Function Documentation

◆ ampReplace()

def giantbomb.giantbomb_api.gamedbQueries.ampReplace	(	self,
		text
	)

Replace all "&" characters with "&amp;"

Definition at line 194 of file giantbomb_api.py.

Referenced by nv_python_libs.vimeo.vimeo_api.Videos.getTreeVideos(), nv_python_libs.dailymotion.dailymotion_api.Videos.getVideosForGroupURL(), nv_python_libs.bliptv.bliptv_api.Videos.getVideosForURL(), nv_python_libs.mtv.mtv_api.Videos.getVideosForURL(), nv_python_libs.bliptv.bliptv_api.Videos.massageDescription(), nv_python_libs.dailymotion.dailymotion_api.Videos.massageDescription(), nv_python_libs.mtv.mtv_api.Videos.massageDescription(), nv_python_libs.vimeo.vimeo_api.Videos.massageDescription(), giantbomb.giantbomb_api.gamedbQueries.massageText(), nv_python_libs.common.common_api.Common.massageText(), nv_python_libs.bliptv.bliptv_api.Videos.processVideoUrl(), nv_python_libs.dailymotion.dailymotion_api.Videos.processVideoUrl(), nv_python_libs.vimeo.vimeo_api.Videos.processVideoUrl(), and nv_python_libs.vimeo.vimeo_api.Videos.searchTitle().

◆ buildFuncDict()

def giantbomb.giantbomb_api.gamedbQueries.buildFuncDict ( self )

 Build a dictionary of the XPath extention function for the XSLT stylesheets
Returns nothing

Definition at line 392 of file giantbomb_api.py.

Referenced by giantbomb.giantbomb_api.gamedbQueries.gameData(), and giantbomb.giantbomb_api.gamedbQueries.gameSearch().

◆ findImages()

def giantbomb.giantbomb_api.gamedbQueries.findImages	(		self,
			context,
		*	args
	)

Parse the "image" and "description" elements for images and put in a persistant array
return True when there are images available
return False if there are no images

Definition at line 313 of file giantbomb_api.py.

◆ futureReleaseDate()

def giantbomb.giantbomb_api.gamedbQueries.futureReleaseDate	(	self,
		context,
		gameElement
	)

Convert the "expected" release date into the default MNV item format.
return the formatted pubDate string
return If there is not enough information to make a date then return an empty string

Definition at line 280 of file giantbomb_api.py.

◆ gameData()

def giantbomb.giantbomb_api.gamedbQueries.gameData	(	self,
		gameId
	)

Display a Game details in XML format:
https://www.mythtv.org/wiki/MythTV_Universal_Metadata_Format
Returns nothing

Definition at line 449 of file giantbomb_api.py.

◆ gameSearch()

def giantbomb.giantbomb_api.gamedbQueries.gameSearch	(	self,
		gameTitle
	)

Display a Game query in XML format:
https://www.mythtv.org/wiki/MythTV_Universal_Metadata_Format
Returns nothing

Definition at line 409 of file giantbomb_api.py.

◆ getHtmlData()

def giantbomb.giantbomb_api.gamedbQueries.getHtmlData	(		self,
			context,
		*	args
	)

 Take a HTML string and convert it to an HTML element. Then apply a filter and return
the results.
return filter array
return an empty array if the filter failed to find any values.

Definition at line 211 of file giantbomb_api.py.

◆ getImages()

def giantbomb.giantbomb_api.gamedbQueries.getImages	(	self,
		context,
		arg
	)

Return an array of image elements that was created be a previous "findImages" function call
return the array of image elements

Definition at line 357 of file giantbomb_api.py.

◆ htmlToString()

def giantbomb.giantbomb_api.gamedbQueries.htmlToString	(	self,
		context,
		html
	)

 Remove HTML tags and LFs from a string
return the string without HTML tags or LFs

Definition at line 202 of file giantbomb_api.py.

◆ massageText()

def giantbomb.giantbomb_api.gamedbQueries.massageText	(	self,
		text
	)

Removes HTML markup from a text string.
@param text The HTML source.
@return The plain text.  If the HTML source contains non-ASCII
entities or character references, this is a Unicode string.

Definition at line 141 of file giantbomb_api.py.

Referenced by giantbomb.giantbomb_api.gamedbQueries.htmlToString(), and nv_python_libs.common.common_api.Common.htmlToString().

◆ pubDate()

def giantbomb.giantbomb_api.gamedbQueries.pubDate	(		self,
			context,
		*	inputArgs
	)

Convert a date/time string in a specified format into a pubDate. The default is the
MNV item format
return the formatted pubDate string
return on error return the original date string

Definition at line 237 of file giantbomb_api.py.

◆ supportedJobs()

def giantbomb.giantbomb_api.gamedbQueries.supportedJobs	(		self,
			context,
		*	inputArgs
	)

Validate that the job category is supported by the
Universal Metadata Format item format
return True is supported
return False if not supported

Definition at line 364 of file giantbomb_api.py.

◆ textUtf8()

def giantbomb.giantbomb_api.gamedbQueries.textUtf8	(	self,
		text
	)

Definition at line 182 of file giantbomb_api.py.

Referenced by giantbomb.giantbomb_api.gamedbQueries.ampReplace(), nv_python_libs.bliptv.bliptv_api.Videos.ampReplace(), nv_python_libs.common.common_api.Common.ampReplace(), nv_python_libs.dailymotion.dailymotion_api.Videos.ampReplace(), nv_python_libs.mtv.mtv_api.Videos.ampReplace(), nv_python_libs.vimeo.vimeo_api.Videos.ampReplace(), nv_python_libs.bliptv.bliptv_api.Videos.massageDescription(), nv_python_libs.dailymotion.dailymotion_api.Videos.massageDescription(), nv_python_libs.mtv.mtv_api.Videos.massageDescription(), nv_python_libs.vimeo.vimeo_api.Videos.massageDescription(), giantbomb.giantbomb_api.gamedbQueries.massageText(), and nv_python_libs.common.common_api.Common.massageText().

◆ translateName()

def giantbomb.giantbomb_api.gamedbQueries.translateName	(		self,
			context,
		*	inputArgs
	)

Translate a tag name into the Universal Metadata Format item equivalent
return the translated tag equivalent
return the input name as the name does not need translating and is already been validated

Definition at line 380 of file giantbomb_api.py.

Member Data Documentation

◆ baseProcessingDir

giantbomb.giantbomb_api.gamedbQueries.baseProcessingDir

Definition at line 116 of file giantbomb_api.py.

Referenced by nv_python_libs.common.common_api.Common.addDynamicFunctions(), nv_python_libs.common.common_api.Common.baseDir(), giantbomb.giantbomb_api.gamedbQueries.gameData(), giantbomb.giantbomb_api.gamedbQueries.gameSearch(), nv_python_libs.common.common_api.Common.getUrlData(), and nv_python_libs.common.common_api.Common.linkWebPage().

◆ config

giantbomb.giantbomb_api.gamedbQueries.config

Definition at line 105 of file giantbomb_api.py.

◆ error_messages

giantbomb.giantbomb_api.gamedbQueries.error_messages

Definition at line 114 of file giantbomb_api.py.

◆ FuncDict

giantbomb.giantbomb_api.gamedbQueries.FuncDict

Definition at line 396 of file giantbomb_api.py.

Referenced by giantbomb.giantbomb_api.gamedbQueries.gameData(), and giantbomb.giantbomb_api.gamedbQueries.gameSearch().

◆ imageElements

giantbomb.giantbomb_api.gamedbQueries.imageElements

Definition at line 330 of file giantbomb_api.py.

Referenced by giantbomb.giantbomb_api.gamedbQueries.getImages().

◆ pubDateFormat

giantbomb.giantbomb_api.gamedbQueries.pubDateFormat

Definition at line 118 of file giantbomb_api.py.

Referenced by nv_python_libs.common.common_api.Common.createItemElement(), giantbomb.giantbomb_api.gamedbQueries.pubDate(), and nv_python_libs.common.common_api.Common.pubDate().

◆ supportedJobList

giantbomb.giantbomb_api.gamedbQueries.supportedJobList

Definition at line 121 of file giantbomb_api.py.

Referenced by giantbomb.giantbomb_api.gamedbQueries.supportedJobs().

◆ tagTranslations

giantbomb.giantbomb_api.gamedbQueries.tagTranslations

Definition at line 122 of file giantbomb_api.py.

Referenced by giantbomb.giantbomb_api.gamedbQueries.translateName().

◆ xmlParser

giantbomb.giantbomb_api.gamedbQueries.xmlParser

Definition at line 119 of file giantbomb_api.py.

The documentation for this class was generated from the following file:

mythplugins/mythgame/mythgame/scripts/giantbomb/giantbomb_api.py

Public Member Functions

Public Attributes