kbot-py-client 2.1.2__tar.gz → 2.1.4__tar.gz

kbot_py_client-2.1.2/README.md → kbot_py_client-2.1.4/PKG-INFO

@@ -1,3 +1,19 @@
+Metadata-Version: 2.4
+Name: kbot-py-client
+Version: 2.1.4
+Summary: Client for Konverso Kbot.
+Author: Konverso
+Author-email: Konverso <contact@konverso.ai>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Dist: requests>=2.32.5
+Requires-Python: >=3.10
+Project-URL: Homepage, https://www.konverso.ai/
+Project-URL: Source, https://github.com/konverso-ai/kbot-py-client
+Description-Content-Type: text/markdown
+
 # kbot-py-client #
 This package contains utilities which you may use to easily interact with Konverso Kbot application.
 
@@ -225,6 +241,33 @@ syncer.sync("/tmp/my_source_folder/", "1831f-XXXXXXXXXXXXXXXXXXXXXXX")
 print("Syncing is done :)")
 ````
 
+## Recording API activity
+You may attach a Recorder to a client to trace every API call it makes. This is useful for debugging or for building your own logging.
+
+### Printing each request and response
+```python
+from kbot_client import Client, Printer
+
+cli = Client("mybot.konverso.ai", api_key="xxxxxxxxxxxxxxxxxxx", recorder=Printer())
+cli.metric()
+```
+
+### Printing the equivalent curl command
+This is handy when you want to reproduce a call outside of Python, for example to share it with support or run it from a terminal.
+```python
+from kbot_client import Client, CurlPrinter
+
+cli = Client("mybot.konverso.ai", api_key="xxxxxxxxxxxxxxxxxxx", recorder=CurlPrinter())
+cli.metric()
+```
+
+You can also set or change the recorder after the client is created:
+```python
+cli.recorder = CurlPrinter()
+```
+
+If you need a different behavior, such as writing the activity to a file or a logger, subclass `Recorder` and override its `record` method.
+
 ## A command line chatbot
 We provide a sample command line chatbot, available in Sync or Async mode
 
@@ -271,3 +314,32 @@ from kbot_client import chatbot_client
 ...
 chatbot_client.run(mode="synchronous", client=cli, assistant=assistant, convert_html_to_text=True)
 ```
+
+# Development #
+
+## Running the tests
+The test suite lives in `tests/` and runs against a local fake Kbot HTTP server, so no Kbot instance is needed:
+```bash
+uv run --group test pytest
+```
+
+### Live tests
+`tests/live/` runs against a real Kbot instance. These tests are skipped unless the following environment variables are set (never commit the API key):
+
+* `KBOT_LIVE_HOST`: the Kbot host, such as `mybot.konverso.ai`
+* `KBOT_LIVE_API_KEY`: an API key allowed to create and impersonate users. The tests create (once) and impersonate the end user `kbot-py-client-tests@konverso.ai`
+* `KBOT_LIVE_FOLDER_UUID` (optional): a File Manager folder. File tests create a timestamped sub folder in it and delete it afterwards
+
+```bash
+KBOT_LIVE_HOST=mybot.konverso.ai KBOT_LIVE_API_KEY=xxxx KBOT_LIVE_FOLDER_UUID=yyyy uv run --group test pytest -m live
+```
+Use `-m "not live"` to run only the offline tests.
+
+## Linting and type checking
+The CI runs the following checks, which must pass:
+```bash
+uv run ruff check --select F,E9,B,PLE kbot_client examples
+uv run pylint --errors-only kbot_client examples tests
+uv run ty check kbot_client examples tests
+```
+`ruff.toml` selects all Ruff rules: this is the target, not yet met by the codebase (`uv run ruff check` still reports style findings).

kbot_py_client-2.1.2/PKG-INFO → kbot_py_client-2.1.4/README.md

@@ -1,23 +1,3 @@
-Metadata-Version: 2.3
-Name: kbot-py-client
-Version: 2.1.2
-Summary: Client for Konverso Kbot.
-License: MIT
-Author: Konverso
-Author-email: contact@konverso.ai
-Requires-Python: >=3.10
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: requests (>=2.27.1)
-Project-URL: Homepage, https://www.konverso.ai/
-Project-URL: Source, https://github.com/konverso-ai/kbot-py-client
-Description-Content-Type: text/markdown
-
 # kbot-py-client #
 This package contains utilities which you may use to easily interact with Konverso Kbot application.
 
@@ -245,6 +225,33 @@ syncer.sync("/tmp/my_source_folder/", "1831f-XXXXXXXXXXXXXXXXXXXXXXX")
 print("Syncing is done :)")
 ````
 
+## Recording API activity
+You may attach a Recorder to a client to trace every API call it makes. This is useful for debugging or for building your own logging.
+
+### Printing each request and response
+```python
+from kbot_client import Client, Printer
+
+cli = Client("mybot.konverso.ai", api_key="xxxxxxxxxxxxxxxxxxx", recorder=Printer())
+cli.metric()
+```
+
+### Printing the equivalent curl command
+This is handy when you want to reproduce a call outside of Python, for example to share it with support or run it from a terminal.
+```python
+from kbot_client import Client, CurlPrinter
+
+cli = Client("mybot.konverso.ai", api_key="xxxxxxxxxxxxxxxxxxx", recorder=CurlPrinter())
+cli.metric()
+```
+
+You can also set or change the recorder after the client is created:
+```python
+cli.recorder = CurlPrinter()
+```
+
+If you need a different behavior, such as writing the activity to a file or a logger, subclass `Recorder` and override its `record` method.
+
 ## A command line chatbot
 We provide a sample command line chatbot, available in Sync or Async mode
 
@@ -292,3 +299,31 @@ from kbot_client import chatbot_client
 chatbot_client.run(mode="synchronous", client=cli, assistant=assistant, convert_html_to_text=True)
 ```
 
+# Development #
+
+## Running the tests
+The test suite lives in `tests/` and runs against a local fake Kbot HTTP server, so no Kbot instance is needed:
+```bash
+uv run --group test pytest
+```
+
+### Live tests
+`tests/live/` runs against a real Kbot instance. These tests are skipped unless the following environment variables are set (never commit the API key):
+
+* `KBOT_LIVE_HOST`: the Kbot host, such as `mybot.konverso.ai`
+* `KBOT_LIVE_API_KEY`: an API key allowed to create and impersonate users. The tests create (once) and impersonate the end user `kbot-py-client-tests@konverso.ai`
+* `KBOT_LIVE_FOLDER_UUID` (optional): a File Manager folder. File tests create a timestamped sub folder in it and delete it afterwards
+
+```bash
+KBOT_LIVE_HOST=mybot.konverso.ai KBOT_LIVE_API_KEY=xxxx KBOT_LIVE_FOLDER_UUID=yyyy uv run --group test pytest -m live
+```
+Use `-m "not live"` to run only the offline tests.
+
+## Linting and type checking
+The CI runs the following checks, which must pass:
+```bash
+uv run ruff check --select F,E9,B,PLE kbot_client examples
+uv run pylint --errors-only kbot_client examples tests
+uv run ty check kbot_client examples tests
+```
+`ruff.toml` selects all Ruff rules: this is the target, not yet met by the codebase (`uv run ruff check` still reports style findings).

{kbot_py_client-2.1.2 → kbot_py_client-2.1.4}/kbot_client/__init__.py

@@ -1,2 +1,3 @@
 from .client import Client, DownKbotClient, UpKbotClient
 from .client_group import ClientGroup
+from .recorder import Recorder, Printer, CurlPrinter

{kbot_py_client-2.1.2 → kbot_py_client-2.1.4}/kbot_client/callback_chat.py

@@ -85,7 +85,7 @@ class AsyncCallbackChatClient:
 
         self._conversation_uuid = messages_json.get("id")
 
-        if display_intro:
+        if display_intro and self._callback:
             self._callback(greeting_response.json())
 
     @property
@@ -126,7 +126,8 @@ class AsyncCallbackChatClient:
            Returns a tuple of two elements: sender, messages
         """
         stop = not messages_json.get("dialog_in_progress")
-        self._callback(messages_json)
+        if self._callback:
+            self._callback(messages_json)
         return stop
 
     def send(self, question):

{kbot_py_client-2.1.2 → kbot_py_client-2.1.4}/kbot_client/chatbot_client/chat_client.py

@@ -131,7 +131,8 @@ class ChatClient(ABC):
         elif message_format == "html":
             if self._convert_html_to_text:
                 try:
-                    from bs4 import BeautifulSoup
+                    # Optional dependency, not installed by default
+                    from bs4 import BeautifulSoup  # pylint: disable=import-error  # ty: ignore[unresolved-import]
                     message_value = BeautifulSoup(message.get('value'), 'html.parser').get_text()
                 except:
                     print("ERROR: HTML to Text conversion requested, but beautifull soup is not installed. Use: ")

{kbot_py_client-2.1.2 → kbot_py_client-2.1.4}/kbot_client/chatbot_client/chat_client_2.py

@@ -146,7 +146,8 @@ class ChatClient(ABC):
         elif message_format == "html":
             if self._convert_html_to_text:
                 try:
-                    from bs4 import BeautifulSoup
+                    # Optional dependency, not installed by default
+                    from bs4 import BeautifulSoup  # pylint: disable=import-error  # ty: ignore[unresolved-import]
                     message_value = BeautifulSoup(message.get('value'), 'html.parser').get_text()
                 except:
                     print("ERROR: HTML to Text conversion requested, but beautifull soup is not installed. Use: ")

{kbot_py_client-2.1.2 → kbot_py_client-2.1.4}/kbot_client/client.py

@@ -1,6 +1,8 @@
 """Dialog tester"""
 import json
 import time
+from collections.abc import Callable
+from typing import TYPE_CHECKING
 
 import requests
 
@@ -8,7 +10,7 @@ import requests
 class Client:
     """Base representation of Kbot instance"""
 
-    def __init__(self, server, port=443, proto='https', api_key=None, verify=True):
+    def __init__(self, server, port=443, proto='https', api_key=None, verify=True, recorder=None):
         """
 
 
@@ -18,10 +20,12 @@ class Client:
             - proto: HTTP or HTTPS
             - api_key: A Kbot valid API Key. If provided all requests will be sent with this API Key
                        and it is not required to invoke the login method
+            - recorder: an optional Recorder instance used to trace every API call made by this client
         """
 
         self.host = server
         self.verify = verify
+        self.recorder = recorder
 
         # A version, in the formation "YEAR-V", such as 2024.02
         self.version = None
@@ -177,6 +181,12 @@ class Client:
         endpoint.__name__ = name
         setattr(self, name, endpoint)
 
+    if TYPE_CHECKING:
+        # Endpoint methods (metric, get_dashboard, ...) are added at runtime from
+        # the server schema: tell static checkers that they exist. This is
+        # not defined at runtime, so unknown attributes still raise AttributeError.
+        def __getattr__(self, name: str) -> Callable[..., requests.Response]: ...
+
     def __refresh(self):
         r = requests.post(self.url + "/api/refresh",
                           data=json.dumps({"refresh_token": self.__refresh_token}),
@@ -184,7 +194,7 @@ class Client:
         r.raise_for_status()
         self.__reset_headers(r.json())
 
-    def __request(self, method: str, uri : str = None, data: dict = None, params: dict = None, files: dict = None, attempt=0,  timeout=None):
+    def __request(self, method: str, uri: str | None = None, data: dict | None = None, params: dict | None = None, files: dict | None = None, attempt=0,  timeout=None):
         if files:
             # For file upload, the data must be a dictionnary
             dump_data = data
@@ -198,9 +208,18 @@ class Client:
         else:
             headers = self._headers
 
+        # requests reads upload files to their end: remember where they start so
+        # that a replay after a token refresh sends the same content.
+        file_positions = [(fileobj, fileobj.tell()) for fileobj in _file_objects(files)]
+
         r = requests.request(method.upper(), self.url + '/api/%s/' % (
             uri), params=params, data=dump_data, headers=headers, files=files, verify=self.verify, timeout=timeout)
 
+        if self.recorder:
+            # Give the recorder a snapshot: the client headers change on token
+            # refresh, and a recorder must not be able to alter them.
+            self.recorder.record(method, r.url, headers=dict(headers), data=data, files=files, response=r)
+
         if r.status_code == 401:
             # Refresh the token
             try:
@@ -214,20 +233,22 @@ class Client:
                 time.sleep(3)
 
             # Re-invoke the request
-            r = self.__request(method, uri=uri, data=data, params=params, attempt=attempt+1)
+            for fileobj, position in file_positions:
+                fileobj.seek(position)
+            r = self.__request(method, uri=uri, data=data, params=params, files=files, attempt=attempt+1, timeout=timeout)
 
         return r
 
-    def request(self, method: str, uri: str, data: dict = None, params: dict = None, files: dict = None, timeout=None):
+    def request(self, method: str, uri: str, data: dict | None = None, params: dict | None = None, files: dict | None = None, timeout=None):
         return self.__request(method, uri=uri, data=data, params=params, files=files, timeout=timeout)
 
-    def unit(self, name: str, params=None, timeout=None) -> dict:
+    def unit(self, name: str, params=None, timeout=None) -> dict | None:
         r = self.get(name, params, timeout=timeout)
         if r:
             return r.json()
         return None
 
-    def message(self, cid: int, message: str, timeout: int=60) -> list:
+    def message(self, cid: int, message: str, timeout: float = 60) -> list:
         response = []
 
         data = {'type': 'message', 'message': message}
@@ -264,7 +285,7 @@ class Client:
             #     self._process('logout', 1)
 
             # Logout from the APIs
-            self.request("post", self.url + '/api/logout', timeout=timeout)
+            requests.post(self.url + '/api/logout', headers=self._headers, verify=self.verify, timeout=timeout)
 
     #
     # In addition to the Generated and built in API methods, we have the classic base REST methods
@@ -298,6 +319,16 @@ class Client:
         """
         return self.__request("post", unit, params=params, data=data, files=files, timeout=timeout)
 
+
+def _file_objects(files: dict | None = None):
+    """Yields the seekable file objects of a requests `files` mapping, whose values
+    are either a file object or a (filename, file object, ...) tuple"""
+    for value in (files or {}).values():
+        fileobj = value[1] if isinstance(value, (tuple, list)) else value
+        if hasattr(fileobj, "seek") and hasattr(fileobj, "tell"):
+            yield fileobj
+
+
 class UpKbotClient(Client):
     """Represents a currently reachable Kbot instance"""
 

kbot_py_client-2.1.4/kbot_client/recorder.py

@@ -0,0 +1,69 @@
+"""Recorders used to trace the API activity of a Client"""
+import json
+import shlex
+
+
+class Recorder:
+    """Base class for recording the API calls made by a Client.
+
+    Subclasses should override `record`, which is invoked once per HTTP
+    call performed by `Client.__request`, after the response has been
+    received.
+    """
+
+    def record(self, method: str, url: str, headers: dict | None = None, data=None, files: dict | None = None, response=None):
+        """Called after each API request is made.
+
+        Arguments:
+            - method: the HTTP method, such as "GET" or "POST"
+            - url: the full URL that was called, including query string
+            - headers: the headers sent with the request
+            - data: the request payload, as passed to the client (before serialization)
+            - files: the files sent with the request, if any
+            - response: the requests.Response object returned by the call
+        """
+        raise NotImplementedError
+
+
+class Printer(Recorder):
+    """Recorder that prints the URL, protocol, payload and response of each API call"""
+
+    def record(self, method: str, url: str, headers: dict | None = None, data=None, files: dict | None = None, response=None):
+        proto = url.split(':', 1)[0]
+        print("%s %s (%s)" % (method.upper(), url, proto))
+        if headers:
+            print("  headers: %s" % headers)
+        if data:
+            print("  payload: %s" % data)
+        if files:
+            print("  files: %s" % list(files.keys()))
+        if response is not None:
+            print("  -> %s %s" % (response.status_code, response.text))
+
+
+class CurlPrinter(Recorder):
+    """Recorder that prints the equivalent curl command of each API call"""
+
+    def record(self, method: str, url: str, headers: dict | None = None, data=None, files: dict | None = None, response=None):
+        print(self.to_curl(method, url, headers=headers, data=data, files=files))
+
+    @staticmethod
+    def to_curl(method: str, url: str, headers: dict | None = None, data=None, files: dict | None = None) -> str:
+        """Builds the curl command line equivalent to the given request"""
+        parts = ["curl", "-X", method.upper()]
+
+        for name, value in (headers or {}).items():
+            parts.append("-H %s" % shlex.quote("%s: %s" % (name, value)))
+
+        if files:
+            for name in files:
+                parts.append("-F %s" % shlex.quote("%s=@<file>" % name))
+            for name, value in (data or {}).items():
+                parts.append("-F %s" % shlex.quote("%s=%s" % (name, value)))
+        elif data:
+            body = data if isinstance(data, str) else json.dumps(data)
+            parts.append("-d %s" % shlex.quote(body))
+
+        parts.append(shlex.quote(url))
+
+        return " ".join(parts)

kbot_py_client-2.1.4/pyproject.toml

@@ -0,0 +1,58 @@
+[project]
+name = "kbot-py-client"
+version = "2.1.4"
+requires-python = ">=3.10"
+description = "Client for Konverso Kbot."
+readme = "README.md"
+license = "MIT"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = ["requests>=2.32.5"]
+
+[[project.authors]]
+name = "Konverso"
+email = "contact@konverso.ai"
+
+[project.urls]
+Homepage = "https://www.konverso.ai/"
+Source = "https://github.com/konverso-ai/kbot-py-client"
+
+[build-system]
+requires = ["uv_build>=0.9.4,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "kbot_client"
+module-root = ""
+
+[tool.deptry]
+extend_exclude = ["(^|.*/)tests/"]
+known_first_party = ["kbot_client"]
+
+[dependency-groups]
+deps = ["deptry"]
+lint = [
+    "pylint",
+    "ruff",
+]
+test = [
+    "pytest",
+    "pytest-asyncio",
+    "pytest-cov",
+]
+typecheck = ["ty"]
+
+[[dependency-groups.dev]]
+include-group = "deps"
+
+[[dependency-groups.dev]]
+include-group = "lint"
+
+[[dependency-groups.dev]]
+include-group = "typecheck"
+
+[[dependency-groups.dev]]
+include-group = "test"

kbot_py_client-2.1.4/pyproject.toml.orig

@@ -0,0 +1,64 @@
+[project]
+name = "kbot-py-client"
+version = "2.1.4"
+requires-python = ">=3.10"
+description = "Client for Konverso Kbot."
+readme = "README.md"
+license = "MIT"
+authors = [
+    { name = "Konverso", email = "contact@konverso.ai" }
+]
+classifiers=[
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "requests>=2.32.5",
+]
+
+[project.urls]
+Homepage = "https://www.konverso.ai/"
+Source = "https://github.com/konverso-ai/kbot-py-client"
+
+[build-system]
+requires = ["uv_build>=0.9.4,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "kbot_client"
+module-root = ""
+
+[tool.deptry]
+# The default "tests" exclude only matches a top-level tests/ folder (re.match
+# anchors at the start), so nested test dirs like core/.../tests/ are missed,
+# making deptry flag pytest (a dev dependency) as used in "non-dev" code.
+extend_exclude = [
+    "(^|.*/)tests/",
+]
+known_first_party = [
+    "kbot_client",
+]
+
+[dependency-groups]
+deps = [
+    "deptry",
+]
+lint = [
+    "pylint",
+    "ruff",
+]
+test = [
+    "pytest",
+    "pytest-asyncio",
+    "pytest-cov",
+]
+typecheck = [
+    "ty",
+]
+dev = [
+    { include-group = "deps" },
+    { include-group = "lint" },
+    { include-group = "typecheck" },
+    { include-group = "test" },
+]

kbot_py_client-2.1.2/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Konverso
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

kbot_py_client-2.1.2/kbot_client/test.py

@@ -1,26 +0,0 @@
-
-import json
-
-from kbot_client import Client
-
-# Option 1: using an API Key
-client = Client("myhost.konverso.ai", api_key="18460555-9012-4a43-bf68-fc55325b96af")
-
-# Option 2: using a user login
-client = Client("myhost.konverso.ai")
-client.login("myuser", "mypassword")
-
-metrics = client.metric()
-print("Collected metrics (%s):" % (metrics))
-print(metrics.text)
-print(json.dumps(metrics.json(), indent=4))
-
-r = client.conversation(username='bot')
-print("Post conversation (%s):" % (r))
-print(r.text)
-
-r = client.get_dashboard(1)
-print("Get dashboard (%s):" % (r))
-print(r.text)
-
-client.logout()

kbot_py_client-2.1.2/pyproject.toml

@@ -1,283 +0,0 @@
-[tool.poetry]
-name = "kbot-py-client"
-version = "2.1.2"
-description = "Client for Konverso Kbot."
-authors = ["Konverso <contact@konverso.ai>"]
-classifiers=[
-    "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: OS Independent",
-]
-readme = "README.md"
-license = "MIT"
-packages = [
-    { include = "kbot_client" },
-]
-
-[tool.poetry.urls]
-Homepage = "https://www.konverso.ai/"
-Source = "https://github.com/konverso-ai/kbot-py-client"
-
-[tool.poetry.dependencies]
-python = ">=3.10"
-requests = ">=2.27.1"
-
-[tool.poetry.group.dev.dependencies]
-pylint = "^3.3.4"
-ruff = "^0.9.4"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.pylint]
-# Master section
-extension-pkg-whitelist = []
-ignore = ["CVS", ".git", ".ruff_cache", ".venv"]
-ignore-patterns = []
-jobs = 1
-load-plugins = ["pylint.extensions.no_self_use"]
-persistent = true
-unsafe-load-any-extension = false
-
-[tool.pylint.messages_control]
-confidence = []
-disable = [
-    "invalid-name",
-    "fixme",
-    "too-many-arguments",
-    "too-many-locals",
-    "too-many-branches",
-    "bare-except",
-    "broad-except",
-    "no-self-use",
-    "too-few-public-methods",
-    "too-many-public-methods",
-    "too-many-instance-attributes",
-    "too-many-nested-blocks",
-    "too-many-statements",
-    "too-many-return-statements",
-    "unused-argument",
-    "too-many-ancestors",
-    "wildcard-import",
-    "abstract-method",
-    "missing-docstring"
-]
-enable = []
-
-[tool.pylint.reports]
-evaluation = "10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)"
-msg-template = "{path}:{module}:{line}: [{msg_id}({symbol}), {obj}] {msg}"
-output-format = "colorized"
-reports = true
-score = true
-
-[tool.pylint.refactoring]
-max-nested-blocks = 5
-
-[tool.pylint.basic]
-argument-rgx = "(([a-z][A-Za-z0-9_]{2,30})|(_[a-z0-9_]*))$"
-attr-rgx = "(([a-z][A-Za-z0-9_]{2,30})|(_[a-z0-9_]*))$"
-bad-names = ["foo", "bar", "baz", "toto", "tutu", "tata"]
-class-attribute-rgx = "([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$"
-class-rgx = "[A-Z_][a-zA-Z0-9]+$"
-const-rgx = "(([A-Za-z_][A-Za-z0-9_]*)|(__.*__))$"
-docstring-min-length = -1
-function-rgx = "(([a-zA-Z][A-Za-z0-9_]{2,30})|(_[a-zA-Z0-9_]*))$"
-good-names = ["i", "j", "k", "ex", "Run", "_"]
-include-naming-hint = false
-inlinevar-rgx = "[A-Za-z_][A-Za-z0-9_]*$"
-method-rgx = "(([a-zA-Z][a-zA-Z0-9_]{2,40})|(_[a-zA-Z0-9_]*))$"
-module-rgx = "(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$"
-name-group = []
-no-docstring-rgx = "^_"
-property-classes = ["abc.abstractproperty"]
-variable-rgx = "(([a-z][A-Za-z0-9_]{0,30})|(_[a-z0-9_]*))$"
-
-[tool.pylint.format]
-expected-line-ending-format = "LF"
-ignore-long-lines = "^\\s*(# )?<?https?://\\S+>?$"
-indent-after-paren = 4
-indent-string = "    "
-max-line-length = 120
-max-module-lines = 1000
-single-line-class-stmt = false
-single-line-if-stmt = false
-
-[tool.pylint.spelling]
-spelling-dict = ""
-spelling-ignore-words = []
-spelling-private-dict-file = ""
-spelling-store-unknown-words = false
-
-[tool.pylint.miscellaneous]
-notes = ["FIXME", "XXX", "TODO"]
-
-[tool.pylint.similarities]
-ignore-comments = true
-ignore-docstrings = true
-ignore-imports = false
-min-similarity-lines = 4
-
-[tool.pylint.variables]
-additional-builtins = []
-allow-global-unused-variables = true
-callbacks = ["cb_", "_cb"]
-dummy-variables-rgx = "_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy"
-ignored-argument-names = "_.*"
-init-import = false
-redefining-builtins-modules = ["six.moves", "future.builtins"]
-
-[tool.pylint.typecheck]
-contextmanager-decorators = ["contextlib.contextmanager"]
-generated-members = []
-ignore-mixin-members = true
-ignored-classes = ["optparse.Values", "thread._local", "_thread._local"]
-ignored-modules = []
-missing-member-hint = true
-missing-member-hint-distance = 1
-missing-member-max-choices = 1
-
-[tool.pylint.logging]
-logging-modules = ["logging"]
-
-[tool.pylint.imports]
-allow-wildcard-with-all = false
-analyse-fallback-blocks = false
-deprecated-modules = ["optparse", "tkinter.tix"]
-ext-import-graph = ""
-import-graph = ""
-int-import-graph = ""
-known-standard-library = []
-known-third-party = ["enchant"]
-
-[tool.pylint.design]
-max-args = 5
-max-attributes = 7
-max-bool-expr = 5
-max-branches = 12
-max-locals = 15
-max-parents = 7
-max-public-methods = 20
-max-returns = 6
-max-statements = 50
-min-public-methods = 2
-
-[tool.pylint.classes]
-defining-attr-methods = ["__init__", "__new__", "setUp"]
-exclude-protected = ["_asdict", "_fields", "_replace", "_source", "_make"]
-valid-classmethod-first-arg = ["cls"]
-valid-metaclass-classmethod-first-arg = ["mcs"]
-
-[tool.pylint.exceptions]
-overgeneral-exceptions = ["builtins.Exception"]
-
-[tool.pylint.'MASTER']
-ignore-patterns = "test*.py"
-
-
-[tool.pytest]
-testpaths = "tests"
-addopts = "-vv"
-python_files = "test_*.py"
-
-[tool.pytest.ini_options]
-asyncio_mode = "auto"
-
-[tool.ruff]
-# Exclude a variety of commonly ignored directories.
-exclude = [
-    ".bzr",
-    ".direnv",
-    ".eggs",
-    ".git",
-    ".git-rewrite",
-    ".hg",
-    ".ipynb_checkpoints",
-    ".mypy_cache",
-    ".nox",
-    ".pants.d",
-    ".pyenv",
-    ".pytest_cache",
-    ".pytype",
-    ".ruff_cache",
-    ".svn",
-    ".tox",
-    ".venv",
-    ".vscode",
-    "__pypackages__",
-    "_build",
-    "buck-out",
-    "build",
-    "dist",
-    "node_modules",
-    "site-packages",
-    "venv",
-]
-
-line-length = 120
-indent-width = 4
-
-# Assume Python 3.12
-target-version = "py312"
-
-output-format = "grouped"
-
-[tool.ruff.lint]
-# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
-# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
-# McCabe complexity (`C901`) by default.
-select = ["ALL"]
-ignore = [
-    "D100",
-    "D106",
-    "D203",
-    "D213",
-    "ARG002",
-    "ANN002",
-    "ANN003",
-    "S101",
-    "FBT001",
-    "FBT002",
-]
-
-# Allow fix for all enabled rules (when `--fix`) is provided.
-fixable = ["ALL"]
-unfixable = []
-
-# Allow unused variables when underscore-prefixed.
-# dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
-
-[tool.ruff.lint.extend-per-file-ignores]
-# Also ignore `E402` in all `__init__.py` files.
-"__init__.py" = ["D104", "E402", "F401"]
-
-[tool.ruff.format]
-# Like Black, use double quotes for strings.
-quote-style = "double"
-
-# Like Black, indent with spaces, rather than tabs.
-indent-style = "space"
-
-# Like Black, respect magic trailing commas.
-skip-magic-trailing-comma = false
-
-# Like Black, automatically detect the appropriate line ending.
-line-ending = "auto"
-
-# Enable auto-formatting of code examples in docstrings. Markdown,
-# reStructuredText code/literal blocks and doctests are all supported.
-#
-# This is currently disabled by default, but it is planned for this
-# to be opt-out in the future.
-docstring-code-format = false
-
-# Set the line length limit used when formatting code snippets in
-# docstrings.
-#
-# This only has an effect when the `docstring-code-format` setting is
-# enabled.
-docstring-code-line-length = "dynamic"
-
-[tool.ruff.lint.isort]
-known-first-party = ["kbot_client"]