2020-11-04 14:12:59 +01:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2020-12-14 19:16:25 +01:00
< title > utils/standalone_searx.py — Searx Documentation (Searx-0.18.0.tex)< / title >
2020-11-04 14:12:59 +01:00
< link rel = "stylesheet" href = "../_static/pygments.css" type = "text/css" / >
2021-01-05 16:45:49 +01:00
< link rel = "stylesheet" href = "../_static/searx.css" type = "text/css" / >
2020-11-04 14:12:59 +01:00
< link rel = "stylesheet" type = "text/css" href = "../_static/sphinx_tabs/semantic-ui-2.4.1/segment.min.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/sphinx_tabs/semantic-ui-2.4.1/menu.min.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/sphinx_tabs/semantic-ui-2.4.1/tab.min.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/sphinx_tabs/tabs.css" / >
< script id = "documentation_options" data-url_root = "../" src = "../_static/documentation_options.js" > < / script >
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
< script src = "../_static/doctools.js" > < / script >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "Blog" href = "../blog/index.html" / >
< link rel = "prev" title = "utils/lxc.sh" href = "lxc.sh.html" / >
< script > DOCUMENTATION _OPTIONS . URL _ROOT = '../' ; < / script >
< / head > < body >
< div class = "related" role = "navigation" aria-label = "related navigation" >
< h3 > Navigation< / h3 >
< ul >
< li class = "right" style = "margin-right: 10px" >
< a href = "../genindex.html" title = "General Index"
accesskey="I">index< / a > < / li >
< li class = "right" >
< a href = "../py-modindex.html" title = "Python Module Index"
>modules< / a > |< / li >
< li class = "right" >
< a href = "../blog/index.html" title = "Blog"
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "lxc.sh.html" title = "utils/lxc.sh"
accesskey="P">previous< / a > |< / li >
2020-12-14 19:16:25 +01:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Searx Documentation (Searx-0.18.0.tex)< / a > » < / li >
2020-11-04 14:12:59 +01:00
< li class = "nav-item nav-item-1" > < a href = "index.html" accesskey = "U" > Tooling box < code class = "docutils literal notranslate" > < span class = "pre" > utils/*< / span > < / code > < / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > < code class = "docutils literal notranslate" > < span class = "pre" > utils/standalone_searx.py< / span > < / code > < / a > < / li >
< / ul >
< / div >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< div class = "section" id = "module-standalone_searx" >
< span id = "utils-standalone-searx-py" > < / span > < span id = "standalone-searx-py" > < / span > < h1 > < code class = "docutils literal notranslate" > < span class = "pre" > utils/standalone_searx.py< / span > < / code > < a class = "headerlink" href = "#module-standalone_searx" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > Script to run searx from terminal.< / p >
< p > Getting categories without initiate the engine will only return < cite > [‘ ’ < / cite > < / p >
< div class = "doctest highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "kn" > import< / span > < span class = "nn" > searx.engines< / span >
< span class = "gp" > ... < / span > < span class = "nb" > list< / span > < span class = "p" > (< / span > < span class = "n" > searx< / span > < span class = "o" > .< / span > < span class = "n" > engines< / span > < span class = "o" > .< / span > < span class = "n" > categories< / span > < span class = "o" > .< / span > < span class = "n" > keys< / span > < span class = "p" > ())< / span >
< span class = "go" > [' general' ]< / span >
2020-12-17 11:53:16 +01:00
< span class = "gp" > > > > < / span > < span class = "kn" > import< / span > < span class = "nn" > searx.search< / span >
< span class = "gp" > ... < / span > < span class = "n" > searx< / span > < span class = "o" > .< / span > < span class = "n" > search< / span > < span class = "o" > .< / span > < span class = "n" > initialize< / span > < span class = "p" > ()< / span >
2020-11-04 14:12:59 +01:00
< span class = "gp" > ... < / span > < span class = "nb" > list< / span > < span class = "p" > (< / span > < span class = "n" > searx< / span > < span class = "o" > .< / span > < span class = "n" > engines< / span > < span class = "o" > .< / span > < span class = "n" > categories< / span > < span class = "o" > .< / span > < span class = "n" > keys< / span > < span class = "p" > ())< / span >
< span class = "go" > [' general' , ' it' , ' science' , ' images' , ' news' , ' videos' , ' music' , ' files' , ' social media' , ' map' ]< / span >
< / pre > < / div >
< / div >
< p > Example to use this script:< / p >
2020-12-27 18:07:26 +01:00
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ python3 utils/standalone_searx.py rain
2020-11-04 14:12:59 +01:00
< / pre > < / div >
< / div >
< p > Example to run it from python:< / p >
< div class = "doctest highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "kn" > import< / span > < span class = "nn" > importlib< / span >
< span class = "gp" > ... < / span > < span class = "kn" > import< / span > < span class = "nn" > json< / span >
< span class = "gp" > ... < / span > < span class = "kn" > import< / span > < span class = "nn" > sys< / span >
< span class = "gp" > ... < / span > < span class = "kn" > import< / span > < span class = "nn" > searx.engines< / span >
2020-12-17 11:53:16 +01:00
< span class = "gp" > ... < / span > < span class = "kn" > import< / span > < span class = "nn" > searx.search< / span >
2020-11-04 14:12:59 +01:00
< span class = "gp" > ... < / span > < span class = "n" > search_query< / span > < span class = "o" > =< / span > < span class = "s1" > ' rain' < / span >
< span class = "gp" > ... < / span > < span class = "c1" > # initialize engines< / span >
2020-12-17 11:53:16 +01:00
< span class = "gp" > ... < / span > < span class = "n" > searx< / span > < span class = "o" > .< / span > < span class = "n" > search< / span > < span class = "o" > .< / span > < span class = "n" > initialize< / span > < span class = "p" > ()< / span >
2020-11-04 14:12:59 +01:00
< span class = "gp" > ... < / span > < span class = "c1" > # load engines categories once instead of each time the function called< / span >
< span class = "gp" > ... < / span > < span class = "n" > engine_cs< / span > < span class = "o" > =< / span > < span class = "nb" > list< / span > < span class = "p" > (< / span > < span class = "n" > searx< / span > < span class = "o" > .< / span > < span class = "n" > engines< / span > < span class = "o" > .< / span > < span class = "n" > categories< / span > < span class = "o" > .< / span > < span class = "n" > keys< / span > < span class = "p" > ())< / span >
< span class = "gp" > ... < / span > < span class = "c1" > # load module< / span >
< span class = "gp" > ... < / span > < span class = "n" > spec< / span > < span class = "o" > =< / span > < span class = "n" > importlib< / span > < span class = "o" > .< / span > < span class = "n" > util< / span > < span class = "o" > .< / span > < span class = "n" > spec_from_file_location< / span > < span class = "p" > (< / span >
< span class = "gp" > ... < / span > < span class = "s1" > ' utils.standalone_searx' < / span > < span class = "p" > ,< / span > < span class = "s1" > ' utils/standalone_searx.py' < / span > < span class = "p" > )< / span >
< span class = "gp" > ... < / span > < span class = "n" > sas< / span > < span class = "o" > =< / span > < span class = "n" > importlib< / span > < span class = "o" > .< / span > < span class = "n" > util< / span > < span class = "o" > .< / span > < span class = "n" > module_from_spec< / span > < span class = "p" > (< / span > < span class = "n" > spec< / span > < span class = "p" > )< / span >
< span class = "gp" > ... < / span > < span class = "n" > spec< / span > < span class = "o" > .< / span > < span class = "n" > loader< / span > < span class = "o" > .< / span > < span class = "n" > exec_module< / span > < span class = "p" > (< / span > < span class = "n" > sas< / span > < span class = "p" > )< / span >
< span class = "gp" > ... < / span > < span class = "c1" > # use function from module< / span >
< span class = "gp" > ... < / span > < span class = "n" > prog_args< / span > < span class = "o" > =< / span > < span class = "n" > sas< / span > < span class = "o" > .< / span > < span class = "n" > parse_argument< / span > < span class = "p" > ([< / span > < span class = "n" > search_query< / span > < span class = "p" > ],< / span > < span class = "n" > category_choices< / span > < span class = "o" > =< / span > < span class = "n" > engine_cs< / span > < span class = "p" > )< / span >
< span class = "gp" > ... < / span > < span class = "n" > search_q< / span > < span class = "o" > =< / span > < span class = "n" > sas< / span > < span class = "o" > .< / span > < span class = "n" > get_search_query< / span > < span class = "p" > (< / span > < span class = "n" > prog_args< / span > < span class = "p" > ,< / span > < span class = "n" > engine_categories< / span > < span class = "o" > =< / span > < span class = "n" > engine_cs< / span > < span class = "p" > )< / span >
< span class = "gp" > ... < / span > < span class = "n" > res_dict< / span > < span class = "o" > =< / span > < span class = "n" > sas< / span > < span class = "o" > .< / span > < span class = "n" > to_dict< / span > < span class = "p" > (< / span > < span class = "n" > search_q< / span > < span class = "p" > )< / span >
< span class = "gp" > ... < / span > < span class = "n" > sys< / span > < span class = "o" > .< / span > < span class = "n" > stdout< / span > < span class = "o" > .< / span > < span class = "n" > write< / span > < span class = "p" > (< / span > < span class = "n" > json< / span > < span class = "o" > .< / span > < span class = "n" > dumps< / span > < span class = "p" > (< / span >
< span class = "gp" > ... < / span > < span class = "n" > res_dict< / span > < span class = "p" > ,< / span > < span class = "n" > sort_keys< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > ,< / span > < span class = "n" > indent< / span > < span class = "o" > =< / span > < span class = "mi" > 4< / span > < span class = "p" > ,< / span > < span class = "n" > ensure_ascii< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span > < span class = "p" > ,< / span >
< span class = "gp" > ... < / span > < span class = "n" > default< / span > < span class = "o" > =< / span > < span class = "n" > sas< / span > < span class = "o" > .< / span > < span class = "n" > json_serial< / span > < span class = "p" > ))< / span >
< span class = "go" > {< / span >
< span class = "go" > " answers" : [],< / span >
< span class = "go" > " infoboxes" : [ {...} ],< / span >
< span class = "go" > " paging" : true,< / span >
< span class = "go" > " results" : [... ],< / span >
< span class = "go" > " results_number" : 820000000.0,< / span >
< span class = "go" > " search" : {< / span >
< span class = "go" > " lang" : " all" ,< / span >
< span class = "go" > " pageno" : 1,< / span >
< span class = "go" > " q" : " rain" ,< / span >
< span class = "go" > " safesearch" : 0,< / span >
< span class = "go" > " timerange" : null< / span >
< span class = "go" > },< / span >
< span class = "go" > " suggestions" : [...]< / span >
< span class = "go" > }< / span >
< / pre > < / div >
< / div >
< dl class = "py function" >
< dt id = "standalone_searx.get_search_query" >
2021-01-13 15:49:52 +01:00
< code class = "sig-prename descclassname" > standalone_searx.< / code > < code class = "sig-name descname" > get_search_query< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > args< / span > < span class = "p" > :< / span > < span class = "n" > < a class = "reference external" href = "https://docs.python.org/3/library/argparse.html#argparse.Namespace" title = "(in Python v3.9)" > argparse.Namespace< / a > < / span > < / em > , < em class = "sig-param" > < span class = "n" > engine_categories< / span > < span class = "p" > :< / span > < span class = "n" > Optional< span class = "p" > [< / span > List< span class = "p" > [< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.9)" > str< / a > < span class = "p" > ]< / span > < span class = "p" > ]< / span > < / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > < span class = "sig-paren" > )< / span > → searx.search.models.SearchQuery< a class = "reference internal" href = "../_modules/standalone_searx.html#get_search_query" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#standalone_searx.get_search_query" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-11-04 14:12:59 +01:00
< dd > < p > Get search results for the query< / p >
< / dd > < / dl >
< dl class = "py function" >
< dt id = "standalone_searx.json_serial" >
< code class = "sig-prename descclassname" > standalone_searx.< / code > < code class = "sig-name descname" > json_serial< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > obj< / span > < span class = "p" > :< / span > < span class = "n" > Any< / span > < / em > < span class = "sig-paren" > )< / span > → Any< a class = "reference internal" href = "../_modules/standalone_searx.html#json_serial" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#standalone_searx.json_serial" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > JSON serializer for objects not serializable by default json code.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Raises< / dt >
< dd class = "field-odd" > < p > < a class = "reference external" href = "https://docs.python.org/3/library/exceptions.html#TypeError" title = "(in Python v3.9)" > < strong > TypeError< / strong > < / a > – < strong > obj< / strong > is not serializable< / p >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py function" >
< dt id = "standalone_searx.no_parsed_url" >
< code class = "sig-prename descclassname" > standalone_searx.< / code > < code class = "sig-name descname" > no_parsed_url< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > results< / span > < span class = "p" > :< / span > < span class = "n" > List< span class = "p" > [< / span > Dict< span class = "p" > [< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.9)" > str< / a > < span class = "p" > , < / span > Any< span class = "p" > ]< / span > < span class = "p" > ]< / span > < / span > < / em > < span class = "sig-paren" > )< / span > → List< span class = "p" > [< / span > Dict< span class = "p" > [< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.9)" > str< / a > < span class = "p" > , < / span > Any< span class = "p" > ]< / span > < span class = "p" > ]< / span > < a class = "reference internal" href = "../_modules/standalone_searx.html#no_parsed_url" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#standalone_searx.no_parsed_url" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Remove parsed url from dict.< / p >
< / dd > < / dl >
< dl class = "py function" >
< dt id = "standalone_searx.parse_argument" >
< code class = "sig-prename descclassname" > standalone_searx.< / code > < code class = "sig-name descname" > parse_argument< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > args< / span > < span class = "p" > :< / span > < span class = "n" > Optional< span class = "p" > [< / span > List< span class = "p" > [< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.9)" > str< / a > < span class = "p" > ]< / span > < span class = "p" > ]< / span > < / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > , < em class = "sig-param" > < span class = "n" > category_choices< / span > < span class = "p" > :< / span > < span class = "n" > Optional< span class = "p" > [< / span > List< span class = "p" > [< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.9)" > str< / a > < span class = "p" > ]< / span > < span class = "p" > ]< / span > < / span > < span class = "o" > =< / span > < span class = "default_value" > None< / span > < / em > < span class = "sig-paren" > )< / span > → < a class = "reference external" href = "https://docs.python.org/3/library/argparse.html#argparse.Namespace" title = "(in Python v3.9)" > argparse.Namespace< / a > < a class = "reference internal" href = "../_modules/standalone_searx.html#parse_argument" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#standalone_searx.parse_argument" title = "Permalink to this definition" > ¶< / a > < / dt >
< dd > < p > Parse command line.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Raises< / dt >
< dd class = "field-odd" > < p > < a class = "reference external" href = "https://docs.python.org/3/library/exceptions.html#SystemExit" title = "(in Python v3.9)" > < strong > SystemExit< / strong > < / a > – < cite > args< / cite > < / p >
< / dd >
< / dl >
< p > Examples:< / p >
< div class = "doctest highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "kn" > import< / span > < span class = "nn" > importlib< / span >
< span class = "gp" > ... < / span > < span class = "c1" > # load module< / span >
< span class = "gp" > ... < / span > < span class = "n" > spec< / span > < span class = "o" > =< / span > < span class = "n" > importlib< / span > < span class = "o" > .< / span > < span class = "n" > util< / span > < span class = "o" > .< / span > < span class = "n" > spec_from_file_location< / span > < span class = "p" > (< / span >
< span class = "gp" > ... < / span > < span class = "s1" > ' utils.standalone_searx' < / span > < span class = "p" > ,< / span > < span class = "s1" > ' utils/standalone_searx.py' < / span > < span class = "p" > )< / span >
< span class = "gp" > ... < / span > < span class = "n" > sas< / span > < span class = "o" > =< / span > < span class = "n" > importlib< / span > < span class = "o" > .< / span > < span class = "n" > util< / span > < span class = "o" > .< / span > < span class = "n" > module_from_spec< / span > < span class = "p" > (< / span > < span class = "n" > spec< / span > < span class = "p" > )< / span >
< span class = "gp" > ... < / span > < span class = "n" > spec< / span > < span class = "o" > .< / span > < span class = "n" > loader< / span > < span class = "o" > .< / span > < span class = "n" > exec_module< / span > < span class = "p" > (< / span > < span class = "n" > sas< / span > < span class = "p" > )< / span >
< span class = "gp" > ... < / span > < span class = "n" > sas< / span > < span class = "o" > .< / span > < span class = "n" > parse_argument< / span > < span class = "p" > ()< / span >
< span class = "go" > usage: ptipython [-h] [--category [{general}]] [--lang [LANG]] [--pageno [PAGENO]] [--safesearch [{0,1,2}]] [--timerange [{day,week,month,year}]]< / span >
< span class = "go" > query< / span >
< span class = "go" > SystemExit: 2< / span >
< span class = "gp" > > > > < / span > < span class = "n" > sas< / span > < span class = "o" > .< / span > < span class = "n" > parse_argument< / span > < span class = "p" > ([< / span > < span class = "s1" > ' rain' < / span > < span class = "p" > ])< / span >
< span class = "go" > Namespace(category=' general' , lang=' all' , pageno=1, query=' rain' , safesearch=' 0' , timerange=None)< / span >
< / pre > < / div >
< / div >
< / dd > < / dl >
< dl class = "py function" >
< dt id = "standalone_searx.to_dict" >
2021-01-13 15:49:52 +01:00
< code class = "sig-prename descclassname" > standalone_searx.< / code > < code class = "sig-name descname" > to_dict< / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > search_query< / span > < span class = "p" > :< / span > < span class = "n" > searx.search.models.SearchQuery< / span > < / em > < span class = "sig-paren" > )< / span > → Dict< span class = "p" > [< / span > < a class = "reference external" href = "https://docs.python.org/3/library/stdtypes.html#str" title = "(in Python v3.9)" > str< / a > < span class = "p" > , < / span > Any< span class = "p" > ]< / span > < a class = "reference internal" href = "../_modules/standalone_searx.html#to_dict" > < span class = "viewcode-link" > [source]< / span > < / a > < a class = "headerlink" href = "#standalone_searx.to_dict" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-11-04 14:12:59 +01:00
< dd > < p > Get result from parsed arguments.< / p >
< / dd > < / dl >
< / div >
< div class = "clearer" > < / div >
< / div >
< / div >
< / div >
< span id = "sidebar-top" > < / span >
< div class = "sphinxsidebar" role = "navigation" aria-label = "main navigation" >
< div class = "sphinxsidebarwrapper" >
< p class = "logo" > < a href = "../index.html" >
< img class = "logo" src = "../_static/searx_logo_small.png" alt = "Logo" / >
< / a > < / p >
< h3 > Project Links< / h3 >
< ul >
< li > < a href = "https://github.com/searx/searx" > Source< / a >
< li > < a href = "https://github.com/searx/searx/wiki" > Wiki< / a >
2021-01-12 10:55:12 +01:00
< li > < a href = "https://searx.space" > Public instances< / a >
2020-11-04 14:12:59 +01:00
< li > < a href = "https://twitter.com/Searx_engine" > Twitter< / a >
2021-01-12 10:55:12 +01:00
< li > < a href = "https://github.com/searx/searx/issues" > Issue Tracker< / a >
2020-11-04 14:12:59 +01:00
< / ul > < h3 > Navigation< / h3 >
< ul >
< li > < a href = "../index.html" > Overview< / a >
< ul >
< li > < a href = "index.html" > Tooling box < code class = "docutils literal notranslate" > < span class = "pre" > utils/*< / span > < / code > < / a >
< ul >
< li > Previous: < a href = "lxc.sh.html" title = "previous chapter" > < code class = "docutils literal notranslate" > < span class = "pre" > utils/lxc.sh< / span > < / code > < / a >
< li > Next: < a href = "../blog/index.html" title = "next chapter" > Blog< / a > < / ul >
< / li >
< / ul >
< / li >
< / ul >
< div id = "searchbox" style = "display: none" role = "search" >
< h3 id = "searchlabel" > Quick search< / h3 >
< div class = "searchformwrapper" >
< form class = "search" action = "../search.html" method = "get" >
< input type = "text" name = "q" aria-labelledby = "searchlabel" / >
< input type = "submit" value = "Go" / >
< / form >
< / div >
< / div >
< script > $ ( '#searchbox' ) . show ( 0 ) ; < / script >
< / div >
< / div >
< div class = "clearer" > < / div >
< / div >
< div class = "footer" role = "contentinfo" >
© Copyright 2015-2020, Adam Tauber, Noémi Ványi.
2021-01-05 16:45:49 +01:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.4.1.
2020-11-04 14:12:59 +01:00
< / div >
< script src = "../_static/version_warning_offset.js" > < / script >
< / body >
< / html >
