style: introduce ruff as linter and formatter (#1356)

* style: remove necessary imports

* style: fix F841

* style: fix F401

* style: fix F811

* style: fix E402

* style: fix E721

* style: fix E722

* style: fix E722

* style: fix F541

* style: ruff format

* style: all passed

* style: add ruff in deps

* style: more ignores in ruff.toml

* style: add pre-commit

libs/dify_service_api/__init__.py

@@ -1,2 +1,4 @@
-from .v1 import client
-from .v1 import errors
+from .v1 import client as client
+from .v1 import errors as errors
+
+__all__ = ['client', 'errors']

libs/dify_service_api/test.py

@@ -8,25 +8,33 @@ import json
 
 class TestDifyClient:
     async def test_chat_messages(self):
-        cln = client.AsyncDifyServiceClient(api_key=os.getenv("DIFY_API_KEY"), base_url=os.getenv("DIFY_BASE_URL"))
+        cln = client.AsyncDifyServiceClient(
+            api_key=os.getenv('DIFY_API_KEY'), base_url=os.getenv('DIFY_BASE_URL')
+        )
 
-        async for chunk in cln.chat_messages(inputs={}, query="调用工具查看现在几点？", user="test"):
+        async for chunk in cln.chat_messages(
+            inputs={}, query='调用工具查看现在几点？', user='test'
+        ):
             print(json.dumps(chunk, ensure_ascii=False, indent=4))
 
     async def test_upload_file(self):
-        cln = client.AsyncDifyServiceClient(api_key=os.getenv("DIFY_API_KEY"), base_url=os.getenv("DIFY_BASE_URL"))
+        cln = client.AsyncDifyServiceClient(
+            api_key=os.getenv('DIFY_API_KEY'), base_url=os.getenv('DIFY_BASE_URL')
+        )
 
-        file_bytes = open("img.png", "rb").read()
+        file_bytes = open('img.png', 'rb').read()
 
         print(type(file_bytes))
 
-        file = ("img2.png", file_bytes, "image/png")
+        file = ('img2.png', file_bytes, 'image/png')
 
-        resp = await cln.upload_file(file=file, user="test")
+        resp = await cln.upload_file(file=file, user='test')
         print(json.dumps(resp, ensure_ascii=False, indent=4))
 
     async def test_workflow_run(self):
-        cln = client.AsyncDifyServiceClient(api_key=os.getenv("DIFY_API_KEY"), base_url=os.getenv("DIFY_BASE_URL"))
+        cln = client.AsyncDifyServiceClient(
+            api_key=os.getenv('DIFY_API_KEY'), base_url=os.getenv('DIFY_BASE_URL')
+        )
 
         # resp = await cln.workflow_run(inputs={}, user="test")
         # # print(json.dumps(resp, ensure_ascii=False, indent=4))
@@ -34,11 +42,12 @@ class TestDifyClient:
         chunks = []
 
         ignored_events = ['text_chunk']
-        async for chunk in cln.workflow_run(inputs={}, user="test"):
+        async for chunk in cln.workflow_run(inputs={}, user='test'):
             if chunk['event'] in ignored_events:
                 continue
             chunks.append(chunk)
         print(json.dumps(chunks, ensure_ascii=False, indent=4))
 
-if __name__ == "__main__":
+
+if __name__ == '__main__':
     asyncio.run(TestDifyClient().test_chat_messages())

libs/dify_service_api/v1/client.py

@@ -12,11 +12,11 @@ class AsyncDifyServiceClient:
 
     api_key: str
     base_url: str
-    
+
     def __init__(
         self,
         api_key: str,
-        base_url: str = "https://api.dify.ai/v1",
+        base_url: str = 'https://api.dify.ai/v1',
     ) -> None:
         self.api_key = api_key
         self.base_url = base_url
@@ -26,76 +26,81 @@ class AsyncDifyServiceClient:
         inputs: dict[str, typing.Any],
         query: str,
         user: str,
-        response_mode: str = "streaming",  # 当前不支持 blocking
-        conversation_id: str = "",
+        response_mode: str = 'streaming',  # 当前不支持 blocking
+        conversation_id: str = '',
         files: list[dict[str, typing.Any]] = [],
         timeout: float = 30.0,
     ) -> typing.AsyncGenerator[dict[str, typing.Any], None]:
         """发送消息"""
-        if response_mode != "streaming":
-            raise DifyAPIError("当前仅支持 streaming 模式")
-        
+        if response_mode != 'streaming':
+            raise DifyAPIError('当前仅支持 streaming 模式')
+
         async with httpx.AsyncClient(
             base_url=self.base_url,
             trust_env=True,
             timeout=timeout,
         ) as client:
             async with client.stream(
-                "POST",
-                "/chat-messages",
-                headers={"Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json"},
+                'POST',
+                '/chat-messages',
+                headers={
+                    'Authorization': f'Bearer {self.api_key}',
+                    'Content-Type': 'application/json',
+                },
                 json={
-                    "inputs": inputs,
-                    "query": query,
-                    "user": user,
-                    "response_mode": response_mode,
-                    "conversation_id": conversation_id,
-                    "files": files,
+                    'inputs': inputs,
+                    'query': query,
+                    'user': user,
+                    'response_mode': response_mode,
+                    'conversation_id': conversation_id,
+                    'files': files,
                 },
             ) as r:
                 async for chunk in r.aiter_lines():
                     if r.status_code != 200:
-                        raise DifyAPIError(f"{r.status_code} {chunk}")
-                    if chunk.strip() == "":
+                        raise DifyAPIError(f'{r.status_code} {chunk}')
+                    if chunk.strip() == '':
                         continue
-                    if chunk.startswith("data:"):
+                    if chunk.startswith('data:'):
                         yield json.loads(chunk[5:])
-        
+
     async def workflow_run(
         self,
         inputs: dict[str, typing.Any],
         user: str,
-        response_mode: str = "streaming",  # 当前不支持 blocking
+        response_mode: str = 'streaming',  # 当前不支持 blocking
         files: list[dict[str, typing.Any]] = [],
         timeout: float = 30.0,
     ) -> typing.AsyncGenerator[dict[str, typing.Any], None]:
         """运行工作流"""
-        if response_mode != "streaming":
-            raise DifyAPIError("当前仅支持 streaming 模式")
-        
+        if response_mode != 'streaming':
+            raise DifyAPIError('当前仅支持 streaming 模式')
+
         async with httpx.AsyncClient(
             base_url=self.base_url,
             trust_env=True,
             timeout=timeout,
         ) as client:
-
             async with client.stream(
-                "POST",
-                "/workflows/run",
-                headers={"Authorization": f"Bearer {self.api_key}", "Content-Type": "application/json"},
+                'POST',
+                '/workflows/run',
+                headers={
+                    'Authorization': f'Bearer {self.api_key}',
+                    'Content-Type': 'application/json',
+                },
                 json={
-                    "inputs": inputs,
-                    "user": user,
-                    "response_mode": response_mode,
-                    "files": files,
+                    'inputs': inputs,
+                    'user': user,
+                    'response_mode': response_mode,
+                    'files': files,
                 },
             ) as r:
                 async for chunk in r.aiter_lines():
                     if r.status_code != 200:
-                        raise DifyAPIError(f"{r.status_code} {chunk}")
-                    if chunk.strip() == "":
+                        raise DifyAPIError(f'{r.status_code} {chunk}')
+                    if chunk.strip() == '':
                         continue
-                    if chunk.startswith("data:"):
+                    if chunk.startswith('data:'):
                         yield json.loads(chunk[5:])
 
     async def upload_file(
@@ -112,15 +117,15 @@ class AsyncDifyServiceClient:
         ) as client:
             # multipart/form-data
             response = await client.post(
-                "/files/upload",
-                headers={"Authorization": f"Bearer {self.api_key}"},
+                '/files/upload',
+                headers={'Authorization': f'Bearer {self.api_key}'},
                 files={
-                    "file": file,
-                    "user": (None, user),
+                    'file': file,
+                    'user': (None, user),
                 },
             )
 
             if response.status_code != 201:
-                raise DifyAPIError(f"{response.status_code} {response.text}")
+                raise DifyAPIError(f'{response.status_code} {response.text}')
 
             return response.json()

libs/dify_service_api/v1/client_test.py

@@ -7,11 +7,11 @@ import os
 
 class TestDifyClient:
     async def test_chat_messages(self):
-        cln = client.DifyClient(api_key=os.getenv("DIFY_API_KEY"))
+        cln = client.DifyClient(api_key=os.getenv('DIFY_API_KEY'))
 
-        resp = await cln.chat_messages(inputs={}, query="Who are you?", user_id="test")
+        resp = await cln.chat_messages(inputs={}, query='Who are you?', user_id='test')
         print(resp)
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     asyncio.run(TestDifyClient().test_chat_messages())