feat(gui): Support hiding services and their details by tylzh97 · Pull Request #746 · PDFMathTranslate/PDFMathTranslate

tylzh97 · 2025-03-11T06:35:47Z

fix #744 problems

Adding two Configure "ENABLED_SERVICES" and "HIDDEN_GRADIO_DETAILS"

and fix some typos.

{
    "USE_MODELSCOPE": "0",
    "translators": [
        {
            "name": "grok",
            "envs": {
                "GORK_API_KEY": null,
                "GORK_MODEL": "grok-2-1212"
            }
        },
        {
            "name": "openai",
            "envs": {
                "OPENAI_BASE_URL": "https://api.openai.com/v1",
                "OPENAI_API_KEY": "sk-xxxxx",
                "OPENAI_MODEL": "gpt-4o-mini"
            }
        }
    ],
    "ENABLED_SERVICES": [
        "OpenAI",
        "Grok",
        "Deepseek"
    ],
    "HIDDEN_GRADIO_DETAILS": true,
    "PDF2ZH_LANG_FROM": "English",
    "PDF2ZH_LANG_TO": "Simplified Chinese",
    "NOTO_FONT_PATH": "/app/SourceHanSerifCN-Regular.ttf"
}

2. A dumb way to fix PDFMathTranslate#744, which keys still in Gradio, there is also have risk of key leakage, but the GUI view is more clean.

Copilot

PR Overview

This PR addresses issues with the gradio UI by fixing translator naming inconsistencies and adding two new configuration options to control enabled services and gradio detail visibility. Key changes include replacing "GorkTranslator" with "GrokTranslator" across multiple files, introducing configuration-based filtering for services via ENABLED_SERVICES, and adding a flag for hiding gradio details via HIDDEN_GRADIO_DETAILS.

Reviewed Changes

File	Description
pdf2zh/gui.py	Renames translator, adds config handling for enabled services and gradio detail visibility, and updates dropdown defaults.
pdf2zh/converter.py	Updates translator reference from GorkTranslator to GrokTranslator.
pdf2zh/pdf2zh.py	Renames translator reference from GorkTranslator to GrokTranslator.
pdf2zh/translator.py	Renames class from GorkTranslator to GrokTranslator.

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

pdf2zh/gui.py:585

Setting the Dropdown's default value to an empty string may cause issues if it does not match any of the choices in enabled_services. Consider using a default value that is present in the enabled_services list.

value=""

pdf2zh/gui.py

tylzh97 · 2025-03-11T07:01:29Z

sorry... i guess i have made a mistake. the assertion about enabled_services is too absolute, we need to keep the original when the configuration is not effective. I'll fix it later

awwaawwa · 2025-03-11T07:02:23Z

Please handle the situation when these two parameters are not obtained.

hellofinch · 2025-03-11T07:06:09Z

@tylzh97 @awwaawwa mask的问题，我再次确认了一下，gradio有bug。已经向上游提了issue，在上游确认后再进行修改。
gradio-app/gradio#10781

tylzh97 · 2025-03-11T07:06:55Z

Please handle the situation when these two parameters are not obtained.

I intend to set the default configuration to empty because I noticed that the default value does not trigger the "on_select" logic, causing a disruption in the initialization process of related variables.

awwaawwa · 2025-03-11T07:08:03Z

Please handle the situation when these two parameters are not obtained.

I intend to set the default configuration to empty because I noticed that the default value does not trigger the "on_select" logic, causing a disruption in the initialization process of related variables.

This will prevent all pdf2zh -i users from using it normally, including all users using .exe

hellofinch · 2025-03-11T07:12:42Z

@tylzh97 默认值可以保留Google和bing。这样的话也可以在其他api失效时能够有备用service作为补充。

awwaawwa · 2025-03-11T07:14:06Z

@tylzh97 默认值可以保留Google和bing。这样的话也可以在其他api失效时能够有备用service作为补充。

Just display everything directly by default, it doesn't affect users who don't use this feature at all.

awwaawwa · 2025-03-11T07:15:06Z

Before the configuration system is completely refactored, we should not introduce too many changes in this area. The initialization of the translator will be completely changed in the configuration system refactoring.

tylzh97 · 2025-03-11T07:19:06Z

Gotcha. This is a very simple PR that can meet the real deployment needs. I will ensure that the performance in the default configuration state remains unchanged, and I will submit a patch later. As for Gradio, I am not familiar with nor have used Gradio Mask. Using '***' as a placeholder can ensure that our keys are not leaked.

awwaawwa · 2025-03-11T07:20:24Z

Gotcha. This is a very simple PR that can meet the real deployment needs. I will ensure that the performance in the default configuration state remains unchanged, and I will submit a patch later. As for Gradio, I am not familiar with nor have used Gradio Mask. Using '***' as a placeholder can ensure that our keys are not leaked.

Let's handle it this way, this PR will serve as a workaround to temporarily support this requirement. The formal solution will be implemented after the configuration system restructuring is completed.

hellofinch · 2025-03-11T07:28:01Z

Gotcha. This is a very simple PR that can meet the real deployment needs. I will ensure that the performance in the default configuration state remains unchanged, and I will submit a patch later. As for Gradio, I am not familiar with nor have used Gradio Mask. Using '***' as a placeholder can ensure that our keys are not leaked.

这个方式应该做不到想要的效果，或者最简单的方式就是直接把相关的部分的type直接设置成password。无论是URL还是API key都设成password。等上游bug解决了，我们就可以动态的设置相关的mask了。

tylzh97 · 2025-03-11T07:34:31Z

默认配置的情况下:

配置了三个配置,但是没有隐藏的情况下:

两个配置都开启的情况下:

网络请求信息:

翻译结果:

Copilot

PR Overview

This PR fixes UI issues in the Gradio interface and corrects naming inconsistencies with the translator classes, while also addressing typos. Key changes include:

Renaming all occurrences of "GorkTranslator" to "GrokTranslator".
Introducing new configuration keys ("ENABLED_SERVICES" and "HIDDEN_GRADIO_DETAILS") to control available services and hide API keys in the UI.
Fixing typos in error messages and comments.

Reviewed Changes

File	Description
pdf2zh/gui.py	Updated translator reference, added service configuration logic, and fixed error message wording.
pdf2zh/converter.py	Renamed translator reference from GorkTranslator to GrokTranslator.
pdf2zh/pdf2zh.py	Renamed translator reference from GorkTranslator to GrokTranslator.
pdf2zh/translator.py	Renamed class from GorkTranslator to GrokTranslator.

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

pdf2zh/gui.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

awwaawwa · 2025-03-11T07:38:19Z

Please use black . to format the code

hellofinch · 2025-03-11T07:52:50Z

有个小问题，目前这样的设计的话，是不是没有了在web上修改API的能力了？

awwaawwa · 2025-03-11T07:53:18Z

Can you write a simple document to describe this feature at https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md. @tylzh97

awwaawwa · 2025-03-11T07:53:40Z

有个小问题，目前这样的设计的话，是不是没有了在web上修改API的能力了？

When this function is needed, it's obviously not desirable for users to modify the API on the webui.

tylzh97 · 2025-03-11T07:54:15Z

有个小问题，目前这样的设计的话，是不是没有了在web上修改API的能力了？

是的我就是这样设计的因为部署给普通用户使用也没必要让普通用户修改 API 了[捂脸]

如果需要修改 API 和 API_KEY 那么直接使用项目官网的网页版本就好了私有化部署可能没有这个需求

tylzh97 · 2025-03-11T07:56:01Z

有个小问题，目前这样的设计的话，是不是没有了在web上修改API的能力了？

可以选择不开启 "HIDDEN_GRADIO_DETAILS" 选项 , 这样也允许用户在 Gradio 中修改 API 以及 API_KEY

Copilot

PR Overview

A feature update to support hiding services and their detailed information via two new configuration options while also correcting typos and renaming translators.

Added documentation for the new configuration keys ENABLED_SERVICES and HIDDEN_GRADIO_DETAILS
Renamed translator references from GorkTranslator to GrokTranslator across multiple modules
Updated Gradio UI behavior to hide real API keys and enforce enabled service filtering

Reviewed Changes

File	Description
docs/ADVANCED.md	Added documentation for new configuration options and updated JSON sample usage
pdf2zh/gui.py	Updated translator naming, introduced logic for enabled services, and masked API keys
pdf2zh/pdf2zh.py	Updated translator list to use GrokTranslator
pdf2zh/translator.py	Renamed class from GorkTranslator to GrokTranslator
pdf2zh/converter.py	Updated translator list initialization to use GrokTranslator

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

pdf2zh/gui.py:668

[nitpick] Consider revising the comment for clarity, for example: 'We use "***" to mask the real API key.'

value = "***"  # We use "***" Present Real API_KEY

docs/ADVANCED.md

awwaawwa · 2025-03-11T08:10:21Z

Thank you for your contribution. According to https://funstory-ai.github.io/BabelDOC/CONTRIBUTOR_REWARD/ , you can apply for a monthly membership redemption code for Immersive Translate.

awwaawwa · 2025-03-11T08:12:31Z

There is a https://github.com/tylzh97/PDFMathTranslate/blob/fix-gradio-ui/.github/workflows/fork-build.yml CI that can build ghcr docker for forks as well.

The pdf2zh main branch just released 1.9.5, and the next release should be in about 3-5 days or a week. During this period, you can use the ghcr docker image built from the forked repository.

awwaawwa · 2025-03-11T08:14:55Z

Or you can also use the image with the dev tag from the main line.

tylzh97 · 2025-03-11T08:17:05Z

There is a https://github.com/tylzh97/PDFMathTranslate/blob/fix-gradio-ui/.github/workflows/fork-build.yml CI that can build ghcr docker for forks as well.

The pdf2zh main branch just released 1.9.5, and the next release should be in about 3-5 days or a week. During this period, you can use the ghcr docker image built from the forked repository.

Gotcha, thanks.

tylzh97 added 2 commits March 11, 2025 06:04

1. Fix Typo from "GorkTranslator" to "GrokTranslator"

53d2182

2. A dumb way to fix PDFMathTranslate#744, which keys still in Gradio, there is also have risk of key leakage, but the GUI view is more clean.

1. Hidden the API_KEYS from Gradio

dce1626

tylzh97 mentioned this pull request Mar 11, 2025

feat: Hide detailed configuration of translation services in gradio + unconfigured translation services #744

Closed

awwaawwa requested a review from Copilot March 11, 2025 06:56

Copilot AI reviewed Mar 11, 2025

View reviewed changes

pdf2zh/gui.py Outdated Show resolved Hide resolved

Retain the original display format without using the new configuration.

2e36ad9

awwaawwa requested a review from Copilot March 11, 2025 07:33

Copilot AI reviewed Mar 11, 2025

View reviewed changes

pdf2zh/gui.py Outdated Show resolved Hide resolved

typo(gui): update error message

1843198

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

format code with black .

cad02f5

awwaawwa changed the title ~~Fix gradio UI~~ feat(gui): Support hiding services and their details Mar 11, 2025

add docs for Deployment as a public services

b69a00a

awwaawwa requested a review from Copilot March 11, 2025 08:08

Copilot AI reviewed Mar 11, 2025

View reviewed changes

docs/ADVANCED.md Show resolved Hide resolved

awwaawwa merged commit dc42ded into PDFMathTranslate:main Mar 11, 2025
7 checks passed

Uh oh!

Conversation

tylzh97 commented Mar 11, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

PR Overview

Reviewed Changes

Uh oh!

Uh oh!

tylzh97 commented Mar 11, 2025

Uh oh!

awwaawwa commented Mar 11, 2025

Uh oh!

hellofinch commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tylzh97 commented Mar 11, 2025

Uh oh!

awwaawwa commented Mar 11, 2025

Uh oh!

hellofinch commented Mar 11, 2025

Uh oh!

awwaawwa commented Mar 11, 2025

Uh oh!

awwaawwa commented Mar 11, 2025

Uh oh!

tylzh97 commented Mar 11, 2025

Uh oh!

awwaawwa commented Mar 11, 2025

Uh oh!

hellofinch commented Mar 11, 2025

Uh oh!

tylzh97 commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

PR Overview

Reviewed Changes

Uh oh!

Uh oh!

awwaawwa commented Mar 11, 2025

Uh oh!

hellofinch commented Mar 11, 2025

Uh oh!

awwaawwa commented Mar 11, 2025

Uh oh!

awwaawwa commented Mar 11, 2025

Uh oh!

tylzh97 commented Mar 11, 2025

Uh oh!

tylzh97 commented Mar 11, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

PR Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

awwaawwa commented Mar 11, 2025

Uh oh!

awwaawwa commented Mar 11, 2025

Uh oh!

awwaawwa commented Mar 11, 2025

Uh oh!

tylzh97 commented Mar 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hellofinch commented Mar 11, 2025 •

edited

Loading

tylzh97 commented Mar 11, 2025 •

edited

Loading