From 02fc4147ce745325ff25146a8085a915a5d3cacd Mon Sep 17 00:00:00 2001 From: Alexandre Flament Date: Wed, 16 Dec 2020 16:20:03 +0100 Subject: [mod] dictzone, translated, currency_convert: use engine_type online_curency and online_dictionnary --- docs/dev/engine_overview.rst | 66 +++++++++++++++++++++++++++++++------------- 1 file changed, 47 insertions(+), 19 deletions(-) (limited to 'docs/dev/engine_overview.rst') diff --git a/docs/dev/engine_overview.rst b/docs/dev/engine_overview.rst index 12e62eb61..0d2c00e87 100644 --- a/docs/dev/engine_overview.rst +++ b/docs/dev/engine_overview.rst @@ -37,15 +37,16 @@ settings. However, the standard way is the following: engine file ----------- -======================= =========== =========================================== +======================= =========== ======================================================== argument type information -======================= =========== =========================================== +======================= =========== ======================================================== categories list pages, in which the engine is working paging boolean support multible pages language_support boolean support language choosing time_range_support boolean support search time range -engine_type str ``online`` by default, ``offline`` -======================= =========== =========================================== +engine_type str ``online`` by default, other possibles values are + ``offline``, ``online_dictionnary``, ``online_currency`` +======================= =========== ======================================================== .. _engine settings: @@ -111,22 +112,49 @@ passed arguments These arguments can be used to construct the search query. Furthermore, parameters with default value can be redefined for special purposes. +If the ``engine_type`` is ``online```: + +====================== ============== ======================================================================== +argument type default-value, information +====================== ============== ======================================================================== +url str ``''`` +method str ``'GET'`` +headers set ``{}`` +data set ``{}`` +cookies set ``{}`` +verify bool ``True`` +headers.User-Agent str a random User-Agent +category str current category, like ``'general'`` +safesearch int ``0``, between ``0`` and ``2`` (normal, moderate, strict) +time_range Optional[str] ``None``, can be ``day``, ``week``, ``month``, ``year`` +pageno int current pagenumber +language str specific language code like ``'en_US'``, or ``'all'`` if unspecified +====================== ============== ======================================================================== + + +If the ``engine_type`` is ``online_dictionnary```, in addition to the ``online`` arguments: + ====================== ============ ======================================================================== argument type default-value, information ====================== ============ ======================================================================== -url string ``''`` -method string ``'GET'`` -headers set ``{}`` -data set ``{}`` -cookies set ``{}`` -verify boolean ``True`` -headers.User-Agent string a random User-Agent -category string current category, like ``'general'`` -started datetime current date-time -pageno int current pagenumber -language string specific language code like ``'en_US'``, or ``'all'`` if unspecified +from_lang str specific language code like ``'en_US'`` +to_lang str specific language code like ``'en_US'`` +query str the text query without the languages ====================== ============ ======================================================================== +If the ``engine_type`` is ``online_currency```, in addition to the ``online`` arguments: + +====================== ============ ======================================================================== +argument type default-value, information +====================== ============ ======================================================================== +amount float the amount to convert +from str ISO 4217 code +to str ISO 4217 code +from_name str currency name +to_name str currency name +====================== ============ ======================================================================== + + parsed arguments ---------------- @@ -137,12 +165,12 @@ request: =================== =========== ========================================================================== argument type information =================== =========== ========================================================================== -url string requested url -method string HTTP request method +url str requested url +method str HTTP request method headers set HTTP header information -data set HTTP data information (parsed if ``method != 'GET'``) +data set HTTP data information cookies set HTTP cookies -verify boolean Performing SSL-Validity check +verify bool Performing SSL-Validity check max_redirects int maximum redirects, hard limit soft_max_redirects int maximum redirects, soft limit. Record an error but don't stop the engine raise_for_httperror bool True by default: raise an exception if the HTTP code of response is >= 300 -- cgit v1.2.3-54-g00ecf