nova3.nova2 Namespace Reference

Functions
def	initialize_engines ()
	Every engine should have a "search" method taking a space-free string as parameter (ex. More...
def	engines_to_xml (supported_engines)
def	displayCapabilities (supported_engines)
def	run_search (engine_list)
def	main (args)

Variables
bool	THREADED = True
	MAX_THREADS = cpu_count()
dictionary	CATEGORIES = {'all', 'movies', 'tv', 'music', 'games', 'anime', 'software', 'pictures', 'books'}

Function Documentation

displayCapabilities()

def nova3.nova2.displayCapabilities

(

supported_engines

)

Display capabilities in XML format
<capabilities>
  <engine_short_name>
    <name>long name</name>
    <url>http://example.com</url>
    <categories>movies music games</categories>
  </engine_short_name>
</capabilities>

Definition at line 105 of file nova2.py.

def displayCapabilities(supported_engines):
    """
    Display capabilities in XML format
    <capabilities>
      <engine_short_name>
        <name>long name</name>
        <url>http://example.com</url>
        <categories>movies music games</categories>
      </engine_short_name>
    </capabilities>
    """
    xml = "".join(("<capabilities>\n",
                   "".join(engines_to_xml(supported_engines)),
                   "</capabilities>"))
    print(xml)
 
 

References nova3.nova2.engines_to_xml(), and Utils::String.join().

Referenced by nova3.nova2.main().

Here is the call graph for this function:

Here is the caller graph for this function:

engines_to_xml()

def nova3.nova2.engines_to_xml

(

supported_engines

)

 Generates xml for supported engines 

Definition at line 85 of file nova2.py.

def engines_to_xml(supported_engines):
    """ Generates xml for supported engines """
    tab = " " * 4
 
    for short_name in supported_engines:
        search_engine = globals()[short_name]()
 
        supported_categories = ""
        if hasattr(search_engine, "supported_categories"):
            supported_categories = " ".join((key
                                             for key in search_engine.supported_categories.keys()
                                             if key != "all"))
 
        yield "".join((tab, "<", short_name, ">\n",
                       tab, tab, "<name>", search_engine.name, "</name>\n",
                       tab, tab, "<url>", search_engine.url, "</url>\n",
                       tab, tab, "<categories>", supported_categories, "</categories>\n",
                       tab, "</", short_name, ">\n"))
 
 

References Utils::String.join().

Referenced by nova3.nova2.displayCapabilities().

Here is the call graph for this function:

Here is the caller graph for this function:

initialize_engines()

def nova3.nova2.initialize_engines

(

)

Every engine should have a "search" method taking a space-free string as parameter (ex.

"family+guy") it should call prettyPrinter() with a dict as parameter. The keys in the dict must be: link,name,size,seeds,leech,engine_url As a convention, try to list results by decreasing number of seeds or similar

 Import available engines

    Return list of available engines

Definition at line 59 of file nova2.py.

def initialize_engines():
    """ Import available engines
 
        Return list of available engines
    """
    supported_engines = []
 
    engines = glob(path.join(path.dirname(__file__), 'engines', '*.py'))
    for engine in engines:
        engi = path.basename(engine).split('.')[0].strip()
        if len(engi) == 0 or engi.startswith('_'):
            continue
        try:
            # import engines.[engine]
            engine_module = __import__(".".join(("engines", engi)))
            # get low-level module
            engine_module = getattr(engine_module, engi)
            # bind class name
            globals()[engi] = getattr(engine_module, engi)
            supported_engines.append(engi)
        except Exception:
            pass
 
    return supported_engines
 
 

References Utils::String.join().

Referenced by nova3.nova2.main().

Here is the call graph for this function:

Here is the caller graph for this function:

main()

def nova3.nova2.main

(

args

)

Definition at line 145 of file nova2.py.

def main(args):
    supported_engines = initialize_engines()
 
    if not args:
        raise SystemExit("./nova2.py [all|engine1[,engine2]*] <category> <keywords>\n"
                         "available engines: %s" % (','.join(supported_engines)))
 
    elif args[0] == "--capabilities":
        displayCapabilities(supported_engines)
        return
 
    elif len(args) < 3:
        raise SystemExit("./nova2.py [all|engine1[,engine2]*] <category> <keywords>\n"
                         "available engines: %s" % (','.join(supported_engines)))
 
    # get only unique engines with set
    engines_list = set(e.lower() for e in args[0].strip().split(','))
 
    if 'all' in engines_list:
        engines_list = supported_engines
    else:
        # discard un-supported engines
        engines_list = [engine for engine in engines_list
                        if engine in supported_engines]
 
    if not engines_list:
        # engine list is empty. Nothing to do here
        return
 
    cat = args[1].lower()
 
    if cat not in CATEGORIES:
        raise SystemExit(" - ".join(('Invalid category', cat)))
 
    what = urllib.parse.quote(' '.join(args[2:]))
    if THREADED:
        # child process spawning is controlled min(number of searches, number of cpu)
        with Pool(min(len(engines_list), MAX_THREADS)) as pool:
            pool.map(run_search, ([globals()[engine], what, cat] for engine in engines_list))
    else:
        # py3 note: map is needed to be evaluated for content to be executed
        all(map(run_search, ([globals()[engine], what, cat] for engine in engines_list)))
 
 

References nova3.nova2.displayCapabilities(), nova3.nova2.initialize_engines(), and Utils::String.join().

Here is the call graph for this function:

run_search()

def nova3.nova2.run_search

(

engine_list

)

 Run search in engine

    @param engine_list List with engine, query and category

    @retval False if any exceptions occurred
    @retval True  otherwise

Definition at line 122 of file nova2.py.

def run_search(engine_list):
    """ Run search in engine
 
        @param engine_list List with engine, query and category
 
        @retval False if any exceptions occurred
        @retval True  otherwise
    """
    engine, what, cat = engine_list
    try:
        engine = engine()
        # avoid exceptions due to invalid category
        if hasattr(engine, 'supported_categories'):
            if cat in engine.supported_categories:
                engine.search(what, cat)
        else:
            engine.search(what)
 
        return True
    except Exception:
        return False
 
 

Variable Documentation

CATEGORIES

dictionary nova3.nova2.CATEGORIES = {'all', 'movies', 'tv', 'music', 'games', 'anime', 'software', 'pictures', 'books'}

Definition at line 48 of file nova2.py.

MAX_THREADS

int nova3.nova2.MAX_THREADS = cpu_count()

Definition at line 44 of file nova2.py.

THREADED

bool nova3.nova2.THREADED = True

Definition at line 42 of file nova2.py.