Inheritance diagram for nv_python_libs.thewb.thewb_api.Videos:

Collaboration diagram for nv_python_libs.thewb.thewb_api.Videos:

Public Member Functions
def	__init__ (self, apikey, mythtv=True, interactive=False, select_first=False, debug=False, custom_ui=None, language=None, search_all_languages=False)

def	getSeasonEpisode (self, title)
	Start - Utility functions. More...

def	getTheWBConfig (self)

def	getUserPreferences (self)

def	updateTheWB (self, create=False)

def	searchTitle (self, title, pagenumber, pagelen, ignoreError=False)
	End of Utility functions. More...

def	searchForVideos (self, title, pagenumber)

def	displayTreeView (self)

def	createItems (self, showItems, result, urlName, showName, urlMax=None)

Public Attributes
	config

	common

	log_name

	logger

	error_messages

	channel

	s_e_Patterns

	channel_icon

	thewb_config

	userPrefs

	channelLanguage

	itemAuthor

	itemFilter

	titleFilter

	linkFilter

	descFilter1

	descFilter2

	pubdateFilter

	thumbNailFilter

	itemThumbNail

	itemDwnLink

	rssName

	feedFilter

	HTMLparser

Detailed Description

Main interface to http://www.thewb.com/
This is done to support a common naming framework for all python Netvision plugins no matter their site
target.

Supports search methods
The apikey is a not required to access http://www.thewb.com/

Definition at line 101 of file thewb_api.py.

Constructor & Destructor Documentation

◆ init()

def nv_python_libs.thewb.thewb_api.Videos.__init__	(	self,
		apikey,
		mythtv = `True`,
		interactive = `False`,
		select_first = `False`,
		debug = `False`,
		custom_ui = `None`,
		language = `None`,
		search_all_languages = `False`
	)

apikey (str/unicode):
    Specify the target site API key. Applications need their own key in some cases

mythtv (True/False):
    When True, the returned meta data is being returned has the key and values massaged to match MythTV
    When False, the returned meta data  is being returned matches what target site returned

interactive (True/False): (This option is not supported by all target site apis)
    When True, uses built-in console UI is used to select the correct show.
    When False, the first search result is used.

select_first (True/False): (This option is not supported currently implemented in any grabbers)
    Automatically selects the first series search result (rather
    than showing the user a list of more than one series).
    Is overridden by interactive = False, or specifying a custom_ui

debug (True/False):
     shows verbose debugging information

custom_ui (xx_ui.BaseUI subclass): (This option is not supported currently implemented in any grabbers)
    A callable subclass of interactive class (overrides interactive option)

language (2 character language abbreviation): (This option is not supported by all target site apis)
    The language of the returned data. Is also the language search
    uses. Default is "en" (English). For full list, run..

search_all_languages (True/False): (This option is not supported by all target site apis)
    By default, a Netvision grabber will only search in the language specified using
    the language option. When this is True, it will search for the
    show in any language

Definition at line 109 of file thewb_api.py.

Member Function Documentation

◆ getSeasonEpisode()

def nv_python_libs.thewb.thewb_api.Videos.getSeasonEpisode	(	self,
		title
	)

Start - Utility functions.

Check is there is any season or episode number information in an item's title
return array of season and/or episode numbers plus any duration in minutes and seconds
return array with None values

Definition at line 205 of file thewb_api.py.

Referenced by nv_python_libs.thewb.thewb_api.Videos.searchTitle().

◆ getTheWBConfig()

def nv_python_libs.thewb.thewb_api.Videos.getTheWBConfig ( self )

Read the MNV The WB grabber "thewb_config.xml" configuration file
return nothing

Definition at line 219 of file thewb_api.py.

Referenced by nv_python_libs.thewb.thewb_api.Videos.getUserPreferences(), and nv_python_libs.thewb.thewb_api.Videos.searchForVideos().

◆ getUserPreferences()

def nv_python_libs.thewb.thewb_api.Videos.getUserPreferences ( self )

Read the thewb_config.xml and user preference thewb.xml file.
If the thewb.xml file does not exist then create it.
If the thewb.xml file is too old then update it.
return nothing

Definition at line 239 of file thewb_api.py.

Referenced by nv_python_libs.thewb.thewb_api.Videos.displayTreeView().

◆ updateTheWB()

def nv_python_libs.thewb.thewb_api.Videos.updateTheWB	(	self,
		create = `False`
	)

Create or update the thewb.xml user preferences file
return nothing

Definition at line 277 of file thewb_api.py.

◆ searchTitle()

def nv_python_libs.thewb.thewb_api.Videos.searchTitle	(	self,
		title,
		pagenumber,
		pagelen,
		ignoreError = `False`
	)

End of Utility functions.

Key word video search of the TheWB web site
return an array of matching item elements
return

Definition at line 370 of file thewb_api.py.

Referenced by nv_python_libs.thewb.thewb_api.Videos.displayTreeView(), and nv_python_libs.thewb.thewb_api.Videos.searchForVideos().

◆ searchForVideos()

def nv_python_libs.thewb.thewb_api.Videos.searchForVideos	(	self,
		title,
		pagenumber
	)

Common name for a video search. Used to interface with MythTV plugin NetVision

Definition at line 497 of file thewb_api.py.

◆ displayTreeView()

def nv_python_libs.thewb.thewb_api.Videos.displayTreeView ( self )

Gather the The WB feeds then get a max page of videos meta data in each of them
Display the results and exit

Definition at line 562 of file thewb_api.py.

◆ createItems()

def nv_python_libs.thewb.thewb_api.Videos.createItems	(	self,
		showItems,
		result,
		urlName,
		showName,
		urlMax = `None`
	)

Create a dictionary of MNV compliant RSS items from the results of a RSS feed show search.
Also merge with any items that were found by using the Web search. Identical items use the RSS
feed item data over the search item as RSS provides better results.
return nothing as the show item dictionary will have all the results

Definition at line 755 of file thewb_api.py.