Improve the details of the app

seratch · Apr 4, 2022 · 829c324 · 829c324
1 parent 647621e
commit 829c324
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 22 deletions.
diff --git a/app.py b/app.py
@@ -2,9 2,11 @@
 import logging
 import os
 import time
 from typing import Optional
 
 import deepl
 import requests
 from deepl import DocumentHandle
 from slack_bolt import App, Say, BoltContext, Ack
 from slack_bolt.adapter.socket_mode import SocketModeHandler
 from slack_sdk import WebClient
@@ -105,7 107,11 @@ def handle_some_action(ack: Ack):
 
 @app.event("reaction_added")
 def handle_reaction_added_events(
- event: dict, say: Say, client: WebClient, logger: logging.Logger
  event: dict,
  context: BoltContext,
  say: Say,
  client: WebClient,
  logger: logging.Logger,
 ):
  item = event.get("item", {})
  if item.get("type") != "message":
@@ -115,11 121,17 @@ def handle_reaction_added_events(
  if channel is None or ts is None:
  logger.debug("Skipped because either channel or ts is missing")
  return
- lang = detect_lang(event)
  reaction_name: str = event.get("reaction")
  lang = detect_lang(reaction_name)
  if lang is None:
  logger.debug(
  f"Skipped because no lang detected from the reaction ({event.get('reaction')})"
  )
  if reaction_name.startswith("flag-"):
  say(
  thread_ts=ts,
  text=f"Hey <@{context.user_id}>, the language used in {reaction_name} is not yet supported.",
  )
  return
  replies = client.conversations_replies(
  channel=channel,
@@ -150,7 162,7 @@ def handle_reaction_added_events(
 
  already_translated = False
  for message in replies.get("messages"):
- # check if the translated file is already uploaded
  # Check if the translated file is already uploaded
  if (
  message.get("files") is not None
  and message.get("files")[0].get("name") == translated_file_name
@@ -164,17 176,38 @@ def handle_reaction_added_events(
  if already_translated:
  continue
 
- # call DeepL API
  # Download the Slack file content
  input_document = requests.get(
  url=file.get("url_private_download"),
  headers={"Authorization": f"Bearer {client.token}"},
  ).content
  # The IO object to save the result file data returned from DeepL
  output_document = io.BytesIO()
 
  # Calling DeepL API
  try:
- handle = translator.translate_document_upload(
- input_document,
- target_lang=lang.upper(),
- filename=translated_file_name,
  handle: Optional[DocumentHandle] = None
  try:
  handle = translator.translate_document_upload(
  input_document,
  target_lang=lang.upper(),
  filename=translated_file_name,
  )
  except Exception as e:
  say(
  thread_ts=ts,
  text=f"Hey <@{context.user_id}>, we failed to translate the document "
  f"into the language used in :{reaction_name}:. "
  f"(file: {original_name}, lang: {lang}, error: ${e})",
  )
  return
 
  say(
  thread_ts=thread_ts,
  text=f"Hey <@{context.user_id}>, "
  f"thanks for requesting :{reaction_name}: (lang: {lang}) translation of `{original_name}`! "
  "The DeepL backend is now working on the task :man-biking: "
  "We will post a translated file once the translation is done! :bow:",
  )
 
  try:
@@ -190,14 223,18 @@ def handle_reaction_added_events(
  except Exception as e:
  say(
  thread_ts=thread_ts,
- text=f"Failed to translate the document (error: {e})",
  text=":x: Failed to translate the document "
  f"(file: {original_name}, reaction: :{reaction_name}:, lang: {lang}, error: {e})",
  )
  return
 
  if not status.ok:
  say(
  thread_ts=thread_ts,
- text=f"Failed to translate the document for some reason",
  # TODO: improve this message to have the error details (need to enhance the DeepL SDK)
  text=":x: Failed to translate the document for some reason. "
  "The common pattern is that the original document is already written in the target language. "
  f"(file: {original_name}, reaction: :{reaction_name}:, lang: {lang})",
  )
  return
 
@@ -208,7 245,8 @@ def handle_reaction_added_events(
  file=output_document,
  channels=[channel],
  thread_ts=thread_ts,
- initial_comment=f"Here is the {lang} translation of {original_name} :wave:",
  initial_comment=f"Hey <@{context.user_id}>, thanks for waiting!"
  f"Here is :{reaction_name}: (lang: {lang}) translation of `{original_name}` :white_check_mark:",
  )
  finally:
  output_document.close()

diff --git a/languages.py b/languages.py
@@ -5,7 5,7 @@
  "ac": "en-us",
  "ag": "en-us",
  "ai": "en-us",
- "ao": "pt",
  "ao": "pt-pt",
  "ar": "es",
  "as": "en-us",
  "at": "de",
@@ -20,7 20,7 @@
  "bn": "en-us",
  "bo": "es",
  "bq": "nl",
- "br": "pt",
  "br": "pt-br",
  "bs": "en-us",
  "bw": "en-us",
  "bz": "en-us",
@@ -38,7 38,7 @@
  "cp": "fr",
  "cr": "es",
  "cu": "es",
- "cv": "pt",
  "cv": "pt-pt",
  "cw": "nl",
  "cx": "en-us",
  "de": "de",
@@ -47,6 47,7 @@
  "do": "es",
  "ea": "es",
  "ec": "es",
  "england": "en-gb",
  "es": "es",
  "fj": "en-us",
  "fk": "en-us",
@@ -66,10 67,11 @@
  "gs": "en-us",
  "gt": "es",
  "gu": "en-us",
- "gw": "pt",
  "gw": "pt-pt",
  "gy": "en-us",
  "hn": "es",
  "ic": "es",
  "ie": "en-gb",
  "im": "en-us",
  "io": "en-us",
  "it": "it",
@@ -91,7 93,7 @@
  "mu": "en-us",
  "mw": "en-us",
  "mx": "es",
- "mz": "pt",
  "mz": "pt-pt",
  "na": "en-us",
  "nc": "fr",
  "ne": "fr",
@@ -107,21 109,22 @@
  "pm": "fr",
  "pn": "en-us",
  "pr": "es",
- "pt": "pt",
  "pt-pt": "pt-pt",
  "pw": "en-us",
  "py": "es",
  "re": "fr",
  "ru": "ru",
  "sb": "en-us",
  "sc": "en-us",
  "scotland": "en-gb",
  "sg": "en-us",
  "sh": "en-us",
  "sl": "en-us",
  "sm": "it",
  "sn": "fr",
  "sr": "nl",
  "ss": "en-us",
- "st": "pt",
  "st": "pt-pt",
  "sv": "es",
  "sx": "nl",
  "ta": "en-us",
@@ -140,15 143,15 @@
  "vg": "en-us",
  "vi": "en-us",
  "wf": "fr",
  "wales": "en-gb",
  "yt": "fr",
  "zm": "en-us",
  "zw": "en-us",
 }
 
 
-def detect_lang(event: dict) -> Optional[str]:
- reaction_name = event.get("reaction")
- m = re.findall("/(?!flag-\b)\b\\w /", reaction_name)
 def detect_lang(reaction_name: str) -> Optional[str]:
  m = re.findall(r"flag-(\w )", reaction_name)
  if m is not None and m != []:
  country = m[0]
  return reaction_to_lang.get(country)

diff --git a/readme.md b/readme.md
@@ -13,7 13,7 @@ This app provides two features as below.
 When a user adds a reaction to a message with files, this app calls [DeepL's document translation API](https://www.deepl.com/docs-api/translating-documents/).
 When the translation is done, this app uploads the result as a new file in the message's thread.
 
-<img width="500" src="https://user-images.githubusercontent.com/19658/161419367-c1b48d85-5bf7-4199-8857-66e5649f838a.png">
 <img width="500" src="https://user-images.githubusercontent.com/19658/161464009-fc530afc-36bb-4eb8-a491-98dbb6389552.png">
 
 ### Usage Dashboard