Closed jules-ch closed 1 year ago
I saw missing modules & function in the documentation like QueryAPiAsync https://influxdb-client.readthedocs.io/en/latest/api_async.html#queryapiasync
QueryAPiAsync
After looking at readthedocs logs, it appears we have missing dependencies to build those classes with autodoc.
Namely aiohttp, pandas.
aiohttp
pandas
I'll submit a PR, I think it would be wise to also, upgrade sphinx & use readthedocs V2 configuration to stay up to date.
https://docs.readthedocs.io/en/stable/config-file/v2.html
Running Sphinx v1.8.6 loading translations [en]... done making output directory... loading intersphinx inventory from https://docs.python.org/3/objects.inv... loading intersphinx inventory from https://pandas.pydata.org/pandas-docs/stable/objects.inv... building [mo]: targets for 0 po files that are out of date building [html]: targets for 6 source files that are out of date updating environment: 6 added, 0 changed, 0 removed reading sources... [ 16%] api reading sources... [ 33%] api_async reading sources... [ 50%] development reading sources... [ 66%] index reading sources... [ 83%] migration reading sources... [100%] usage /home/docs/checkouts/readthedocs.org/user_builds/influxdb-client/envs/latest/lib/python3.7/site-packages/sphinx/util/nodes.py:94: FutureWarning: The iterable returned by Node.traverse() will become an iterator instead of a list in Docutils > 0.16. for classifier in reversed(node.parent.traverse(nodes.classifier)): /home/docs/checkouts/readthedocs.org/user_builds/influxdb-client/envs/latest/lib/python3.7/site-packages/sphinx/util/nodes.py:94: FutureWarning: The iterable returned by Node.traverse() will become an iterator instead of a list in Docutils > 0.16. for classifier in reversed(node.parent.traverse(nodes.classifier)): /home/docs/checkouts/readthedocs.org/user_builds/influxdb-client/envs/latest/lib/python3.7/site-packages/influxdb_client/client/write/point.py:docstring of influxdb_client.client.write.point.Point.from_dict:69: WARNING: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/influxdb-client/envs/latest/lib/python3.7/site-packages/influxdb_client/client/write/point.py:docstring of influxdb_client.client.write.point.Point.from_dict:72: WARNING: Block quote ends without a blank line; unexpected unindent. WARNING: autodoc: failed to import class 'date_utils_pandas.PandasDateTimeHelper' from module 'influxdb_client.client.util'; the following exception was raised: `query_data_frame` requires Pandas which couldn't be imported due: No module named 'pandas' WARNING: autodoc: failed to import class 'influxdb_client_async.InfluxDBClientAsync' from module 'influxdb_client.client'; the following exception was raised: No module named 'aiohttp' WARNING: autodoc: failed to import class 'query_api_async.QueryApiAsync' from module 'influxdb_client.client'; the following exception was raised: No module named 'aiohttp' ../README.rst:208: WARNING: Error in "code-block" directive: 1 argument(s) required, 0 supplied. .. code-block:: [influx2] url=http://localhost:8086 org=my-org token=my-token timeout=6000 verify_ssl=False ../README.rst:278: WARNING: Error in "code-block" directive: 1 argument(s) required, 0 supplied. .. code-block:: =============== Profiler: query =============== from(bucket: stringParam) |> range(start: -5m, stop: now()) |> filter(fn: (r) => r._measurement == "mem") |> filter(fn: (r) => r._field == "available" or r._field == "free" or r._field == "used") |> aggregateWindow(every: 1m, fn: mean) |> pivot(rowKey:["_time"], columnKey: ["_field"], valueColumn: "_value") ======================== Profiler: profiler/query ======================== result : _profiler table : 0 _measurement : profiler/query TotalDuration : 8924700 CompileDuration : 350900 QueueDuration : 33800 PlanDuration : 0 RequeueDuration : 0 ExecuteDuration : 8486500 Concurrency : 0 MaxAllocated : 2072 TotalAllocated : 0 flux/query-plan : digraph { ReadWindowAggregateByTime11 // every = 1m, aggregates = [mean], createEmpty = true, timeColumn = "_stop" pivot8 generated_yield ReadWindowAggregateByTime11 -> pivot8 pivot8 -> generated_yield } influxdb/scanned-bytes: 0 influxdb/scanned-values: 0 =========================== Profiler: profiler/operator =========================== result : _profiler table : 1 _measurement : profiler/operator Type : *universe.pivotTransformation Label : pivot8 Count : 3 MinDuration : 32600 MaxDuration : 126200 DurationSum : 193400 MeanDuration : 64466.666666666664 =========================== Profiler: profiler/operator =========================== result : _profiler table : 1 _measurement : profiler/operator Type : *influxdb.readWindowAggregateSource Label : ReadWindowAggregateByTime11 Count : 1 MinDuration : 940500 MaxDuration : 940500 DurationSum : 940500 MeanDuration : 940500.0 ../README.rst:374: WARNING: Error in "code-block" directive: 1 argument(s) required, 0 supplied. .. code-block:: Custom processing of profiler result: {'result': '_profiler', 'table': 0, '_measurement': 'profiler/query', 'TotalDuration': 18843792, 'CompileDuration': 1078666, 'QueueDuration': 93375, 'PlanDuration': 0, 'RequeueDuration': 0, 'ExecuteDuration': 17371000, 'Concurrency': 0, 'MaxAllocated': 448, 'TotalAllocated': 0, 'RuntimeErrors': None, 'flux/query-plan': 'digraph {\r\n ReadRange2\r\n generated_yield\r\n\r\n ReadRange2 -> generated_yield\r\n}\r\n\r\n', 'influxdb/scanned-bytes': 0, 'influxdb/scanned-values': 0} Custom processing of profiler result: {'result': '_profiler', 'table': 1, '_measurement': 'profiler/operator', 'Type': '*influxdb.readFilterSource', 'Label': 'ReadRange2', 'Count': 1, 'MinDuration': 3274084, 'MaxDuration': 3274084, 'DurationSum': 3274084, 'MeanDuration': 3274084.0} ../README.rst:72: WARNING: Unknown target name: "influxdb 1.8 api compatibility". ../README.rst:74: WARNING: Unknown target name: "connect to influxdb cloud". ../README.rst:75: WARNING: Unknown target name: "how to efficiently import large dataset". ../README.rst:76: WARNING: Unknown target name: "efficiency write data from iot sensor". ../README.rst:77: WARNING: Unknown target name: "how to use jupyter + pandas + influxdb 2". ../README.rst:84: WARNING: Unknown target name: "advanced usage". ../README.rst:79: WARNING: Unknown target name: "gzip support". ../README.rst:80: WARNING: Unknown target name: "proxy configuration". ../README.rst:81: WARNING: Unknown target name: "nanosecond precision". ../README.rst:82: WARNING: Unknown target name: "delete data". ../README.rst:83: WARNING: Unknown target name: "handling errors". ../README.rst:84: WARNING: Unknown target name: "logging". ../README.rst:125: WARNING: Unknown target name: "how to use asyncio". ../README.rst:42: WARNING: duplicate label documentation, other instance in /home/docs/checkouts/readthedocs.org/user_builds/influxdb-client/checkouts/latest/docs/development.rst ../README.rst:141: WARNING: duplicate label getting started, other instance in /home/docs/checkouts/readthedocs.org/user_builds/influxdb-client/checkouts/latest/docs/development.rst ../README.rst:182: WARNING: Error in "code-block" directive: 1 argument(s) required, 0 supplied. .. code-block:: [influx2] url=http://localhost:8086 org=my-org token=my-token timeout=6000 [tags] id = 132-987-655 customer = California Miner data_center = ${env.data_center} ../README.rst:44: WARNING: Error in "code-block" directive: 1 argument(s) required, 0 supplied. .. code-block:: result table location temperature 0 _result 0 New York 24.3 1 _result 1 Prague 25.3 ../README.rst:198: WARNING: duplicate label via environment properties, other instance in /home/docs/checkouts/readthedocs.org/user_builds/influxdb-client/checkouts/latest/docs/index.rst looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 16%] api writing output... [ 33%] api_async writing output... [ 50%] development writing output... [ 66%] index writing output... [ 83%] migration writing output... [100%] usage generating indices... genindex highlighting module code... [ 4%] influxdb_client.client.bucket_api highlighting module code... [ 8%] influxdb_client.client.delete_api highlighting module code... [ 12%] influxdb_client.client.delete_api_async highlighting module code... [ 16%] influxdb_client.client.flux_table highlighting module code... [ 20%] influxdb_client.client.influxdb_client highlighting module code... [ 25%] influxdb_client.client.invokable_scripts_api highlighting module code... [ 29%] influxdb_client.client.labels_api highlighting module code... [ 33%] influxdb_client.client.organizations_api highlighting module code... [ 37%] influxdb_client.client.query_api highlighting module code... [ 41%] influxdb_client.client.tasks_api highlighting module code... [ 45%] influxdb_client.client.users_api highlighting module code... [ 50%] influxdb_client.client.util.date_utils highlighting module code... [ 54%] influxdb_client.client.util.multiprocessing_helper highlighting module code... [ 58%] influxdb_client.client.write.point highlighting module code... [ 62%] influxdb_client.client.write_api highlighting module code... [ 66%] influxdb_client.client.write_api_async highlighting module code... [ 70%] influxdb_client.domain.bucket highlighting module code... [ 75%] influxdb_client.domain.delete_predicate_request highlighting module code... [ 79%] influxdb_client.domain.organization highlighting module code... [ 83%] influxdb_client.domain.script highlighting module code... [ 87%] influxdb_client.domain.script_create_request highlighting module code... [ 91%] influxdb_client.domain.task highlighting module code... [ 95%] influxdb_client.domain.user highlighting module code... [100%] influxdb_client.domain.write_precision writing additional pages... search copying static files... done copying extra files... done dumping search index in English (code: en) ... done dumping object inventory... done build succeeded, 26 warnings. The HTML pages are in ../_readthedocs/html. Updating searchtools for Read the Docs search...
I saw missing modules & function in the documentation like
QueryAPiAsynchttps://influxdb-client.readthedocs.io/en/latest/api_async.html#queryapiasyncAfter looking at readthedocs logs, it appears we have missing dependencies to build those classes with autodoc.
Namely
aiohttp,pandas.I'll submit a PR, I think it would be wise to also, upgrade sphinx & use readthedocs V2 configuration to stay up to date.
https://docs.readthedocs.io/en/stable/config-file/v2.html