pybabel-angularjs 1.4.0__py3-none-any.whl

pybabel_angularjs/extractor.py

@@ -0,0 +1,246 @@
+from html.parser import HTMLParser
+from typing import Iterable, Iterator, Mapping, Sequence, Any
+
+import re
+
+type ExtractorEntry = tuple[int, str, str, list[str]]
+type AllowedAttributesByTag = dict[str, list[str]]
+type HtmlAttributes = list[tuple[str, str | None]]
+
+
+class TagNotAllowedException(Exception):
+    pass
+
+
+class TagAttributeNotAllowedException(Exception):
+    pass
+
+
+class ExtractAttributeNotAllowedException(Exception):
+    pass
+
+
+class MissingAttributeException(Exception):
+    pass
+
+
+class AngularJSGettextHTMLParser(HTMLParser):
+    """Parse HTML to find translate directives.
+
+    Currently this parses for these forms of translation:
+
+    <p data-translate>content</p>
+        The content will be translated. Angular value templating will be
+        recognised and transformed into gettext-familiar translation
+        entries (i.e. "{$ expression $}" becomes "%(expression)")
+    """
+
+    VOID_TAGS = ("br", "input", "img")
+
+    def __init__(
+        self,
+        include_tags: list[str],
+        include_attributes: list[str],
+        extract_attribute: str,
+        allowed_attributes_by_tag: AllowedAttributesByTag,
+    ) -> None:
+        super().__init__()
+
+        self.include_tags: list[str] = include_tags
+        self.include_attributes: list[str] = include_attributes
+        self.extract_attribute: str = extract_attribute
+        self.allowed_attributes_by_tag: AllowedAttributesByTag = allowed_attributes_by_tag
+
+        self.in_translate: bool = False
+        self.inner_tags: list[str] = []
+        self.data: list[str] = []
+        self.entries: list[ExtractorEntry] = []
+        self.start_lineno: int = 0
+        self.comments: list[str] = []
+        self.re_collapse_whitespaces: re.Pattern[str] = re.compile(r"\s+")
+        self.in_do_not_translate: bool = False
+
+    @property
+    def do_not_extract_attribute(self) -> str:
+        return "no-" + self.extract_attribute
+
+    def normalize_string(self, string: str, replace_whitespace: str = " ") -> str:
+        """
+        :type string: str
+        :type replace_whitespace: str
+        """
+        string = (
+            string
+                .replace("\n", " ")
+                .replace("\t", " ")
+                .replace(" ", "&nbsp;")
+        )
+        return self.re_collapse_whitespaces.sub(replace_whitespace, string).strip()
+
+    def add_entry(self, message: str, comments: Sequence[str] | None = None, lineno: int | None = None) -> None:
+        comments = comments or []
+        self.entries.append(
+            (
+                lineno or self.start_lineno,
+                "gettext",
+                self.normalize_string(message),
+                [self.normalize_string(comment) for comment in comments],
+            )
+        )
+
+    def append_inner_tag(self, tag: str) -> None:
+        if tag not in self.VOID_TAGS:
+            self.inner_tags.append(tag)
+
+    def handle_startendtag(self, tag: str, attrs: HtmlAttributes) -> None:
+        self.handle_starttag(tag, attrs)
+        if tag not in self.VOID_TAGS:
+            self.handle_endtag(tag)
+
+    def attrdict_contains(self, attrdict: Mapping[str, str | None], search: Sequence[str] | None = None) -> bool:
+        search = search or [self.extract_attribute, self.do_not_extract_attribute]
+        for attr in attrdict:
+            for prefix in search:
+                if attr.startswith(prefix):
+                    return True
+        return False
+
+    def handle_starttag(self, tag: str, attrs: HtmlAttributes) -> None:
+        attrdict = dict(attrs)
+        lineno = self.getpos()[0]
+
+        if self.in_do_not_translate:
+            if self.attrdict_contains(attrdict):
+                raise ExtractAttributeNotAllowedException((lineno, tag, attrdict))
+            self.append_inner_tag(tag)
+            return
+
+        if self.in_translate and (
+            self.extract_attribute in attrdict or self.do_not_extract_attribute in attrdict
+        ):
+            raise ExtractAttributeNotAllowedException((lineno, tag, attrdict))
+
+        if tag == "div" and self.do_not_extract_attribute in attrdict:
+            self.in_do_not_translate = True
+            if self.attrdict_contains(attrdict, [self.extract_attribute]):
+                raise ExtractAttributeNotAllowedException((lineno, tag, attrdict))
+            return
+
+        # handle data-translate attribute for translating content
+        if self.in_translate:
+            if tag not in self.allowed_attributes_by_tag:
+                raise TagNotAllowedException((lineno, tag))
+
+            allowed_attributes = self.allowed_attributes_by_tag[tag]
+            diff_attributes = set(attrdict.keys()) - set(allowed_attributes)
+            for attr in diff_attributes:
+                if attr.startswith(self.extract_attribute + "-"):   # i18n-
+                    pair_attr = attr.removeprefix(self.extract_attribute + "-")
+                else:
+                    pair_attr = f"{self.extract_attribute}-{attr}"
+                if pair_attr not in attrdict:
+                    raise TagAttributeNotAllowedException((lineno, tag, attrdict))
+
+            if attrs:
+                rendered_attrs = " ".join(f'{name}="{value or ""}"' for name, value in attrs)
+                self.data.append(f"<{tag} {rendered_attrs}>")
+            else:
+                self.data.append(f"<{tag}>")
+
+            self.append_inner_tag(tag)
+        elif self.extract_attribute in attrdict or (tag in self.include_tags and self.do_not_extract_attribute not in attrdict):
+            self.start_lineno = lineno
+            self.in_translate = True
+            comment = attrdict.get(self.extract_attribute)
+            if comment:
+                self.comments.append(comment)
+
+        already_added_attrs = []
+        # auto-add attributes
+        for attr in self.include_attributes:
+            exclude_attribute = f"{self.do_not_extract_attribute}-{attr}"
+            value = attrdict.get(attr)
+            if value is not None and exclude_attribute not in attrdict:
+                self.add_entry(value, [attr], lineno)
+                already_added_attrs.append(attr)
+
+        # i18n-marked attributes
+        for attr in attrdict:
+            if attr.startswith(self.extract_attribute + "-"):
+                name = attr.removeprefix(self.extract_attribute + "-")
+                if name not in attrdict:
+                    raise MissingAttributeException((lineno, tag, name))
+
+                value = attrdict[name]
+                if value is not None and name not in already_added_attrs:
+                    self.add_entry(value, [name], lineno)
+
+    def handle_data(self, data: str) -> None:
+        if self.in_translate:
+            self.data.append(data)
+
+    def handle_endtag(self, tag: str) -> None:
+        if self.in_do_not_translate:
+            if len(self.inner_tags) > 0:
+                self.inner_tags.pop()
+                return
+
+            self.in_do_not_translate = False
+
+        if self.in_translate:
+            if len(self.inner_tags) > 0:
+                tag = self.inner_tags.pop()
+                self.data.append(f"</{tag}>")
+                return
+
+            self.add_entry("".join(self.data), self.comments)
+            self.in_translate = False
+            self.data.clear()
+            self.comments = []
+
+
+def get_option_list(options: Mapping[str, str], name: str, default: list[str] | None = None) -> list[str]:
+    if default is None:
+        default = []
+    value = options.get(name)
+    return value.replace(",", " ").split() if value else default
+
+
+def extract_angularjs(
+    fileobj: Iterable[str | bytes],
+    keywords: Any,
+    comment_tags: Any,
+    options: Mapping[str, str],
+) -> Iterator[ExtractorEntry]:
+    """Extract messages from AngularJS template (HTML) files that use the
+    data-translate directive as per.
+
+    :param fileobj: the file-like object the messages should be extracted from
+    :param keywords: This is a standard parameter so it isaccepted but ignored.
+    :param comment_tags: This is a standard parameter so it is accepted but ignored.
+    :param options: Another standard parameter that is accepted but ignored.
+    :return: an iterator over ``(lineno, funcname, message, comments)`` tuples
+    :rtype: ``iterator``
+    """
+    include_tags = get_option_list(options, "include_tags")
+    include_attributes = get_option_list(options, "include_attributes")
+    allowed_tags = get_option_list(options, "allowed_tags", ["strong", "br", "i"])
+    extract_attribute = options.get("extract_attribute") or "i18n"
+    allowed_attributes_by_tag = {tag: get_option_list(options, "allowed_attributes_" + tag) for tag in allowed_tags}
+    encoding = options.get('encoding', 'utf-8')
+
+    parser = AngularJSGettextHTMLParser(
+        include_tags,
+        include_attributes,
+        extract_attribute,
+        allowed_attributes_by_tag
+    )
+
+    for line in fileobj:
+        if isinstance(line, bytes):
+            line = line.decode(encoding)
+        line = line.replace("&#xa;", "<br>")
+        line = line.replace("&nbsp;", " ")
+        parser.feed(line)
+
+    yield from parser.entries

pybabel_angularjs-1.4.0.dist-info/METADATA

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: pybabel-angularjs
+Version: 1.4.0
+Summary: An AngularJS extractor for Babel
+Author-email: Jaromír Pufler <jaromir.pufler@gmail.com>
+License: Apache Software License
+Project-URL: Homepage, https://github.com/chuckyblack/pybabel-angularjs
+Keywords: angularjs,gettext,babel,i18n,translate
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Internationalization
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: babel
+Dynamic: license-file
+
+# pybabel-angularjs
+
+[![CI](https://github.com/chuckyblack/pybabel-angularjs/actions/workflows/release.yml/badge.svg?branch=master)](https://github.com/chuckyblack/pybabel-angularjs/actions/workflows/release.yml)
+[![PyPI](https://img.shields.io/pypi/v/pybabel-angularjs.svg)](https://pypi.org/project/pybabel-angularjs/)
+
+A [Babel](https://babel.pocoo.org/) message extractor for AngularJS HTML
+templates. It extracts element content and attributes marked for translation,
+including strings containing AngularJS expressions such as `{{ name }}`.
+
+Requires Python 3.12 or newer.
+
+## Installation
+
+```console
+python -m pip install pybabel-angularjs
+```
+
+The package installs the `angularjs` Babel extractor entry point. Add it to a
+Babel mapping file such as `babel.cfg`:
+
+```ini
+[angularjs: **/*.html]
+encoding = utf-8
+```
+
+Then extract messages in the usual way:
+
+```console
+pybabel extract -F babel.cfg -o messages.pot .
+```
+
+## Marking messages
+
+Mark an element's content with `i18n`:
+
+```html
+<div i18n>Hello world!</div>
+<p i18n>Hello {{ name }}!</p>
+```
+
+The value of `i18n`, when present, is included as a comment for translators:
+
+```html
+<h1 i18n="Page heading">Welcome</h1>
+```
+
+Mark an individual attribute by adding the `i18n-` prefix:
+
+```html
+<input placeholder="Your name" i18n-placeholder>
+```
+
+## Configuration
+
+Options are set in the extractor section of the Babel mapping file. Lists can
+be separated by commas or whitespace.
+
+```ini
+[angularjs: **/*.html]
+encoding = utf-8
+include_tags = h1, h2, p
+include_attributes = title, alt, placeholder
+allowed_tags = a, strong, br, i
+allowed_attributes_a = href, target
+```
+
+- `extract_attribute` changes the marker from the default `i18n`, for example
+  to `data-translate`.
+- `include_tags` extracts all content from the listed tags without requiring an
+  explicit marker.
+- `include_attributes` extracts the listed attributes wherever they occur.
+- `allowed_tags` controls which nested HTML tags may appear inside a translated
+  message. The default is `strong, br, i`.
+- `allowed_attributes_<tag>` controls attributes allowed on a nested tag, for
+  example `allowed_attributes_a = href, target`.
+- `encoding` controls template decoding and defaults to `utf-8`.
+
+Use `no-i18n` to exclude an automatically included tag. A `<div no-i18n>`
+excludes its entire subtree. For automatically included attributes, use the
+corresponding marker such as `no-i18n-title`.
+
+## License
+
+Apache License 2.0. The project was heavily inspired by the original
+[shoreware/pybabel-angularjs](https://bitbucket.org/shoreware/pybabel-angularjs).

pybabel_angularjs-1.4.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+pybabel_angularjs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pybabel_angularjs/extractor.py,sha256=9bUQ1P9bBDNIJ0CPNdxn53IGRFKCozk81HjGcqwJYyE,9074
+pybabel_angularjs-1.4.0.dist-info/licenses/LICENSE,sha256=xllut76FgcGL5zbIRvuRc7aezPbvlMUTWJPsVr2Sugg,11358
+pybabel_angularjs-1.4.0.dist-info/METADATA,sha256=hGKE_MZKKxi1oqGbSGZC5G0qDJhLYaFqNjsL5RelTK8,3606
+pybabel_angularjs-1.4.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+pybabel_angularjs-1.4.0.dist-info/entry_points.txt,sha256=W1fNhD_fSj5qkyPo0yNEcpFaMGqua5g8m2-g7Dn4kE8,77
+pybabel_angularjs-1.4.0.dist-info/top_level.txt,sha256=wCxOedmiVkEAjiMotof8_hVoJJ4ahXcZFkCJbSNcdd4,18
+pybabel_angularjs-1.4.0.dist-info/RECORD,,

pybabel_angularjs-1.4.0.dist-info/WHEEL

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

pybabel_angularjs-1.4.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[babel.extractors]
+angularjs = pybabel_angularjs.extractor:extract_angularjs

pybabel_angularjs-1.4.0.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.
+

pybabel_angularjs-1.4.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pybabel_angularjs