Public Member Functions
def	__init__
def	detectUserLocationByIP
	Start - Utility functions.
def	massageDescription
def	textUtf8
def	ampReplace
def	setTreeViewIcon
def	searchTitle
	End of Utility functions.
def	searchForVideos
def	getCategories
def	displayTreeView
def	processVideoUrl
def	makeURL
def	getVideos
def	getVideosForURL
Public Attributes
	config
	mythxml
	log_name
	log
	error_messages
	key_translation
	tree_order
	tree_org
	tree_customize
	feed_names
	feed_icons
	treeview
	channel_icon
	tree_dir_icon
	channel
	tree_key
Private Member Functions
def	_initLogger

Detailed Description

Main interface to http://www.youtube.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.youtube.com/

Definition at line 101 of file youtube_api.py.

Constructor & Destructor Documentation

def nv_python_libs.youtube.youtube_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 youtube_api.py.

Member Function Documentation

def nv_python_libs.youtube.youtube_api.Videos.detectUserLocationByIP ( self )

Start - Utility functions.

Get longitude and latitiude to find videos relative to your location. Up to three different
servers will be tried before giving up.
return a dictionary e.g.
{'Latitude': '43.6667', 'Country': 'Canada', 'Longitude': '-79.4167', 'City': 'Toronto'}
return an empty dictionary if there were any errors
Code found at: http://blog.suinova.com/2009/04/from-ip-to-geolocation-country-city.html

Definition at line 292 of file youtube_api.py.

def nv_python_libs.youtube.youtube_api.Videos.massageDescription	(	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 352 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.getVideos(), nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), and nv_python_libs.youtube.youtube_api.Videos.searchTitle().

def nv_python_libs.youtube.youtube_api.Videos._initLogger ( self ) [private]

Setups a logger using the logging module, returns a log object

Definition at line 386 of file youtube_api.py.

def nv_python_libs.youtube.youtube_api.Videos.textUtf8	(	self,
		text
	)

Definition at line 405 of file youtube_api.py.

Referenced by giantbomb.giantbomb_api.gamedbQueries.ampReplace(), nv_python_libs.youtube.youtube_api.Videos.ampReplace(), nv_python_libs.youtube.youtube_api.Videos.massageDescription(), and giantbomb.giantbomb_api.gamedbQueries.massageText().

def nv_python_libs.youtube.youtube_api.Videos.ampReplace	(	self,
		text
	)

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

Definition at line 417 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), nv_python_libs.youtube.youtube_api.Videos.massageDescription(), giantbomb.giantbomb_api.gamedbQueries.massageText(), nv_python_libs.youtube.youtube_api.Videos.processVideoUrl(), and nv_python_libs.youtube.youtube_api.Videos.searchTitle().

def nv_python_libs.youtube.youtube_api.Videos.setTreeViewIcon	(	self,
		dir_icon = `None`
	)

Check if there is a specific generic tree view icon. If not default to the channel icon.
return self.tree_dir_icon

Definition at line 424 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.getVideos(), and nv_python_libs.youtube.youtube_api.Videos.getVideosForURL().

def nv_python_libs.youtube.youtube_api.Videos.searchTitle	(	self,
		title,
		pagenumber,
		pagelen
	)

End of Utility functions.

Key word video search of the YouTube web site
return an array of matching item dictionaries
return

Definition at line 448 of file youtube_api.py.

def nv_python_libs.youtube.youtube_api.Videos.searchForVideos	(	self,
		title,
		pagenumber
	)

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

Definition at line 573 of file youtube_api.py.

def nv_python_libs.youtube.youtube_api.Videos.getCategories	(	self,
		dir_dict,
		categories
	)

Parse a dictionary made of subdictionaries and category list and extract all of the categories
return a list of categories

Definition at line 626 of file youtube_api.py.

def nv_python_libs.youtube.youtube_api.Videos.displayTreeView ( self )

Gather the Youtube categories/feeds/...etc then get a max page of videos meta data in each of them
return array of directories and their video metadata

Definition at line 638 of file youtube_api.py.

def nv_python_libs.youtube.youtube_api.Videos.processVideoUrl	(	self,
		item,
		elem
	)

Processes elem.get('url') to either use a custom HTML page served by
the backend, or include '&autoplay=1'

Definition at line 720 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), and nv_python_libs.youtube.youtube_api.Videos.searchTitle().

def nv_python_libs.youtube.youtube_api.Videos.makeURL	(	self,
		URL
	)

Form a URL to search for videos
return a URL

Definition at line 732 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.getVideos().

def nv_python_libs.youtube.youtube_api.Videos.getVideos	(	self,
		dir_dict,
		dictionaries
	)

Parse a list made of category lists and retrieve video meta data
return a dictionary of directory names and categories video metadata

Definition at line 758 of file youtube_api.py.

def nv_python_libs.youtube.youtube_api.Videos.getVideosForURL	(	self,
		url,
		dictionaries
	)

Get the video metadata for url search
return the video dictionary of directories and their video mata data

Definition at line 792 of file youtube_api.py.

Member Data Documentation

nv_python_libs::youtube::youtube_api.Videos::config

Definition at line 140 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos::_initLogger(), giantbomb.giantbomb_api.gamedbQueries::gameData(), giantbomb.giantbomb_api.gamedbQueries::gameSearch(), nv_python_libs.youtube.youtube_api.Videos::getVideos(), nv_python_libs.youtube.youtube_api.Videos::getVideosForURL(), tmdb.moviedbQueries::hashData(), tmdb.moviedbQueries::movieData(), tmdb.moviedbQueries::movieSearch(), tmdb.moviedbQueries::peopleData(), tmdb.moviedbQueries::peopleSearch(), and nv_python_libs.youtube.youtube_api.Videos::searchTitle().

nv_python_libs::youtube::youtube_api.Videos::mythxml

Definition at line 140 of file youtube_api.py.

nv_python_libs::youtube::youtube_api.Videos::log_name

Definition at line 140 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos._initLogger().

nv_python_libs::youtube::youtube_api.Videos::log

Definition at line 140 of file youtube_api.py.

nv_python_libs::youtube::youtube_api.Videos::error_messages

Definition at line 140 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), tmdb.moviedbQueries.hashData(), tmdb.moviedbQueries.movieData(), tmdb.moviedbQueries.movieSearch(), tmdb.moviedbQueries.peopleData(), tmdb.moviedbQueries.peopleSearch(), and nv_python_libs.youtube.youtube_api.Videos.searchTitle().

nv_python_libs::youtube::youtube_api.Videos::key_translation

Definition at line 140 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.getVideosForURL().

nv_python_libs::youtube::youtube_api.Videos::tree_order

Definition at line 140 of file youtube_api.py.

nv_python_libs::youtube::youtube_api.Videos::tree_org

Definition at line 140 of file youtube_api.py.

nv_python_libs::youtube::youtube_api.Videos::tree_customize

Definition at line 140 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.makeURL(), and nv_python_libs.dailymotion.dailymotion_api.Videos.makeURL().

nv_python_libs::youtube::youtube_api.Videos::feed_names

Definition at line 140 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.getVideosForURL().

nv_python_libs::youtube::youtube_api.Videos::feed_icons

Definition at line 140 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.getVideos(), and nv_python_libs.dailymotion.dailymotion_api.Videos.getVideos().

nv_python_libs::youtube::youtube_api.Videos::treeview

Definition at line 140 of file youtube_api.py.

nv_python_libs::youtube::youtube_api.Videos::channel_icon

Definition at line 140 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.getVideos(), and nv_python_libs.dailymotion.dailymotion_api.Videos.getVideos().

nv_python_libs::youtube::youtube_api.Videos::tree_dir_icon

Definition at line 426 of file youtube_api.py.

nv_python_libs::youtube::youtube_api.Videos::channel

Definition at line 574 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos::getVideosForURL(), and nv_python_libs.youtube.youtube_api.Videos::searchTitle().

nv_python_libs::youtube::youtube_api.Videos::tree_key

Definition at line 640 of file youtube_api.py.

Referenced by nv_python_libs.youtube.youtube_api.Videos.getVideos(), nv_python_libs.youtube.youtube_api.Videos.getVideosForURL(), and nv_python_libs.youtube.youtube_api.Videos.makeURL().

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

youtube_api.py

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation