diff --git a/media-translation/snippets/noxfile.py b/media-translation/snippets/noxfile.py new file mode 100644 index 000000000000..5ff9e1db5808 --- /dev/null +++ b/media-translation/snippets/noxfile.py @@ -0,0 +1,259 @@ +# Copyright 2019 Google LLC +# +# Licensed 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. + +from __future__ import print_function + +import os +from pathlib import Path +import sys +from typing import Callable, Dict, List, Optional + +import nox + + +# WARNING - WARNING - WARNING - WARNING - WARNING +# WARNING - WARNING - WARNING - WARNING - WARNING +# DO NOT EDIT THIS FILE EVER! +# WARNING - WARNING - WARNING - WARNING - WARNING +# WARNING - WARNING - WARNING - WARNING - WARNING + +# Copy `noxfile_config.py` to your directory and modify it instead. + + +# `TEST_CONFIG` dict is a configuration hook that allows users to +# modify the test configurations. The values here should be in sync +# with `noxfile_config.py`. Users will copy `noxfile_config.py` into +# their directory and modify it. + +TEST_CONFIG = { + # You can opt out from the test for specific Python versions. + 'ignored_versions': ["2.7"], + + # Old samples are opted out of enforcing Python type hints + # All new samples should feature them + 'enforce_type_hints': False, + + # An envvar key for determining the project id to use. Change it + # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a + # build specific Cloud project. You can also use your own string + # to use your own Cloud project. + 'gcloud_project_env': 'GOOGLE_CLOUD_PROJECT', + # 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT', + # If you need to use a specific version of pip, + # change pip_version_override to the string representation + # of the version number, for example, "20.2.4" + "pip_version_override": None, + # A dictionary you want to inject into your test. Don't put any + # secrets here. These values will override predefined values. + 'envs': {}, +} + + +try: + # Ensure we can import noxfile_config in the project's directory. + sys.path.append('.') + from noxfile_config import TEST_CONFIG_OVERRIDE +except ImportError as e: + print("No user noxfile_config found: detail: {}".format(e)) + TEST_CONFIG_OVERRIDE = {} + +# Update the TEST_CONFIG with the user supplied values. +TEST_CONFIG.update(TEST_CONFIG_OVERRIDE) + + +def get_pytest_env_vars() -> Dict[str, str]: + """Returns a dict for pytest invocation.""" + ret = {} + + # Override the GCLOUD_PROJECT and the alias. + env_key = TEST_CONFIG['gcloud_project_env'] + # This should error out if not set. + ret['GOOGLE_CLOUD_PROJECT'] = os.environ[env_key] + + # Apply user supplied envs. + ret.update(TEST_CONFIG['envs']) + return ret + + +# DO NOT EDIT - automatically generated. +# All versions used to tested samples. +ALL_VERSIONS = ["2.7", "3.6", "3.7", "3.8", "3.9"] + +# Any default versions that should be ignored. +IGNORED_VERSIONS = TEST_CONFIG['ignored_versions'] + +TESTED_VERSIONS = sorted([v for v in ALL_VERSIONS if v not in IGNORED_VERSIONS]) + +INSTALL_LIBRARY_FROM_SOURCE = bool(os.environ.get("INSTALL_LIBRARY_FROM_SOURCE", False)) +# +# Style Checks +# + + +def _determine_local_import_names(start_dir: str) -> List[str]: + """Determines all import names that should be considered "local". + + This is used when running the linter to insure that import order is + properly checked. + """ + file_ext_pairs = [os.path.splitext(path) for path in os.listdir(start_dir)] + return [ + basename + for basename, extension in file_ext_pairs + if extension == ".py" + or os.path.isdir(os.path.join(start_dir, basename)) + and basename not in ("__pycache__") + ] + + +# Linting with flake8. +# +# We ignore the following rules: +# E203: whitespace before ‘:’ +# E266: too many leading ‘#’ for block comment +# E501: line too long +# I202: Additional newline in a section of imports +# +# We also need to specify the rules which are ignored by default: +# ['E226', 'W504', 'E126', 'E123', 'W503', 'E24', 'E704', 'E121'] +FLAKE8_COMMON_ARGS = [ + "--show-source", + "--builtin=gettext", + "--max-complexity=20", + "--import-order-style=google", + "--exclude=.nox,.cache,env,lib,generated_pb2,*_pb2.py,*_pb2_grpc.py", + "--ignore=E121,E123,E126,E203,E226,E24,E266,E501,E704,W503,W504,I202", + "--max-line-length=88", +] + + +@nox.session +def lint(session: nox.sessions.Session) -> None: + if not TEST_CONFIG['enforce_type_hints']: + session.install("flake8", "flake8-import-order") + else: + session.install("flake8", "flake8-import-order", "flake8-annotations") + + local_names = _determine_local_import_names(".") + args = FLAKE8_COMMON_ARGS + [ + "--application-import-names", + ",".join(local_names), + "." + ] + session.run("flake8", *args) +# +# Black +# + + +@nox.session +def blacken(session: nox.sessions.Session) -> None: + session.install("black") + python_files = [path for path in os.listdir(".") if path.endswith(".py")] + + session.run("black", *python_files) + +# +# Sample Tests +# + + +PYTEST_COMMON_ARGS = ["--junitxml=sponge_log.xml"] + + +def _session_tests(session: nox.sessions.Session, post_install: Callable = None) -> None: + if TEST_CONFIG["pip_version_override"]: + pip_version = TEST_CONFIG["pip_version_override"] + session.install(f"pip=={pip_version}") + """Runs py.test for a particular project.""" + if os.path.exists("requirements.txt"): + if os.path.exists("constraints.txt"): + session.install("-r", "requirements.txt", "-c", "constraints.txt") + else: + session.install("-r", "requirements.txt") + + if os.path.exists("requirements-test.txt"): + if os.path.exists("constraints-test.txt"): + session.install("-r", "requirements-test.txt", "-c", "constraints-test.txt") + else: + session.install("-r", "requirements-test.txt") + + if INSTALL_LIBRARY_FROM_SOURCE: + session.install("-e", _get_repo_root()) + + if post_install: + post_install(session) + + session.run( + "pytest", + *(PYTEST_COMMON_ARGS + session.posargs), + # Pytest will return 5 when no tests are collected. This can happen + # on travis where slow and flaky tests are excluded. + # See http://doc.pytest.org/en/latest/_modules/_pytest/main.html + success_codes=[0, 5], + env=get_pytest_env_vars() + ) + + +@nox.session(python=ALL_VERSIONS) +def py(session: nox.sessions.Session) -> None: + """Runs py.test for a sample using the specified version of Python.""" + if session.python in TESTED_VERSIONS: + _session_tests(session) + else: + session.skip("SKIPPED: {} tests are disabled for this sample.".format( + session.python + )) + + +# +# Readmegen +# + + +def _get_repo_root() -> Optional[str]: + """ Returns the root folder of the project. """ + # Get root of this repository. Assume we don't have directories nested deeper than 10 items. + p = Path(os.getcwd()) + for i in range(10): + if p is None: + break + if Path(p / ".git").exists(): + return str(p) + # .git is not available in repos cloned via Cloud Build + # setup.py is always in the library's root, so use that instead + # https://github.com/googleapis/synthtool/issues/792 + if Path(p / "setup.py").exists(): + return str(p) + p = p.parent + raise Exception("Unable to detect repository root.") + + +GENERATED_READMES = sorted([x for x in Path(".").rglob("*.rst.in")]) + + +@nox.session +@nox.parametrize("path", GENERATED_READMES) +def readmegen(session: nox.sessions.Session, path: str) -> None: + """(Re-)generates the readme for a sample.""" + session.install("jinja2", "pyyaml") + dir_ = os.path.dirname(path) + + if os.path.exists(os.path.join(dir_, "requirements.txt")): + session.install("-r", os.path.join(dir_, "requirements.txt")) + + in_file = os.path.join(dir_, "README.rst.in") + session.run( + "python", _get_repo_root() + "/scripts/readme-gen/readme_gen.py", in_file + ) diff --git a/media-translation/snippets/requirements-test.txt b/media-translation/snippets/requirements-test.txt new file mode 100644 index 000000000000..95ea1e6a02b0 --- /dev/null +++ b/media-translation/snippets/requirements-test.txt @@ -0,0 +1 @@ +pytest==6.2.4 diff --git a/media-translation/snippets/requirements.txt b/media-translation/snippets/requirements.txt new file mode 100644 index 000000000000..9f0ba480a732 --- /dev/null +++ b/media-translation/snippets/requirements.txt @@ -0,0 +1,3 @@ +google-cloud-media-translation==0.2.0 +pyaudio==0.2.11 +six==1.16.0 \ No newline at end of file diff --git a/media-translation/snippets/resources/audio.raw b/media-translation/snippets/resources/audio.raw new file mode 100644 index 000000000000..5ebf79d3c9c5 Binary files /dev/null and b/media-translation/snippets/resources/audio.raw differ diff --git a/media-translation/snippets/translate_from_file.py b/media-translation/snippets/translate_from_file.py new file mode 100644 index 000000000000..3e746b2be1e4 --- /dev/null +++ b/media-translation/snippets/translate_from_file.py @@ -0,0 +1,71 @@ +# Copyright 2020 Google LLC +# +# Licensed 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. + +"""Cloud Media Translation sample application. + +Example usage: + python translate_from_file.py resources/audio.raw +""" + +# [START mediatranslation_translate_from_file] +from google.cloud import mediatranslation + + +def translate_from_file(file_path="path/to/your/file"): + client = mediatranslation.SpeechTranslationServiceClient() + + # The `sample_rate_hertz` field is not required for FLAC and WAV (Linear16) + # encoded data. Other audio encodings must provide the sampling rate. + audio_config = mediatranslation.TranslateSpeechConfig( + audio_encoding="linear16", + source_language_code="en-US", + target_language_code="fr-FR", + ) + + streaming_config = mediatranslation.StreamingTranslateSpeechConfig( + audio_config=audio_config, single_utterance=True + ) + + def request_generator(config, audio_file_path): + + # The first request contains the configuration. + # Note that audio_content is explicitly set to None. + yield mediatranslation.StreamingTranslateSpeechRequest(streaming_config=config) + + with open(audio_file_path, "rb") as audio: + while True: + chunk = audio.read(4096) + if not chunk: + break + yield mediatranslation.StreamingTranslateSpeechRequest( + audio_content=chunk + ) + + requests = request_generator(streaming_config, file_path) + responses = client.streaming_translate_speech(requests) + + for response in responses: + # Once the transcription settles, the response contains the + # is_final result. The other results will be for subsequent portions of + # the audio. + print(f"Response: {response}") + result = response.result + translation = result.text_translation_result.translation + + if result.text_translation_result.is_final: + print("\nFinal translation: {0}".format(translation)) + break + + print("\nPartial translation: {0}".format(translation)) + # [END mediatranslation_translate_from_file] diff --git a/media-translation/snippets/translate_from_file_test.py b/media-translation/snippets/translate_from_file_test.py new file mode 100644 index 000000000000..ce7a0ba55f06 --- /dev/null +++ b/media-translation/snippets/translate_from_file_test.py @@ -0,0 +1,28 @@ +# Copyright 2020 Google LLC +# +# Licensed 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. + +import os +import re + +import translate_from_file + +RESOURCES = os.path.join(os.path.dirname(__file__), 'resources') + + +def test_translate_streaming(capsys): + translate_from_file.translate_from_file( + os.path.join(RESOURCES, 'audio.raw')) + out, err = capsys.readouterr() + + assert re.search(r'Partial translation', out, re.DOTALL | re.I) diff --git a/media-translation/snippets/translate_from_mic.py b/media-translation/snippets/translate_from_mic.py new file mode 100644 index 000000000000..3d2e6169566f --- /dev/null +++ b/media-translation/snippets/translate_from_mic.py @@ -0,0 +1,172 @@ +# Copyright 2020 Google LLC +# +# Licensed 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. + +"""Cloud Media Translation API sample application using a microphone. + +Example usage: + python translate_from_mic.py +""" + +# [START mediatranslation_translate_from_mic] +from __future__ import division + +import itertools + +from google.cloud import mediatranslation as media +import pyaudio +from six.moves import queue + +# Audio recording parameters +RATE = 16000 +CHUNK = int(RATE / 10) # 100ms +SpeechEventType = media.StreamingTranslateSpeechResponse.SpeechEventType + + +class MicrophoneStream: + """Opens a recording stream as a generator yielding the audio chunks.""" + + def __init__(self, rate, chunk): + self._rate = rate + self._chunk = chunk + + # Create a thread-safe buffer of audio data + self._buff = queue.Queue() + self.closed = True + + def __enter__(self): + self._audio_interface = pyaudio.PyAudio() + self._audio_stream = self._audio_interface.open( + format=pyaudio.paInt16, + channels=1, rate=self._rate, + input=True, frames_per_buffer=self._chunk, + # Run the audio stream asynchronously to fill the buffer object. + # This is necessary so that the input device's buffer doesn't + # overflow while the calling thread makes network requests, etc. + stream_callback=self._fill_buffer, + ) + + self.closed = False + + return self + + def __exit__(self, type=None, value=None, traceback=None): + self._audio_stream.stop_stream() + self._audio_stream.close() + self.closed = True + # Signal the generator to terminate so that the client's + # streaming_recognize method will not block the process termination. + self._buff.put(None) + self._audio_interface.terminate() + + def _fill_buffer(self, in_data, frame_count, time_info, status_flags): + """Continuously collect data from the audio stream, into the buffer.""" + self._buff.put(in_data) + return None, pyaudio.paContinue + + def exit(self): + self.__exit__() + + def generator(self): + while not self.closed: + # Use a blocking get() to ensure there's at least one chunk of + # data, and stop iteration if the chunk is None, indicating the + # end of the audio stream. + chunk = self._buff.get() + if chunk is None: + return + data = [chunk] + + # Now consume whatever other data's still buffered. + while True: + try: + chunk = self._buff.get(block=False) + if chunk is None: + return + data.append(chunk) + except queue.Empty: + break + + yield b''.join(data) + + +def listen_print_loop(responses): + """Iterates through server responses and prints them. + + The responses passed is a generator that will block until a response + is provided by the server. + """ + translation = '' + for response in responses: + # Once the transcription settles, the response contains the + # END_OF_SINGLE_UTTERANCE event. + if (response.speech_event_type == + SpeechEventType.END_OF_SINGLE_UTTERANCE): + + print(u'\nFinal translation: {0}'.format(translation)) + return 0 + + result = response.result + translation = result.text_translation_result.translation + + print(u'\nPartial translation: {0}'.format(translation)) + + +def do_translation_loop(): + print('Begin speaking...') + + client = media.SpeechTranslationServiceClient() + + speech_config = media.TranslateSpeechConfig( + audio_encoding='linear16', + source_language_code='en-US', + target_language_code='es-ES') + + config = media.StreamingTranslateSpeechConfig( + audio_config=speech_config, single_utterance=True) + + # The first request contains the configuration. + # Note that audio_content is explicitly set to None. + first_request = media.StreamingTranslateSpeechRequest( + streaming_config=config) + + with MicrophoneStream(RATE, CHUNK) as stream: + audio_generator = stream.generator() + mic_requests = (media.StreamingTranslateSpeechRequest( + audio_content=content) + for content in audio_generator) + + requests = itertools.chain(iter([first_request]), mic_requests) + + responses = client.streaming_translate_speech(requests) + + # Print the translation responses as they arrive + result = listen_print_loop(responses) + if result == 0: + stream.exit() + + +def main(): + while True: + print() + option = input('Press any key to translate or \'q\' to quit: ') + + if option.lower() == 'q': + break + + do_translation_loop() + + +if __name__ == '__main__': + main() +# [END mediatranslation_translate_from_mic]