pycrossword  0.3
Pure-Python implementation of a crossword puzzle generator and editor
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
pycross.utils.onlineservices.GoogleSearch Class Reference

Public Member Functions

def __init__ (self, settings, search_phrase='', exact_match=False, file_types=None, lang=None, country=None, interface_lang=None, link_site=None, related_site=None, in_site=None, nresults=-1, safe_search=False, timeout=5000)
 
def init (self, search_phrase='', exact_match=False, file_types=None, lang=None, country=None, interface_lang=None, link_site=None, related_site=None, in_site=None, nresults=-1, safe_search=False, timeout=5000)
 
def encode_search (self)
 
def decode_result (self, txt)
 
def search (self, method='json')
 
def search_lite (self)
 

Static Public Member Functions

def get_interface_languages ()
 
def get_document_languages ()
 
def get_document_countries ()
 
def get_user_countries ()
 

Public Attributes

 settings
 
 search_phrase
 
 exact_match
 
 file_types
 
 lang
 
 country
 
 interface_lang
 
 link_site
 
 related_site
 
 in_site
 
 nresults
 
 safe_search
 
 timeout
 

Constructor & Destructor Documentation

◆ __init__()

def pycross.utils.onlineservices.GoogleSearch.__init__ (   self,
  settings,
  search_phrase = '',
  exact_match = False,
  file_types = None,
  lang = None,
  country = None,
  interface_lang = None,
  link_site = None,
  related_site = None,
  in_site = None,
  nresults = -1,
  safe_search = False,
  timeout = 5000 
)

Member Function Documentation

◆ decode_result()

def pycross.utils.onlineservices.GoogleSearch.decode_result (   self,
  txt 
)

◆ encode_search()

def pycross.utils.onlineservices.GoogleSearch.encode_search (   self)

◆ get_document_countries()

def pycross.utils.onlineservices.GoogleSearch.get_document_countries ( )
static

◆ get_document_languages()

def pycross.utils.onlineservices.GoogleSearch.get_document_languages ( )
static

◆ get_interface_languages()

def pycross.utils.onlineservices.GoogleSearch.get_interface_languages ( )
static

◆ get_user_countries()

def pycross.utils.onlineservices.GoogleSearch.get_user_countries ( )
static

◆ init()

def pycross.utils.onlineservices.GoogleSearch.init (   self,
  search_phrase = '',
  exact_match = False,
  file_types = None,
  lang = None,
  country = None,
  interface_lang = None,
  link_site = None,
  related_site = None,
  in_site = None,
  nresults = -1,
  safe_search = False,
  timeout = 5000 
)

◆ search()

def pycross.utils.onlineservices.GoogleSearch.search (   self,
  method = 'json' 
)
Returns full Google search results for 'self.search_phrase'.

◆ search_lite()

def pycross.utils.onlineservices.GoogleSearch.search_lite (   self)
Retrieves search results for 'self.search_phrase' as a list in the following format:
[{'url': 'URL', 'title': 'TITLE', 'summary': 'SNIPPET'}, ...]
See https://developers.google.com/custom-search/v1/cse/list

Member Data Documentation

◆ country

pycross.utils.onlineservices.GoogleSearch.country

◆ exact_match

pycross.utils.onlineservices.GoogleSearch.exact_match

◆ file_types

pycross.utils.onlineservices.GoogleSearch.file_types

◆ in_site

pycross.utils.onlineservices.GoogleSearch.in_site

◆ interface_lang

pycross.utils.onlineservices.GoogleSearch.interface_lang

◆ lang

pycross.utils.onlineservices.GoogleSearch.lang

◆ link_site

pycross.utils.onlineservices.GoogleSearch.link_site

◆ nresults

pycross.utils.onlineservices.GoogleSearch.nresults

◆ related_site

pycross.utils.onlineservices.GoogleSearch.related_site

◆ safe_search

pycross.utils.onlineservices.GoogleSearch.safe_search

◆ search_phrase

pycross.utils.onlineservices.GoogleSearch.search_phrase

◆ settings

pycross.utils.onlineservices.GoogleSearch.settings

◆ timeout

pycross.utils.onlineservices.GoogleSearch.timeout

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