ovos-scriptconv-g2p-plugin 0.0.1__py3-none-any.whl

ovos_scriptconv_g2p_plugin/__init__.py

@@ -0,0 +1,147 @@
+"""OPM Grapheme2Phoneme plugin backed by scriptconv's phonemizer registry.
+
+scriptconv (https://github.com/TigreGotico/scriptconv) ships 45 phonemizer
+backends behind a single registry and normalizes every one of them to IPA
+output on request (``Alphabet.IPA``) - including backends that natively emit
+ARPABET/X-SAMPA/etc, since notation conversion is exactly what scriptconv is
+for. This plugin is a thin adapter: it does not implement any phonemization
+itself, it only exposes scriptconv's registry through the OVOS Plugin
+Manager G2P contract.
+
+Which phonemizer runs is a matter of config, nothing else - set
+``phonemizer`` to any :class:`scriptconv.phonemizers.Phonemizer` registry
+name (``espeak``, ``orthography2ipa``, ``tugaphone``, ...). When unset,
+scriptconv's own ``LANG_DEFAULTS``/fallback chain (explicit per-language
+default -> orthography2ipa -> espeak) picks the backend per word, exactly as
+``scriptconv.phonemizers.phonemize()`` does standalone.
+"""
+from typing import Optional, Set
+
+from ovos_plugin_manager.templates.g2p import Grapheme2PhonemePlugin, OutOfVocabulary
+from ovos_utils.log import LOG
+from scriptconv.phonemizers import (
+    Alphabet,
+    LANG_DEFAULTS,
+    Phonemizer,
+    get_phonemizer_class,
+    phonemize,
+)
+
+from ovos_scriptconv_g2p_plugin.version import __version__
+
+# reserved config keys consumed by this plugin; everything else in the
+# config dict is forwarded to scriptconv as phonemizer constructor kwargs
+# (e.g. "model"/"engine"/"register" selectors, "normalizer", ...)
+_RESERVED_KEYS = {"phonemizer", "lang", "module"}
+
+
+class ScriptconvG2PPlugin(Grapheme2PhonemePlugin):
+    """Grapheme2Phoneme plugin that delegates to scriptconv.
+
+    Config:
+        phonemizer (str, optional): registry name of the scriptconv
+            phonemizer to use, e.g. ``"espeak"``, ``"orthography2ipa"``,
+            ``"tugaphone"``. When omitted, scriptconv's per-language
+            ``LANG_DEFAULTS``/fallback chain selects the backend.
+        lang (str, optional): default language code used when callers don't
+            pass one explicitly.
+
+        Any other key is forwarded as a keyword argument to the underlying
+        scriptconv phonemizer constructor (``model``, ``normalizer``, ...).
+    """
+
+    def __init__(self, config: Optional[dict] = None):
+        super().__init__(config)
+        phonemizer_name = self.config.get("phonemizer")
+        self.phonemizer: Optional[Phonemizer] = (
+            Phonemizer(phonemizer_name) if phonemizer_name else None
+        )
+        self.default_lang = self.config.get("lang", "en-us")
+        self._backend_kwargs = {
+            k: v for k, v in self.config.items() if k not in _RESERVED_KEYS
+        }
+
+    def get_ipa(self, word, lang: Optional[str] = None, ignore_oov: bool = False):
+        """Return the IPA phonemes for *word* as a list of characters.
+
+        scriptconv is asked for ``Alphabet.IPA`` output directly - any
+        backend that natively emits a different notation (ARPABET,
+        X-SAMPA, ...) is converted internally by scriptconv before it
+        reaches us, so callers always see IPA here regardless of which
+        phonemizer is configured.
+        """
+        lang = lang or self.default_lang
+        try:
+            ipa_str = phonemize(
+                word,
+                lang,
+                alphabet=Alphabet.IPA,
+                override=self.phonemizer,
+                **self._backend_kwargs,
+            )
+        except ImportError:
+            # configured-but-missing backing package: scriptconv already
+            # raises a clear, actionable error (names the pip extra) -
+            # never swallow this behind ignore_oov, it's a config/env
+            # problem, not an out-of-vocabulary word
+            raise
+        except (ValueError, KeyError) as e:
+            LOG.debug(f"scriptconv could not phonemize {word!r} ({lang}): {e}")
+            if ignore_oov:
+                return None
+            raise OutOfVocabulary(str(e)) from e
+        if not ipa_str:
+            if ignore_oov:
+                return None
+            raise OutOfVocabulary(f"empty phonemization for: {word!r}")
+        return list(ipa_str)
+
+    @property
+    def available_languages(self) -> Set[str]:
+        """Languages supported by the configured phonemizer.
+
+        scriptconv's 45 backends expose language coverage inconsistently
+        (some declare a ``*_LANGS`` list, some a ``supported_langs()``
+        classmethod, some validate lazily per-call with no static list at
+        all) so this is best-effort:
+
+        - a specific ``phonemizer`` configured: read whatever static
+          metadata that backend's class exposes (``ESPEAK_LANGS``,
+          ``supported_langs()``); if the backend exposes none, fall back to
+          the language(s) it is the declared default for in
+          ``LANG_DEFAULTS``.
+        - no ``phonemizer`` configured: scriptconv's own fallback chain
+          (explicit defaults -> orthography2ipa -> espeak) can in practice
+          cover essentially any language, so this returns the union of
+          every language with an explicit ``LANG_DEFAULTS`` entry as a
+          floor, not an exhaustive list.
+        """
+        if self.phonemizer is None:
+            return set(LANG_DEFAULTS.keys())
+        return self._langs_for(self.phonemizer)
+
+    @staticmethod
+    def _langs_for(phonemizer: Phonemizer) -> Set[str]:
+        try:
+            cls = get_phonemizer_class(phonemizer)
+        except ImportError:
+            cls = None
+        langs: Set[str] = set()
+        if cls is not None:
+            for attr in ("ESPEAK_LANGS", "SUPPORTED_LANGS", "LANGS"):
+                val = getattr(cls, attr, None)
+                if val:
+                    langs.update(val)
+                    break
+            if not langs and hasattr(cls, "supported_langs"):
+                try:
+                    langs.update(cls.supported_langs())
+                except Exception as e:
+                    LOG.debug(f"could not introspect supported_langs for {cls}: {e}")
+        if not langs:
+            langs = {
+                lang
+                for lang, chain in LANG_DEFAULTS.items()
+                if phonemizer in chain
+            }
+        return langs

ovos_scriptconv_g2p_plugin/version.py

@@ -0,0 +1,8 @@
+# START_VERSION_BLOCK
+VERSION_MAJOR = 0
+VERSION_MINOR = 0
+VERSION_BUILD = 1
+VERSION_ALPHA = 0
+# END_VERSION_BLOCK
+
+__version__ = f"{VERSION_MAJOR}.{VERSION_MINOR}.{VERSION_BUILD}" + (f"a{VERSION_ALPHA}" if VERSION_ALPHA else "")

ovos_scriptconv_g2p_plugin-0.0.1.dist-info/METADATA

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: ovos-scriptconv-g2p-plugin
+Version: 0.0.1
+Summary: OPM G2P plugin over scriptconv: 45 phonemizers behind one config switch
+Author-email: jarbasai <jarbasai@mailfence.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/TigreGotico/ovos-scriptconv-g2p-plugin
+Keywords: ovos,plugin,g2p,phonemizer,ipa,scriptconv
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ovos-plugin-manager<3.0.0,>=2.1.0
+Requires-Dist: scriptconv<1.0.0,>=0.0.4a19
+Dynamic: license-file
+
+# ovos-scriptconv-g2p-plugin
+
+An OVOS Plugin Manager (OPM) [Grapheme2Phoneme](https://github.com/OpenVoiceOS/ovos-plugin-manager) plugin.
+
+This plugin does not phonemize text itself. It is a thin adapter over
+[scriptconv](https://github.com/TigreGotico/scriptconv)'s phonemizer
+registry, which bundles 45 phonemizer backends behind one API and converts
+every one of them to IPA on request - including backends that natively
+emit ARPABET, X-SAMPA, or another notation, since notation conversion is
+scriptconv's whole reason to exist.
+
+Which backend runs is a matter of config, nothing else. Point `phonemizer`
+at any [`scriptconv.phonemizers.Phonemizer`](https://github.com/TigreGotico/scriptconv)
+registry name and this plugin uses it. Leave it unset and scriptconv's own
+per-language `LANG_DEFAULTS`/fallback chain (explicit default ->
+[orthography2ipa](https://github.com/TigreGotico/orthography2ipa) -> espeak)
+picks a backend per word, same as calling `scriptconv.phonemizers.phonemize()`
+directly.
+
+Benchmarked and compared against the other G2P plugins in the
+[ovos-plugin-arena](https://github.com/TigreGotico/ovos-plugin-arena).
+
+## Install
+
+```bash
+pip install ovos-scriptconv-g2p-plugin
+```
+
+`scriptconv` and `ovos-plugin-manager` are the only hard dependencies.
+Individual phonemizer backends are optional - scriptconv lazy-imports them,
+and installing this plugin does **not** pull in any of the 45 backing
+packages. If you configure a backend whose package isn't installed, you get
+a clear `ImportError` naming the pip extra to install, e.g.:
+
+```bash
+pip install scriptconv[espeak]        # espeak backend
+pip install scriptconv[o2i]           # orthography2ipa backend
+pip install scriptconv[pt-phonemizers]  # tugaphone backend
+```
+
+See scriptconv's `pyproject.toml` for the full extras list - one per
+backend or language family.
+
+## Configuration
+
+```json
+"g2p": {
+    "module": "ovos-scriptconv-g2p-plugin",
+    "ovos-scriptconv-g2p-plugin": {
+        "phonemizer": "espeak",
+        "lang": "en-us"
+    }
+}
+```
+
+- `phonemizer` (optional): registry name of the scriptconv phonemizer to
+  use, e.g. `"espeak"`, `"orthography2ipa"`, `"tugaphone"`. Omit it to let
+  scriptconv pick the default backend per language.
+- `lang` (optional): default language used when a caller doesn't pass one
+  explicitly.
+- any other key is forwarded as a keyword argument to the underlying
+  scriptconv phonemizer constructor (`model`, `normalizer`, ...).
+
+## Usage
+
+```python
+from ovos_plugin_manager.g2p import OVOSG2PFactory
+
+config = {"g2p": {"module": "ovos-scriptconv-g2p-plugin",
+                   "ovos-scriptconv-g2p-plugin": {"phonemizer": "espeak"}}}
+g2p = OVOSG2PFactory.create(config)
+print(g2p.get_ipa("hello", "en-us"))
+```
+
+## Links
+
+- [scriptconv](https://github.com/TigreGotico/scriptconv) - the phonemizer
+  registry and notation converter this plugin wraps
+- [ovos-plugin-manager](https://github.com/OpenVoiceOS/ovos-plugin-manager) -
+  defines the `Grapheme2PhonemePlugin` contract this plugin implements
+- [ovos-plugin-arena](https://github.com/TigreGotico/ovos-plugin-arena) -
+  benchmarks this plugin against other G2P engines

ovos_scriptconv_g2p_plugin-0.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+ovos_scriptconv_g2p_plugin/__init__.py,sha256=yUcj0colel3u4mXxRo4RPp5eEKH6JpkuV9ieY5ugolM,6231
+ovos_scriptconv_g2p_plugin/version.py,sha256=dxgp-HGaOFOBXbil4DQkkjeZwQlHTh5TGIkuOrh2kvU,229
+ovos_scriptconv_g2p_plugin-0.0.1.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+ovos_scriptconv_g2p_plugin-0.0.1.dist-info/METADATA,sha256=OprwzQ6tLj9IS2rldxTlyAjfI48YFzt6aRBIiZ01t8k,3679
+ovos_scriptconv_g2p_plugin-0.0.1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+ovos_scriptconv_g2p_plugin-0.0.1.dist-info/entry_points.txt,sha256=H_YI4JYvXcF_Hnjc3UW9fzHSV21JBTHcylkFWBfF2w0,86
+ovos_scriptconv_g2p_plugin-0.0.1.dist-info/top_level.txt,sha256=a7DjHdRGUF-6AqC7VVXEPFRWzMxlehwCYdkIWlFqeqs,27
+ovos_scriptconv_g2p_plugin-0.0.1.dist-info/RECORD,,

ovos_scriptconv_g2p_plugin-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ovos_scriptconv_g2p_plugin-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[opm.g2p]
+ovos-scriptconv-g2p-plugin = ovos_scriptconv_g2p_plugin:ScriptconvG2PPlugin

ovos_scriptconv_g2p_plugin-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

ovos_scriptconv_g2p_plugin-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+ovos_scriptconv_g2p_plugin