yahoo.search.dom.site (version 1.3, Wed Feb 28 16:21:14 MST 2007) | index /home/leif/hack/pysearch/yahoo/search/dom/site.py

`DOM parser for Site Explorer results
Implement a simple DOM parsers for the Yahoo Search Web Services site
explorer APIs. This provides parser for the following classes:
PageData - Shows a list of all pages belonging to a domain
InlinkData - Shows the pages from other sites linking in to a page`

Modules

``

yahoo.search.dom |  |  |

Classes

``

yahoo.search.dom.DOMResultParser(yahoo.search.parser.ResultParser)
  PageData
  UpdateNotification

class PageData(yahoo.search.dom.DOMResultParser)
`` | `PageData - DOM parser for PageData results Each result is a dictionary populated with the extracted data from the XML results. The following keys are always available: Title - The title of the web page. Url - The URL for the web page. ClickUrl - The URL for linking to the page. Example: results = ws.parse_results(dom) for res in results: print "%s - %s" % (res.Title, res.Url)`

Method resolution order:
  PageData
  yahoo.search.dom.DOMResultParser
  yahoo.search.parser.ResultParser
  __builtin__.object

Methods inherited from yahoo.search.dom.DOMResultParser:

parse_results(self, dom_object)
  `This is a simple DOM parser for all Yahoo Search services. It
  expects to find a top-level node named ResultSet. This is the main
  entry point for the DOM parser, and it requires a properly con-
  structed DOM object (e.g. using minidom).`

Methods inherited from yahoo.search.parser.ResultParser:

__init__(self, service, res_dict=<class 'yahoo.search.parser.ResultDict'>)

__iter__(self)

Properties inherited from yahoo.search.parser.ResultParser:

firstResultPosition
  `The first result position`
  get = _get_first_result_position(self)
    `Get the first result position.`

first_result_position
  `The first result position`
  get = _get_first_result_position(self)
    `Get the first result position.`

results
  `The list of all results`
  get = _get_results(self)
    `Get the results.`

service
  `The Search Web Service object for this results parser`
  get = _get_service(self)
    `Get the service for this DOM parser.`
  set = _set_service(self, service)
    `Set the service for this DOM parser.`

totalResultsAvailable
  `Total number of results for the query`
  get = _get_total_results_available(self)
    `Get the total number of results for the query.`

totalResultsReturned
  `The number of results returned`
  get = _get_total_results_returned(self)
    `Get the number of results returned.`

total_results_available
  `Total number of results for the query`
  get = _get_total_results_available(self)
    `Get the total number of results for the query.`

total_results_returned
  `The number of results returned`
  get = _get_total_results_returned(self)
    `Get the number of results returned.`

Data and other attributes inherited from yahoo.search.parser.ResultParser:

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

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

class UpdateNotification(yahoo.search.dom.DOMResultParser)
`` | `UpdateNotification - DOM parser for Site Update Notification The return value for this is always a list with one single element, a dictionary with Success - Did we succeed or not (True or False) Error - In case of a failure, the error message`

Method resolution order:
  UpdateNotification
  yahoo.search.dom.DOMResultParser
  yahoo.search.parser.ResultParser
  __builtin__.object

Methods defined here:

parse_results(self, dom_object)
  `Internal method to parse one Result node`

Methods inherited from yahoo.search.parser.ResultParser:

__init__(self, service, res_dict=<class 'yahoo.search.parser.ResultDict'>)

__iter__(self)

Properties inherited from yahoo.search.parser.ResultParser:

firstResultPosition
  `The first result position`
  get = _get_first_result_position(self)
    `Get the first result position.`

first_result_position
  `The first result position`
  get = _get_first_result_position(self)
    `Get the first result position.`

results
  `The list of all results`
  get = _get_results(self)
    `Get the results.`

service
  `The Search Web Service object for this results parser`
  get = _get_service(self)
    `Get the service for this DOM parser.`
  set = _set_service(self, service)
    `Set the service for this DOM parser.`

totalResultsAvailable
  `Total number of results for the query`
  get = _get_total_results_available(self)
    `Get the total number of results for the query.`

totalResultsReturned
  `The number of results returned`
  get = _get_total_results_returned(self)
    `Get the number of results returned.`

total_results_available
  `Total number of results for the query`
  get = _get_total_results_available(self)
    `Get the total number of results for the query.`

total_results_returned
  `The number of results returned`
  get = _get_total_results_returned(self)
    `Get the number of results returned.`

Data and other attributes inherited from yahoo.search.parser.ResultParser:

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

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

Data
`` |  | __author__ = 'Leif Hedstrom <leif@ogre.com>' __date__ = 'Wed Feb 28 16:21:14 MST 2007' __revision__ = '$Id: site.py,v 1.3 2007/02/28 23:21:30 zwoop Exp $' __version__ = '$Revision: 1.3 $'

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