docs: adds code documentation to key public methods

Author: karel-rehor

influxdb_client_3/__init__.py

@@ -279,6 +279,23 @@ def query(self, query: str, language: str = "sql", mode: str = "all", database:
             raise e
 
     async def query_async(self, query: str, language: str = "sql", mode: str = "all", database: str = None, **kwargs):
+        """Query data from InfluxDB asynchronously.
+
+        If you want to use query parameters, you can pass them as kwargs:
+
+        >>> await client.query_async("select * from cpu where host=$host", query_parameters={"host": "server01"})
+
+        :param query: The query to execute on the database.
+        :param language: The query language to use. It should be one of "influxql" or "sql". Defaults to "sql".
+        :param mode: The mode to use for the query. It should be one of "all", "pandas", "polars", "chunk",
+                     "reader" or "schema". Defaults to "all".
+        :param database: The database to query from. If not provided, uses the database provided during initialization.
+        :param kwargs: Additional arguments to pass to the ``FlightCallOptions headers``. For example, it can be used to
+                       set up per request headers.
+        :keyword query_parameters: The query parameters to use in the query.
+                                   It should be a ``dictionary`` of key-value pairs.
+        :return: The query result in the specified mode.
+        """
         if mode == "polars" and polars is False:
             raise ImportError("Polars is not installed. Please install it with `pip install polars`.")
 

influxdb_client_3/query/query_api.py

@@ -172,6 +172,21 @@ def query(self, query: str, language: str, mode: str, database: str, **kwargs):
             raise e
 
     async def query_async(self, query: str, language: str, mode: str, database: str, **kwargs):
+        """Query data from InfluxDB asynchronously.
+
+        Wraps internal FlightClient.doGet call in its own executor, so that the event_loop will not be blocked.
+
+        :param query: The query to execute on the database.
+        :param language: The query language.
+        :param mode: The mode to use for the query.
+             It should be one of "all", "pandas", "polars", "chunk", "reader" or "schema".
+        :param database: The database to query from.
+        :param kwargs: Additional arguments to pass to the ``FlightCallOptions headers``.
+               For example, it can be used to set up per request headers.
+        :keyword query_parameters: The query parameters to use in the query.
+                           It should be a ``dictionary`` of key-value pairs.
+        :return: The query result in the specified mode.
+        """
         try:
             ticket, options = self._prepare_query(query, language, database, **kwargs)
             loop = asyncio.get_running_loop()

tests/util/__init__.py

@@ -8,6 +8,22 @@
 
 
 def asyncio_run(async_func):
+    """
+    Fixture for running tests asynchronously
+
+    Example
+
+    .. sourcecode:: python
+
+    @asyncio_run
+    async def test_my_feature(self):
+        asyncio.sleep(1)
+        print("waking...")
+        ...
+
+    :param async_func:
+    :return:
+    """
     def wrapper(*args, **kwargs):
         try:
             return asyncio.run(async_func(*args, **kwargs))