yahoo.search.site (version 1.3, Tue Feb 27 21:54:42 MST 2007) | index /home/leif/hack/pysearch/yahoo/search/site.py

`yahoo.search.site - Site Explorer services module
This module implements the Site Explorer web services, which can be used
gain a unique perspective on your online presence. The supported classes
of site explorer are:
PageData - Shows a list of all pages belonging to a domain
InlinkData - Shows the pages from other sites linking in to a page
Update Notification - Notify Yahoo! of changes to your site
An application ID (appid) is always required when instantiating a search
object. In addition, each search class takes different set of parameters,
as defined by this table
PageData InlinkData Update Notification
-------- ---------- -------------------
query [X] [X] .
results [X] [X] .
start [X] [X] .
domain_only [X] . .
entire_site . [X] .
omit_inlinks . [X] .
url . . [X]
output [X] [X] .
callback [X] [X] .
Each of these parameter is implemented as an attribute of each
respective class. For example, you can set parameters like:
from yahoo.search.site import PageData
srch = PageData(appid="YahooDemo")
srch.query = "http://www.ogre.com"
srch.results = 75
for res in srch.parse_results():
print res.Url`

Modules

``

types | yahoo |  |

Classes

``

yahoo.search._BasicSearch(yahoo.search._Search)
  InlinkData
  PageData
yahoo.search._Search(yahoo.search.debug.Debuggable, __builtin__.object)
  UpdateNotification

class InlinkData(yahoo.search._BasicSearch)

``

`InlinkData - discover what pages link to your website
This class implements the Inlink Data web service APIs. Allowed
parameters are:
query - The query to search for (UTF-8 encoded).
results - The number of results to return (1-100).
start - The starting result position to return (1-based).
The finishing position (start + results - 1) cannot
exceed 1000.
entire_site - Specifies whether to provide results for the entire
site, or just the page referenced by the query. If the
query is not a domain URL (i.e. it contains a path,
such as http://smallbusiness.yahoo.com/webhosting/),
this parameter has no effect. Allowed values are
0 (default) or 1.
omit_inlinks - If specified, inlinks will not be returned if they
are from pages in the same domain/subdomain as the
requested page. Allowed values are domain or
subdomain.
output - The format for the output result. If json or php is
requested, the result is not XML parseable, so we
will simply return the "raw" string.
callback - The name of the callback function to wrap around
Full documentation for this service is available at:
http://developer.yahoo.net/search/siteexplorer/V1/inlinkData.html
`

Method resolution order:
  InlinkData
  yahoo.search._BasicSearch
  yahoo.search._Search
  yahoo.search.debug.Debuggable
  __builtin__.object

Data and other attributes defined here:

NAME = 'inlinkData'

SERVICE = 'SiteExplorerService'

Methods inherited from yahoo.search._Search:

__getattr__(self, name)

__init__(self, app_id, opener=None, xml_parser=None, result_factory=None, debug_level=0, **args)
  `The app_id is a required argument, the Yahoo search services will
  not accept requests without a proper app_id. A valid app_id is a
  combination of 8 - 40 characters, matching the regexp
  "^[a-zA-Z0-9 _()\[\]*+\-=,.:\\@]{8,40}$"
  Please visit http://developer.yahoo.net/search/ to request an App ID
  for your own software or application.
  Four optional arguments can also be passed to the constructor:
  opener - Opener for urllib2
  xml_parser - Function to parse XML (default: minidom)
  result_factory - Result factory class (default: none)
  debug_devel - Debug level (if any)
  All other "named" arguments are passed into as a dictionary to the
  set_params() method.
  The result factory is specific to the particular web service used,
  e.g. the different Yahoo Search services will each implement their
  own factory class.
  Both of these settings can be controlled via their respective
  install method (see below).`

__setattr__(self, name, value)
  `# Implement the attribute handlers, to avoid confusion`

encode_params(self)
  `URL encode the list of parameter values.`

get_param(self, param)
  `Get the value of a query parameter, or the default value if unset`

get_results(self, stream=None, xml_parser=None, close=True)
  `Read the stream (if provided) and either return the raw XML, or
  send the data to the provided XML parser for further processing.
  If no stream is provided, it will call the open() method using the
  default opener. The stream will be closed upon return from this
  method, unless the close=False is passed as an argument.`

get_url(self, with_params=True)
  `Return the URL for this request object`

get_valid_params(self)
  `Return a list of all valid parameters for this search`

install_opener(self, opener)
  `Install a URL opener (for use with urllib2), overriding the
  default opener. This is rarely required.`

install_result_factory(self, result_factory)
  `Install a python class (not an instance!) that should be used as a
  factory for creating result(s) objects.`

install_xml_parser(self, xml_parser)
  `Install an XML parser that will be used for all results for this
  object. The parser is expected to "read" the data from the supplied
  stream argument. To uninstall the parser (e.g. to make sure we
  return raw XML data) simply call this method with an argument of
  None.`

missing_params(self)
  `Validate that the search object is propertly setup with all
  required parameters etc. This is called automatically before a
  search is actually performed, but you can also call it manually
  if desired. It will return a list of zero or more paramters that
  are missing.`

open(self, opener=None, retries=2)
  `Open a connection to the webservice server, and request the URL.
  The return value is a "stream", which can be read calling the
  read(), readline() or readlines() methods. If you override this
  method, please make sure to call the missing_params() method before
  you try to send a request to the Web server.`

parse_results(self, xml=None)
  `Get the result from the request, and instantiate the appropriate
  result class. This class will be populated with all the data from
  the XML object.`

reset(self)
  `Reset all the parameter values for the object instance.`

set_param(self, param, value)
  `Set the value of a query parameter`

set_params(self, args)
  `Set one or several query parameters from a dictionary`

Properties inherited from yahoo.search._Search:

app_id
  `Application ID (issued by Yahoo), same ass appid`
  get = _get_app_id(self)
    `Get the application ID.`
  set = _set_app_id(self, app_id)
    `Set the application ID, which is required.`

appid
  `Application ID (issued by Yahoo)`
  get = _get_app_id(self)
    `Get the application ID.`
  set = _set_app_id(self, app_id)
    `Set the application ID, which is required.`

cc_licenses
  `List of all supported Creative Commons licenses`
  get = _get_cc_licenses(self)
    `Get the list of all supported CC licenses.`

countries
  `List of all supported county codes`
  get = _get_countries(self)
    `Get the list of all supported contry codes.`

debug_level
  `Set and modify the debug level`
  get = _get_debug_level(self)
    `Get the current debug level.`
  set = _set_debug_level(self, level)
    `Set the new debug level to be used.`

languages
  `List of all supported languages`
  get = _get_languages(self)
    `Get the list of all supported languages.`

regions
  `List of all supported region codes`
  get = _get_regions(self)
    `Get the list of all supported region codes.`

subscriptions
  `List of all supported premium subscriptions`
  get = _get_subscriptions(self)
    `Get the list of supported premium subscriptions.`

svc_name
  `Descriptive name of the service`
  get = _get_svc_name(self)
    `Get the descriptive service name.`
  set = _set_svc_name(self, value)
    `Set the descriptive service name.`

svc_protocol
  `Service protocol (e.g. HTTP)`
  get = _get_svc_protocol(self)
    `Get the service protocol (e.g. HTTP).`
  set = _set_svc_protocol(self, value)
    `Set the service protocol (must be supported).`

svc_server
  `Service server name or IP`
  get = _get_svc_server(self)
    `Get the service server name or IP.`
  set = _set_svc_server(self, value)
    `Set the service server name or IP.`

svc_service
  `Service path`
  get = _get_svc_service(self)
    `Get the URL path for the service.`
  set = _set_svc_service(self, value)
    `Set the URL path for the service.`

svc_version
  `Service version string`
  get = _get_svc_version(self)
    `Get the service version string.`
  set = _set_svc_version(self, value)
    `Set the service version string.`

Data and other attributes inherited from yahoo.search._Search:

METHOD = 'GET'

PROTOCOL = 'http'

SERVER = 'search.yahooapis.com'

VERSION = 'V1'

Data and other attributes inherited from yahoo.search.debug.Debuggable:

__dict__ = <dictproxy object>
  `dictionary for instance variables (if defined)`

__weakref__ = <attribute '__weakref__' of 'Debuggable' objects>
  `list of weak references to the object (if defined)`

class PageData(yahoo.search._BasicSearch)

``

`PageData - discover what is in the Yahoo! index
This class implements the Page Data web service APIs. Allowed
parameters are:
query - The query to search for (UTF-8 encoded).
results - The number of results to return (1-100).
start - The starting result position to return (1-based).
The finishing position (start + results - 1) cannot
exceed 1000.
domain_only - Specifies whether to provide results for all
subdomains (such as http://search.yahoo.com for
http://www.yahoo.com) of the domain query, or just the
specifically requested domain. If the query is not a
domain URL (i.e. it contains path information, such as
http://smallbusiness.yahoo.com/webhosting/), this
parameter has no effect. Allowed values are 0 (default)
or 1.
output - The format for the output result. If json or php is
requested, the result is not XML parseable, so we
will simply return the "raw" string.
callback - The name of the callback function to wrap around
Full documentation for this service is available at:
http://developer.yahoo.net/search/siteexplorer/V1/pageData.html
`

Method resolution order:
  PageData
  yahoo.search._BasicSearch
  yahoo.search._Search
  yahoo.search.debug.Debuggable
  __builtin__.object

Data and other attributes defined here:

NAME = 'pageData'

SERVICE = 'SiteExplorerService'

Methods inherited from yahoo.search._Search:

__getattr__(self, name)

__init__(self, app_id, opener=None, xml_parser=None, result_factory=None, debug_level=0, **args)
  `The app_id is a required argument, the Yahoo search services will
  not accept requests without a proper app_id. A valid app_id is a
  combination of 8 - 40 characters, matching the regexp
  "^[a-zA-Z0-9 _()\[\]*+\-=,.:\\@]{8,40}$"
  Please visit http://developer.yahoo.net/search/ to request an App ID
  for your own software or application.
  Four optional arguments can also be passed to the constructor:
  opener - Opener for urllib2
  xml_parser - Function to parse XML (default: minidom)
  result_factory - Result factory class (default: none)
  debug_devel - Debug level (if any)
  All other "named" arguments are passed into as a dictionary to the
  set_params() method.
  The result factory is specific to the particular web service used,
  e.g. the different Yahoo Search services will each implement their
  own factory class.
  Both of these settings can be controlled via their respective
  install method (see below).`

__setattr__(self, name, value)
  `# Implement the attribute handlers, to avoid confusion`

encode_params(self)
  `URL encode the list of parameter values.`

get_param(self, param)
  `Get the value of a query parameter, or the default value if unset`

get_results(self, stream=None, xml_parser=None, close=True)
  `Read the stream (if provided) and either return the raw XML, or
  send the data to the provided XML parser for further processing.
  If no stream is provided, it will call the open() method using the
  default opener. The stream will be closed upon return from this
  method, unless the close=False is passed as an argument.`

get_url(self, with_params=True)
  `Return the URL for this request object`

get_valid_params(self)
  `Return a list of all valid parameters for this search`

install_opener(self, opener)
  `Install a URL opener (for use with urllib2), overriding the
  default opener. This is rarely required.`

install_result_factory(self, result_factory)
  `Install a python class (not an instance!) that should be used as a
  factory for creating result(s) objects.`

install_xml_parser(self, xml_parser)
  `Install an XML parser that will be used for all results for this
  object. The parser is expected to "read" the data from the supplied
  stream argument. To uninstall the parser (e.g. to make sure we
  return raw XML data) simply call this method with an argument of
  None.`

missing_params(self)
  `Validate that the search object is propertly setup with all
  required parameters etc. This is called automatically before a
  search is actually performed, but you can also call it manually
  if desired. It will return a list of zero or more paramters that
  are missing.`

open(self, opener=None, retries=2)
  `Open a connection to the webservice server, and request the URL.
  The return value is a "stream", which can be read calling the
  read(), readline() or readlines() methods. If you override this
  method, please make sure to call the missing_params() method before
  you try to send a request to the Web server.`

parse_results(self, xml=None)
  `Get the result from the request, and instantiate the appropriate
  result class. This class will be populated with all the data from
  the XML object.`

reset(self)
  `Reset all the parameter values for the object instance.`

set_param(self, param, value)
  `Set the value of a query parameter`

set_params(self, args)
  `Set one or several query parameters from a dictionary`

Properties inherited from yahoo.search._Search:

app_id
  `Application ID (issued by Yahoo), same ass appid`
  get = _get_app_id(self)
    `Get the application ID.`
  set = _set_app_id(self, app_id)
    `Set the application ID, which is required.`

appid
  `Application ID (issued by Yahoo)`
  get = _get_app_id(self)
    `Get the application ID.`
  set = _set_app_id(self, app_id)
    `Set the application ID, which is required.`

cc_licenses
  `List of all supported Creative Commons licenses`
  get = _get_cc_licenses(self)
    `Get the list of all supported CC licenses.`

countries
  `List of all supported county codes`
  get = _get_countries(self)
    `Get the list of all supported contry codes.`

debug_level
  `Set and modify the debug level`
  get = _get_debug_level(self)
    `Get the current debug level.`
  set = _set_debug_level(self, level)
    `Set the new debug level to be used.`

languages
  `List of all supported languages`
  get = _get_languages(self)
    `Get the list of all supported languages.`

regions
  `List of all supported region codes`
  get = _get_regions(self)
    `Get the list of all supported region codes.`

subscriptions
  `List of all supported premium subscriptions`
  get = _get_subscriptions(self)
    `Get the list of supported premium subscriptions.`

svc_name
  `Descriptive name of the service`
  get = _get_svc_name(self)
    `Get the descriptive service name.`
  set = _set_svc_name(self, value)
    `Set the descriptive service name.`

svc_protocol
  `Service protocol (e.g. HTTP)`
  get = _get_svc_protocol(self)
    `Get the service protocol (e.g. HTTP).`
  set = _set_svc_protocol(self, value)
    `Set the service protocol (must be supported).`

svc_server
  `Service server name or IP`
  get = _get_svc_server(self)
    `Get the service server name or IP.`
  set = _set_svc_server(self, value)
    `Set the service server name or IP.`

svc_service
  `Service path`
  get = _get_svc_service(self)
    `Get the URL path for the service.`
  set = _set_svc_service(self, value)
    `Set the URL path for the service.`

svc_version
  `Service version string`
  get = _get_svc_version(self)
    `Get the service version string.`
  set = _set_svc_version(self, value)
    `Set the service version string.`

Data and other attributes inherited from yahoo.search._Search:

METHOD = 'GET'

PROTOCOL = 'http'

SERVER = 'search.yahooapis.com'

VERSION = 'V1'

Data and other attributes inherited from yahoo.search.debug.Debuggable:

__dict__ = <dictproxy object>
  `dictionary for instance variables (if defined)`

__weakref__ = <attribute '__weakref__' of 'Debuggable' objects>
  `list of weak references to the object (if defined)`

class UpdateNotification(yahoo.search._Search)
`` | `UpdateNotification - Tell the Yahoo! to index your URLs This class implements the Update Notification web service APIs. Allowed parameters are: url - The URL to submit Full documentation for this service is available at: http://developer.yahoo.com/search/siteexplorer/V1/updateNotification.html`

Method resolution order:
  UpdateNotification
  yahoo.search._Search
  yahoo.search.debug.Debuggable
  __builtin__.object

Data and other attributes defined here:

NAME = 'updateNotification'

SERVICE = 'SiteExplorerService'

Methods inherited from yahoo.search._Search:

__getattr__(self, name)

__init__(self, app_id, opener=None, xml_parser=None, result_factory=None, debug_level=0, **args)
  `The app_id is a required argument, the Yahoo search services will
  not accept requests without a proper app_id. A valid app_id is a
  combination of 8 - 40 characters, matching the regexp
  "^[a-zA-Z0-9 _()\[\]*+\-=,.:\\@]{8,40}$"
  Please visit http://developer.yahoo.net/search/ to request an App ID
  for your own software or application.
  Four optional arguments can also be passed to the constructor:
  opener - Opener for urllib2
  xml_parser - Function to parse XML (default: minidom)
  result_factory - Result factory class (default: none)
  debug_devel - Debug level (if any)
  All other "named" arguments are passed into as a dictionary to the
  set_params() method.
  The result factory is specific to the particular web service used,
  e.g. the different Yahoo Search services will each implement their
  own factory class.
  Both of these settings can be controlled via their respective
  install method (see below).`

__setattr__(self, name, value)
  `# Implement the attribute handlers, to avoid confusion`

encode_params(self)
  `URL encode the list of parameter values.`

get_param(self, param)
  `Get the value of a query parameter, or the default value if unset`

get_results(self, stream=None, xml_parser=None, close=True)
  `Read the stream (if provided) and either return the raw XML, or
  send the data to the provided XML parser for further processing.
  If no stream is provided, it will call the open() method using the
  default opener. The stream will be closed upon return from this
  method, unless the close=False is passed as an argument.`

get_url(self, with_params=True)
  `Return the URL for this request object`

get_valid_params(self)
  `Return a list of all valid parameters for this search`

install_opener(self, opener)
  `Install a URL opener (for use with urllib2), overriding the
  default opener. This is rarely required.`

install_result_factory(self, result_factory)
  `Install a python class (not an instance!) that should be used as a
  factory for creating result(s) objects.`

install_xml_parser(self, xml_parser)
  `Install an XML parser that will be used for all results for this
  object. The parser is expected to "read" the data from the supplied
  stream argument. To uninstall the parser (e.g. to make sure we
  return raw XML data) simply call this method with an argument of
  None.`

missing_params(self)
  `Validate that the search object is propertly setup with all
  required parameters etc. This is called automatically before a
  search is actually performed, but you can also call it manually
  if desired. It will return a list of zero or more paramters that
  are missing.`

open(self, opener=None, retries=2)
  `Open a connection to the webservice server, and request the URL.
  The return value is a "stream", which can be read calling the
  read(), readline() or readlines() methods. If you override this
  method, please make sure to call the missing_params() method before
  you try to send a request to the Web server.`

parse_results(self, xml=None)
  `Get the result from the request, and instantiate the appropriate
  result class. This class will be populated with all the data from
  the XML object.`

reset(self)
  `Reset all the parameter values for the object instance.`

set_param(self, param, value)
  `Set the value of a query parameter`

set_params(self, args)
  `Set one or several query parameters from a dictionary`

Properties inherited from yahoo.search._Search:

app_id
  `Application ID (issued by Yahoo), same ass appid`
  get = _get_app_id(self)
    `Get the application ID.`
  set = _set_app_id(self, app_id)
    `Set the application ID, which is required.`

appid
  `Application ID (issued by Yahoo)`
  get = _get_app_id(self)
    `Get the application ID.`
  set = _set_app_id(self, app_id)
    `Set the application ID, which is required.`

cc_licenses
  `List of all supported Creative Commons licenses`
  get = _get_cc_licenses(self)
    `Get the list of all supported CC licenses.`

countries
  `List of all supported county codes`
  get = _get_countries(self)
    `Get the list of all supported contry codes.`

debug_level
  `Set and modify the debug level`
  get = _get_debug_level(self)
    `Get the current debug level.`
  set = _set_debug_level(self, level)
    `Set the new debug level to be used.`

languages
  `List of all supported languages`
  get = _get_languages(self)
    `Get the list of all supported languages.`

regions
  `List of all supported region codes`
  get = _get_regions(self)
    `Get the list of all supported region codes.`

subscriptions
  `List of all supported premium subscriptions`
  get = _get_subscriptions(self)
    `Get the list of supported premium subscriptions.`

svc_name
  `Descriptive name of the service`
  get = _get_svc_name(self)
    `Get the descriptive service name.`
  set = _set_svc_name(self, value)
    `Set the descriptive service name.`

svc_protocol
  `Service protocol (e.g. HTTP)`
  get = _get_svc_protocol(self)
    `Get the service protocol (e.g. HTTP).`
  set = _set_svc_protocol(self, value)
    `Set the service protocol (must be supported).`

svc_server
  `Service server name or IP`
  get = _get_svc_server(self)
    `Get the service server name or IP.`
  set = _set_svc_server(self, value)
    `Set the service server name or IP.`

svc_service
  `Service path`
  get = _get_svc_service(self)
    `Get the URL path for the service.`
  set = _set_svc_service(self, value)
    `Set the URL path for the service.`

svc_version
  `Service version string`
  get = _get_svc_version(self)
    `Get the service version string.`
  set = _set_svc_version(self, value)
    `Set the service version string.`

Data and other attributes inherited from yahoo.search._Search:

METHOD = 'GET'

PROTOCOL = 'http'

SERVER = 'search.yahooapis.com'

VERSION = 'V1'

Data and other attributes inherited from yahoo.search.debug.Debuggable:

__dict__ = <dictproxy object>
  `dictionary for instance variables (if defined)`

__weakref__ = <attribute '__weakref__' of 'Debuggable' objects>
  `list of weak references to the object (if defined)`

Data
`` |  | __author__ = 'Leif Hedstrom <leif@ogre.com>' __date__ = 'Tue Feb 27 21:54:42 MST 2007' __revision__ = '$Id: site.py,v 1.3 2007/02/28 05:20:09 zwoop Exp $' __version__ = '$Revision: 1.3 $'

Author
`` |  | Leif Hedstrom <leif@ogre.com>