codeant-ai-for-open-source[bot] commented on code in PR #41651: URL: https://github.com/apache/superset/pull/41651#discussion_r3525753970
########## scripts/translations/apply_do_not_translate.py: ########## @@ -0,0 +1,128 @@ +#!/usr/bin/env python3 +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +"""Stamp do-not-translate msgids in a .pot with an extracted-comment marker. + +For every msgid listed in ``superset/translations/do-not-translate.txt`` that is +present in the target .pot, add a ``#. MACHINE_READ-DO_NOT_TRANSLATE`` extracted +comment. gettext extracted comments (``#.``) propagate from the .pot into every +language .po on ``pybabel update``, so the do-not-translate status stays +consistent across all catalogs from a single registry. + +Run from ``babel_update.sh`` after the .pot is extracted and normalized (and +before ``pybabel update``). Idempotent: re-running makes no further changes. + +Usage: + python scripts/translations/apply_do_not_translate.py [POT_PATH] + # POT_PATH defaults to superset/translations/messages.pot +""" + +from __future__ import annotations + +import sys +from pathlib import Path + +# The standardized extracted-comment marker. Kept in sync with backfill_po.py. +MARKER: str = "MACHINE_READ-DO_NOT_TRANSLATE" +_MARKER_LINE: str = f"#. {MARKER}" + +TRANSLATIONS_DIR: Path = ( + Path(__file__).parent.parent.parent / "superset" / "translations" +) +DEFAULT_POT: Path = TRANSLATIONS_DIR / "messages.pot" +REGISTRY: Path = TRANSLATIONS_DIR / "do-not-translate.txt" + + +def load_registry(path: Path = REGISTRY) -> set[str]: + """Return the set of do-not-translate msgids (skips comments/blank lines). + + Each line is stripped before the blank/comment check, so trailing + whitespace or an indented comment never yields a msgid that fails to match + the .pot. + """ + if not path.exists(): + return set() + entries: set[str] = set() + for raw_line in path.read_text(encoding="utf-8").splitlines(): + line = raw_line.strip() Review Comment: **Suggestion:** Add an explicit type annotation for this local variable to satisfy the required type-hint coverage for annotatable variables. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> The rule requires type hints on relevant annotatable variables in new or modified Python code. This local variable is assigned a string value and can be annotated as `line: str = raw_line.strip()`, so the omission is a real rule violation. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=0a178d839d6742658df56a63b3fbda76&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) [](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=0a178d839d6742658df56a63b3fbda76&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) *(Use Cmd/Ctrl + Click for best experience)* <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** scripts/translations/apply_do_not_translate.py **Line:** 61:61 **Comment:** *Custom Rule: Add an explicit type annotation for this local variable to satisfy the required type-hint coverage for annotatable variables. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise. Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix ``` </details> <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41651&comment_hash=c2782e7e2bf5c7e52d2ae06ca36684cec6d532f310fce6ffaf8fad20bdd4bb2d&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41651&comment_hash=c2782e7e2bf5c7e52d2ae06ca36684cec6d532f310fce6ffaf8fad20bdd4bb2d&reaction=dislike'>👎</a> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
