translatekit 0.3.1__tar.gz → 0.3.2__tar.gz

{translatekit-0.3.1 → translatekit-0.3.2}/MANIFEST.in

@@ -1,4 +1,4 @@
-include README.md
-include LICENSE
-include requirements.txt
+include README.md
+include LICENSE
+include requirements.txt
 recursive-include py_translate_kit *.py

{translatekit-0.3.1/translatekit.egg-info → translatekit-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: translatekit
-Version: 0.3.1
+Version: 0.3.2
 Summary: 一个简单快捷的翻译服务工具包，支持自定义脚本扩展
 Home-page: https://github.com/HZBHZB1234/Py-Translate-Kit
 Author: HZBHZB1234
@@ -39,11 +39,8 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Requires-Python: >=3.6.0
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests>=2.25.1
-Requires-Dist: beautifulsoup4>=4.9.3
-Requires-Dist: jsonpatch>=1.26
 Provides-Extra: extras
+License-File: LICENSE
 
 # Py-Translate-Kit 🌐
 

{translatekit-0.3.1 → translatekit-0.3.2}/setup.py

@@ -12,7 +12,7 @@ URL = 'https://github.com/HZBHZB1234/Py-Translate-Kit'
 EMAIL = 'HZBHZB1234@outlook.com'
 AUTHOR = 'HZBHZB1234'
 REQUIRES_PYTHON = '>=3.6.0'
-VERSION = '0.3.1'
+VERSION = '0.3.2'
 
 # What packages are required for this module to be executed?
 REQUIRED = [

{translatekit-0.3.1 → translatekit-0.3.2}/translatekit/__init__.py

@@ -66,5 +66,5 @@ __all__ = [
     'kit'
 ]
 
-__version__ = "0.3.1"
+__version__ = "0.3.2"
 __author__ = "HZBHZB1234"

{translatekit-0.3.1 → translatekit-0.3.2}/translatekit/llm_general.py

@@ -33,7 +33,8 @@ class LLMGeneralTranslator(TranslatorBase):
         "frequency_penalty": 0.0,
         "presence_penalty": 0.0,
         "system_prompt": "你是一个专业的翻译助手，严格按照要求完成翻译任务，只返回翻译结果，不添加任何额外解释、说明或格式。",
-        "response_format": "text"
+        "response_format": "text",
+        "extra_body": {}
     }
 
     DESCRIBE_API_KEY = [
@@ -106,6 +107,13 @@ class LLMGeneralTranslator(TranslatorBase):
             "type": "string",
             "required": False,
             "description": "响应格式定义，可选json_object，text"
+        },
+        {
+            "id": "extra_body",
+            "name": "额外请求体",
+            "type": "dictionary",
+            "required": False,
+            "description": "额外的请求体参数，将以字典形式合并到API请求体中，用于传递特殊参数（如OpenAI的reasoning_effort、seed等）"
         }
     ]
     
@@ -264,6 +272,10 @@ class LLMGeneralTranslator(TranslatorBase):
             "response_format": {"type": self.response_format},
             "messages": self._build_translation_prompt(text)
         }
+
+        # 合并额外请求体参数（extra_body中的键会覆盖已有键）
+        if self.extra_body:
+            request_data.update(self.extra_body)
                 
         try:
             # 发送API请求

{translatekit-0.3.1 → translatekit-0.3.2}/translatekit/null_translator.py

@@ -1,57 +1,57 @@
-"""
-空翻译器实现，对于所有输入文本都返回原文，用于调试目的
-"""
-
-from typing import Dict, Any, Optional
-from .base import TranslatorBase, TranslationConfig, Metadata
-
-
-class NullTranslator(TranslatorBase):
-    """空翻译器实现类，对于所有输入文本都返回原文，用于调试目的"""
-    
-    # 服务元信息
-    SERVICE_NAME = "null_translator"
-    SUPPORTED_LANGUAGES = {
-        'auto': '自动检测',
-        'en': '英语'
-    }
-    
-    METADATA = Metadata(
-        console_url="",
-        description="空翻译器，对于所有输入文本都返回原文，用于调试目的",
-        documentation_url="",
-        short_description="空翻译器（调试用）",
-        usage_documentation="不发送任何网络请求，直接返回原文，用于调试翻译流程"
-    )
-    
-    def _translate_default(self, text: str, source_lang: str, target_lang: str, **kwargs) -> str:
-        """
-        默认翻译方法，直接返回原文
-        
-        Args:
-            text: 要翻译的文本
-            source_lang: 源语言
-            target_lang: 目标语言
-            **kwargs: 额外参数
-            
-        Returns:
-            原始文本，不做任何翻译
-        """
-        return text
-
-    def _parse_api_response(self, response: Any, **kwargs) -> str:
-        """
-        解析API响应，对于NullTranslator，响应就是原始文本
-        
-        Args:
-            response: API响应（在这里就是原始文本）
-            **kwargs: 额外参数
-            
-        Returns:
-            解析后的翻译文本
-        """
-        return response
-
-    def _validate_languages(self, source_lang: str, target_lang: str):
-        """验证语言对，NullTranslator不做验证，允许所有语言对"""
+"""
+空翻译器实现，对于所有输入文本都返回原文，用于调试目的
+"""
+
+from typing import Dict, Any, Optional
+from .base import TranslatorBase, TranslationConfig, Metadata
+
+
+class NullTranslator(TranslatorBase):
+    """空翻译器实现类，对于所有输入文本都返回原文，用于调试目的"""
+    
+    # 服务元信息
+    SERVICE_NAME = "null_translator"
+    SUPPORTED_LANGUAGES = {
+        'auto': '自动检测',
+        'en': '英语'
+    }
+    
+    METADATA = Metadata(
+        console_url="",
+        description="空翻译器，对于所有输入文本都返回原文，用于调试目的",
+        documentation_url="",
+        short_description="空翻译器（调试用）",
+        usage_documentation="不发送任何网络请求，直接返回原文，用于调试翻译流程"
+    )
+    
+    def _translate_default(self, text: str, source_lang: str, target_lang: str, **kwargs) -> str:
+        """
+        默认翻译方法，直接返回原文
+        
+        Args:
+            text: 要翻译的文本
+            source_lang: 源语言
+            target_lang: 目标语言
+            **kwargs: 额外参数
+            
+        Returns:
+            原始文本，不做任何翻译
+        """
+        return text
+
+    def _parse_api_response(self, response: Any, **kwargs) -> str:
+        """
+        解析API响应，对于NullTranslator，响应就是原始文本
+        
+        Args:
+            response: API响应（在这里就是原始文本）
+            **kwargs: 额外参数
+            
+        Returns:
+            解析后的翻译文本
+        """
+        return response
+
+    def _validate_languages(self, source_lang: str, target_lang: str):
+        """验证语言对，NullTranslator不做验证，允许所有语言对"""
         pass

{translatekit-0.3.1 → translatekit-0.3.2/translatekit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: translatekit
-Version: 0.3.1
+Version: 0.3.2
 Summary: 一个简单快捷的翻译服务工具包，支持自定义脚本扩展
 Home-page: https://github.com/HZBHZB1234/Py-Translate-Kit
 Author: HZBHZB1234
@@ -39,11 +39,8 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Requires-Python: >=3.6.0
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests>=2.25.1
-Requires-Dist: beautifulsoup4>=4.9.3
-Requires-Dist: jsonpatch>=1.26
 Provides-Extra: extras
+License-File: LICENSE
 
 # Py-Translate-Kit 🌐
 

{translatekit-0.3.1 → translatekit-0.3.2}/translatekit.egg-info/SOURCES.txt

@@ -1,13 +1,9 @@
-.gitignore
 LICENSE
 MANIFEST.in
 README.md
 pyproject.toml
 requirements.txt
 setup.py
-docs/TRANSLATION_CONFIG.md
-docs/example.py
-docs/kit.md
 test/test_argu.py
 translatekit/__init__.py
 translatekit/baidu.py

translatekit-0.3.1/.gitignore

@@ -1,222 +0,0 @@
-# custom gitignore
-prompt.md
-dev
-test.py
-test*.py
-!test_argu.py
-test_assets/
-*.docx
-*.pdf
-*.pptx
-.iflowignore
-iflow.md
-.kit
-.vscode
-.rmv
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[codz]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py.cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# UV
-#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#uv.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-#poetry.toml
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
-#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
-#pdm.lock
-#pdm.toml
-.pdm-python
-.pdm-build/
-
-# pixi
-#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
-#pixi.lock
-#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
-#   in the .venv directory. It is recommended not to include this directory in version control.
-.pixi
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.envrc
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
-
-# Abstra
-# Abstra is an AI-powered process automation framework.
-# Ignore directories containing user credentials, local state, and settings.
-# Learn more at https://abstra.io/docs
-.abstra/
-
-# Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
-#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
-#  you could uncomment the following to ignore the entire vscode folder
-# .vscode/
-
-# Ruff stuff:
-.ruff_cache/
-
-# PyPI configuration file
-.pypirc
-
-# Cursor
-#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
-#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
-#  refer to https://docs.cursor.com/context/ignore-files
-.cursorignore
-.cursorindexingignore
-
-# Marimo
-marimo/_static/
-marimo/_lsp/
-__marimo__/

translatekit-0.3.1/docs/TRANSLATION_CONFIG.md

@@ -1,120 +0,0 @@
-# 翻译配置参数详解
-
-本文档详细介绍了 Py-Translate-Kit 中 [TranslationConfig](file:///e:/desktop/limbus%20transfer/Py-Translate-Kit/translatekit/kit.py#L287-L317) 类的所有配置参数，帮助用户更好地理解和使用该翻译工具包。
-
-## 配置参数分类
-
-### 1. API配置
-
-- **api_setting**: `Dict[str, str] = None`
-  - 用于存储API密钥的字典，不同翻译服务需要不同的密钥格式
-  - 默认为None，若未提供则初始化为空字典
-  - 使用示例：`{"appkey": "your_app_key", "secret": "your_secret"}`
-
-### 2. 翻译参数
-
-- **source_lang**: `str = "auto"`
-  - 源语言代码，指定待翻译文本的语言
-  - 默认为"auto"，表示自动检测语言
-  - 支持的语言代码因翻译服务而异
-
-- **target_lang**: `str = "en"`
-  - 目标语言代码，指定翻译后的语言
-  - 默认为"en"（英语）
-
-- **method**: `str = "default"`
-  - 翻译方法选择，用于指定使用哪种翻译策略
-  - 默认为"default"方法
-
-### 3. 文本处理
-
-- **text_max_length**: `int = 2000`
-  - 单次翻译文本的最大长度
-  - 默认值为2000字符，超过此长度的文本将被分块处理
-
-- **split_strategy**: `SplitStrategy = SplitStrategy.SENTENCE`
-  - 文本分割策略，可选值包括：
-    - [SplitStrategy.SENTENCE](translatekit/base.py#L615-L620): 按句子分割
-    - [SplitStrategy.PARAGRAPH](translatekit/base.py#L621-L625): 按段落分割
-    - [SplitStrategy.FIXED_LENGTH](translatekit/base.py#L626-L650): 按固定长度分割
-    - [SplitStrategy.SEMANTIC](translatekit/base.py#L651-L655): 语义分割(待实现)
-
-- **enable_preprocessing**: `bool = True`
-  - 是否启用预处理功能
-  - 默认启用，预处理需要手动添加相关函数
-  - 预处理函数列表默认为空
-
-- **enable_postprocessing**: `bool = True`
-  - 是否启用后处理功能
-  - 默认启用，后处理需要手动添加相关函数
-  - 后处理函数列表默认为空
-
-### 4. 重试与容错
-
-- **max_retries**: `int = 3`
-  - 最大重试次数，当翻译请求失败时的重试次数
-  - 默认为3次
-
-- **retry_strategy**: `RetryStrategy = RetryStrategy.EXPONENTIAL`
-  - 重试策略，可选值包括：
-    - [RetryStrategy.EXPONENTIAL](translatekit/base.py#L687-L696): 指数退避策略
-    - [RetryStrategy.LINEAR](translatekit/base.py#L687-L696): 线性退避策略
-    - [RetryStrategy.ADAPTIVE](translatekit/base.py#L687-L696): 自适应策略
-
-- **timeout**: `float = 30.0`
-  - 请求超时时间（秒）
-  - 默认为30.0秒
-
-### 5. 并发设置
-
-- **max_workers**: `int = 5`
-  - 最大工作线程数，用于并发处理翻译任务
-  - 默认为5个线程
-
-- **batch_size**: `int = 10`
-  - 批处理大小，批量翻译时每批处理的文本数量
-  - 默认为10条
-
-### 6. 高级功能
-
-- **enable_cache**: `bool = False`
-  - 是否启用缓存功能
-  - 默认关闭，开启后可缓存翻译结果，自动匹配相同文本，可以减少重复翻译
-
-- **cache_size**: `Optional[int] = None`
-  - 缓存大小限制
-  - 默认为None，表示无限制
-
-- **enable_metrics**: `bool = False`
-  - 是否启用性能指标收集
-  - 默认关闭，开启后可以追踪翻译使用量
-
-- **debug_mode**: `bool = False`
-  - 是否启用调试模式
-  - 默认关闭，开启后会将logger.level设置为DEBUG，输出更多日志信息
-
-## 使用示例
-
-```python
-import translatekit as tkit
-
-# 创建带自定义配置的翻译器
-config = tkit.TranslationConfig(
-    api_setting={"appkey": "your_app_key"},
-    debug_mode=True,
-    enable_cache=True,
-    cache_size=1000,
-    source_lang="zh",
-    target_lang="en",
-    text_max_length=5000,
-    max_retries=5,
-    timeout=60.0
-)
-
-# 创建翻译器实例
-translator = tkit.BaiduTranslator(config=config)
-
-# 使用翻译器
-result = translator.translate("你好，世界！")
-print(result)
-```

translatekit-0.3.1/docs/example.py

@@ -1,182 +0,0 @@
-import translatekit as tkit
-
-# 获取目标翻译器配置逻辑
-default_api_key = tkit.BaiduTranslator.DEFAULT_API_KEY
-describe_api_key = tkit.BaiduTranslator.DESCRIBE_API_KEY
-for index, describe in enumerate(describe_api_key):
-    print(f'''
-          参数{index+1}
-          参数ID：{describe["id"]}
-          参数名称：{describe["name"]}
-          参数是否必填：{describe["required"]}
-          参数类型：{describe["type"]}
-          参数描述：{describe["description"]}，
-          ''')
-
-# 可以通过打印TranslationConfig类来获取默认配置
-print(tkit.TranslationConfig)
-
-# 可以使用TranslationConfig类来配置翻译器参数
-config = tkit.TranslationConfig(
-    api_setting={"appkey": "your_app_key"},
-    debug_mode=True,
-    enable_cache=True,
-    cache_size=1000
-)
-
-# 创建翻译器实例
-translator = tkit.BaiduTranslator(
-    config=config,
-    # 也可以通过kwargs的方式传入并修改参数
-    # 先判断并修改config中的参数，没有的话再修改config.api_setting中的参数
-    source_lang="zh",
-    target_lang="en",
-    appid = "your_app_id"
-)
-
-text = "你好，世界！"
-
-# 调用翻译器进行翻译
-result = translator.translate(text)
-
-print(result)
-
-texts = ["你好，世界！", "晚安"]
-
-# 调用翻译器进行批量翻译，翻译器会自动判断类型
-results = translator.translate(texts)
-
-print(results)
-
-# 调用翻译器进行领域翻译
-# 你可以在调用translate方法时传入参数method=以改变翻译方法
-# 一般而言，也会提供一个单独的方法来调用其他翻译方法，如translate_with_domain
-
-result_domain = translator.translate(text, method="domain", domain="news")
-result_domain_ = translator.translate_with_domain(text, "news", "en")
-print(result_domain)
-print(result_domain_)
-
-# 你可以在调用translate方法时传入参数来临时改变翻译配置
-result = translator.translate(text, source_lang="zh", target_lang="en", text_max_length=5000)
-print(result)
-
-# 也可以使用update_config方法来更新翻译配置（永久）
-translator.update_config(source_lang="zh", target_lang="en", text_max_length=5000)
-result = translator.translate(text)
-print(result)
-
-# 通过get_supported_languages方法可以获取支持的语言列表
-meta = translator.get_supported_languages()
-print(meta)
-
-# 通过get_special_api_reference方法可以获取翻译器的特殊函数参考
-meta = translator.get_special_api_reference()
-print(meta)
-
-# 通过get_metadata方法可以获取翻译器的元数据
-meta = translator.get_metadata()
-print(meta)
-
-# 也可以通过一系列方法来获取翻译器的单独元数据等
-meta_console_url = translator.get_console_url()
-print(meta_console_url)
-meta_description = translator.get_description()
-print(meta_description)
-meta_documentation_url = translator.get_documentation_url()
-print(meta_documentation_url)
-meta_short_description = translator.get_short_description()
-print(meta_short_description)
-# 注：大部分翻译器还未实现get_usage_documentation方法
-meta_usage_documentation = translator.get_usage_documentation()
-print(meta_usage_documentation)
-# 注：大部分翻译器还未实现get_custom_content方法
-meta_custom_content = translator.get_custom_content()
-print(meta_custom_content)
-
-# 使用get_performance_metrics方法获取当次开销
-usage = translator.get_performance_metrics()
-print(usage)
-
-# 使用clear_cache方法清除缓存
-translator.clear_cache()
-
-# 你可以通过add_preprocess和add_postprocess方法来添加预处理和后处理函数
-# 预处理函数会在调用translate方法之前被调用
-# 后处理函数会在调用translate方法之后被调用
-# 预处理函数和后处理函数的调用顺序是按照添加的顺序
-# 你可以通过clear_preprocess和clear_postprocess方法来清除所有预处理和后处理函数
-
-translator.add_preprocess(lambda x: x.upper())
-translator.add_postprocess(lambda x: x.lower())
-result = translator.translate(text)
-print(result)
-
-translator.clear_preprocess()
-translator.clear_postprocess()
-result = translator.translate(text)
-print(result)
-
-# 这是默认config的配置逻辑，我将使用他来介绍各个参数功能
-
-"""
-class TranslationConfig:
-    # API配置
-    # 本文开头已经介绍了API配置的过程，这里不再赘述
-    api_setting: Dict[str, str] = None
-    
-    # 目标语言和源语言
-    source_lang: str = "auto"
-    target_lang: str = "en"
-    
-    # 翻译方法选择
-    method: str = "default"
-    
-    # 文本处理
-    # 文本最大长度
-    text_max_length: int = 2000
-    # 文本分割策略
-    split_strategy: SplitStrategy = SplitStrategy.SENTENCE
-    # 启用文本预处理(需要自定义)
-    enable_preprocessing: bool = True
-    # 启用文本后处理(需要自定义)
-    enable_postprocessing: bool = True
-    
-    # 重试与容错
-    max_retries: int = 3
-    retry_strategy: RetryStrategy = RetryStrategy.EXPONENTIAL
-    timeout: float = 30.0
-    
-    # 并发设置
-    # 并发请求数
-    max_workers: int = 5
-    # 批量请求数
-    batch_size: int = 10
-    
-    # 启用缓存
-    enable_cache: bool = False
-    # 缓存大小上限
-    cache_size: Optional[int] = None
-    
-    # 启用性能记录
-    enable_metrics: bool = False
-    # 调试模式(设置logget等级为DEBUG)
-    debug_mode: bool = False
-"""
-
-# llm_general翻译器的传参比较特殊
-
-config = tkit.TranslationConfig(
-    api_setting={"api_key": "your_api_key",
-                 "base_url": "https://api.openai.com/v1",
-                 "user_prompt_base": "第一句话:{0}，第二句话:{1}，第三句话:{2}"},
-    debug_mode=True,
-    enable_cache=True,
-    cache_size=1000
-)
-
-translator = tkit.LLMGeneralTranslator(
-    config=config
-)
-
-translator.translate(["你好，世界！", "晚安", "再见"])

translatekit-0.3.1/docs/kit.md

@@ -1,224 +0,0 @@
-# 翻译工具Kit函数详解
-
-## 函数compare_json(json1, json2)
-该函数用于比较两个json文件的差异，并返回jsonpatch格式的差异结果。
-
-### 参数
-- json1：第一个json文件
-- json2：第二个json文件
-
-### 返回值
-- 返回jsonpatch格式的差异结果
-
-### 示例
-```python
-json1 = {"name": "John", "age": 30}
-json2 = {"name": "John", "age": 35}
-
-kit.compare_json(json1, json2)
-# 输出：[{"op": "replace", "path": "/age", "value": 35}]
-```
-
-### 注意事项
-- 该函数依赖于jsonpatch库，需要先安装：`pip install jsonpatch`。
-- 本函数完全基于jsonpatch.make_patch()函数实现，并没有额外增加功能。
-
-## 函数apply_patch(json1, patch)
-该函数用于将JSON补丁应用到原始JSON对象上，返回应用补丁后的结果。
-
-### 参数
-- json1：原始JSON对象
-- patch：要应用的JSON补丁
-
-### 返回值
-- 返回应用补丁后的JSON对象
-
-### 示例
-```python
-json1 = {"name": "John", "age": 30}
-patch = [{"op": "replace", "path": "/age", "value": 35}]
-
-kit.apply_patch(json1, patch)
-# 输出：{"name": "John", "age": 35}
-```
-
-### 注意事项
-- 该函数依赖于jsonpatch库，需要先安装：`pip install jsonpatch`。
-- 本函数完全基于jsonpatch.apply_patch()函数实现，并没有额外增加功能。
-
-## 函数make_list_patch(_jsonpatch)
-从JSON补丁中提取值列表，只返回操作类型为'add'或'replace'且值为字符串的项。方便使用翻译函数进行批量翻译。
-
-### 参数
-- _jsonpatch：JSON补丁列表
-
-### 返回值
-- 返回字符串值的列表
-
-### 示例
-```python
-jsonpatch = [
-    {"op": "add", "path": "/name", "value": "John"},
-    {"op": "add", "path": "/age", "value": 30},
-    {"op": "replace", "path": "/city", "value": "New York"}
-]
-result = kit.make_list_patch(jsonpatch)
-
-# 输出：["John", "New York"]
-```
-
-## 函数apply_list_patch(_jsonpatch, translate_list)
-将翻译后的值应用到JSON补丁中，返回更新后的补丁。
-
-### 参数
-- _jsonpatch：原始JSON补丁列表
-- translate_list：翻译后的字符串值列表
-
-### 返回值
-- 返回更新后的补丁列表
-
-### 异常
-- 如果翻译列表中的项数与预期不符，将抛出TranslateKitError异常
-
-### 示例
-```python
-jsonpatch = [
-    {"op": "add", "path": "/name", "value": "John"},
-    {"op": "replace", "path": "/city", "value": "New York"}
-]
-translate_list = ["张三", "北京"]
-
-result = kit.apply_list_patch(jsonpatch, translate_list)
-# 输出：
-# [
-#   {"op": "add", "path": "/name", "value": "张三"},
-#   {"op": "replace", "path": "/city", "value": "北京"}
-# ]
-```
-
-
-## 函数flatten_with_paths(data, prefix="")
-该函数将嵌套的数据结构扁平化为路径-值对的列表，方便使用jsonpatch库进行操作。
-
-### 参数
-- data：要扁平化的数据（可以是字典或列表）
-- prefix：路径前缀，默认为空字符串
-
-### 返回值
-- 返回包含操作-路径-值对的列表
-
-### 示例
-```python
-data = {"user": {"name": "John", "hobbies": ["reading", "swimming"]}}
-result = kit.flatten_with_paths(data)
-
-# 输出：
-# [
-#   {"path": "", "value": {}},
-#   {"path": "/user", "value": {}},
-#   {"path": "/user/name", "value": "John"},
-#   {"path": "/user/hobbies", "value": []},
-#   {"path": "/user/hobbies/0", "value": "reading"},
-#   {"path": "/user/hobbies/1", "value": "swimming"}
-# ]
-```
-
-## 函数deoptimize_patch(original_patch)
-由于jsonpatch库的优化机制，可能会将一些操作合并为一个操作，导致value值变成列表或字典。本函数将JSON Patch拆分为多个单一操作的patch，确保所有值为字符串类型。
-
-### 参数
-- original_patch：原始的JSON Patch对象（列表）
-
-### 返回值
-- 拆分后的JSON Patch对象（列表的列表）
-
-### 示例
-```python
-original_patch = [{"op": "add", "path": "/user", "value": {"name": "John", "age": 30}}]
-result = kit.deoptimize_patch(original_patch)
-
-# 输出：
-# [
-#   {"op": "add", "path": "/user", "value": {}},
-#   {"op": "add", "path": "/user/name", "value": "John"},
-#   {"op": "add", "path": "/user/age", "value": 30}
-# ]
-```
-
-## 函数filted_patchs(jsonpatchs, allow_list, disallow_list, disallow_op)
-通过正则表达式或操作类型过滤补丁，返回过滤后的补丁列表。
-
-### 参数
-- jsonpatchs：原始JSON补丁列表
-- allow_list：允许的路径模式列表，默认为['.*']（允许所有）
-- disallow_list：不允许的路径模式列表，默认为['$.']（不允许根路径）
-- disallow_op：不允许的操作类型列表
-
-### 返回值
-- 返回过滤后的补丁列表
-
-### 示例
-```python
-patches = [
-    {"op": "add", "path": "/datalist/0/name", "value": "John"},
-    {"op": "add", "path": "/data/age", "value": 30},
-    {"op": "replace", "path": "/data/city", "value": "New York"}
-]
-
-filtered = kit.filted_patchs(
-    patches,
-    allow_list=[r".*/name", r"/data/.*"],
-    disallow_op=["replace"]         # 不允许replace操作
-)
-
-# 输出：[{"op": "add", "path": "/datalist/0/name", "value": "John"},{"op": "add", "path": "/data/age", "value": 30},]
-```
-
-## 函数apply_filtered_patchs(original_jsonpatchs, filted_jsonpatchs, allow_list, disallow_list, disallow_op)
-恢复被过滤的补丁，将过滤处理后的补丁重新合并到原始补丁列表中。
-
-### 参数
-- original_jsonpatchs：原始JSON补丁列表
-- filted_jsonpatchs：经过过滤处理的补丁列表
-- allow_list：允许的路径模式列表
-- disallow_list：不允许的路径模式列表
-- disallow_op：不允许的操作类型列表
-
-### 返回值
-- 返回恢复后的JSON补丁列表
-
-### 示例
-filted_patchs()函数的逆操作，此处不再赘述
-
-# 完整示例
-```python
-from translatekit import *
-import json
-import jsonpatch
-# 配置翻译参数
-config = TranslationConfig(
-    api_setting={"appid":"filted","appkey":"secret"},
-    target_lang="zh",  # 目标语言
-    debug_mode=True,
-    enable_cache=True,
-    enable_metrics=True
-)
-# 创建翻译器实例
-translator = BaiduTranslator(config=config)
-with open(r"test_assets\EN_1D101A.json", "r", encoding="utf-8") as f:
-    dicts = json.load(f)
-jsonpatchs = kit.compare_json({}, dicts)
-jsonpatchs = kit.deoptimize_patch(jsonpatchs)
-allow_list = [r".*/teller", r".*/dialog", r".*/place", r".*/content"]
-filted_jsonpatchs = kit.filted_patchs(jsonpatchs, allow_list=allow_list)
-texts = kit.make_list_patch(filted_jsonpatchs)
-[print(i) for i in texts]
-results = translator.translate(texts)
-[print(i) for i in results]
-filted_jsonpatchs = kit.apply_list_patch(filted_jsonpatchs, results)
-jsonpatchs = kit.apply_filtered_patchs(jsonpatchs, filted_jsonpatchs, allow_list=allow_list)
-results = kit.apply_patch({}, jsonpatchs)
-with open(r"test_assets\EN_1D101A_ZH.json", "w", encoding="utf-8") as f:
-    json.dump(results, f, ensure_ascii=False, indent=4)
-print(translator.get_performance_metrics())
-```