messageformat2 0.1.0__tar.gz

messageformat2-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install MF2
+        run: pip install .[dev]
+
+      - name: Lint
+        run: ruff check tests/ messageformat2/ --exclude messageformat2/cli.py
+
+      - name: Test
+        run: pytest --doctest-modules
+
+      - name: Static type checking
+        uses: jakebailey/pyright-action@v2

messageformat2-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+venv/
+.python-version
+__pycache__/
+.coverage
+htmlcov/
+.ruff_cache/
+.pytest_cache/
+*.egg-info/
+
+node_modules/

messageformat2-0.1.0/.readthedocs.yaml

@@ -0,0 +1,19 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: requirements.docs.txt

messageformat2-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contributing to MessageFormat2
+
+You can help improve this project by either opening issues or submitting pull requests for
+
+- bugs
+- differing behaviour between the package and [official specification](https://www.unicode.org/reports/tr35/tr35-72/tr35-messageFormat.html)
+- documentation
+- implementing missing features (e.g. missing options for formatters)
+
+## Dev setup
+
+Clone the repository and then run this command to install the package in editable mode:
+
+```sh
+pip install -e .[dev]
+```
+
+### Running tests
+
+```sh
+pytest --doctest-modules
+```
+
+### Code quality
+
+```sh
+pyright tests/ messageformat2/
+ruff check tests/ messageformat2/
+```

messageformat2-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) European Organization for Nuclear Research (CERN)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

messageformat2-0.1.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.1
+Name: messageformat2
+Version: 0.1.0
+Summary: Python implementation of Unicode MessageFormat 2.0
+Author-email: Tomas Roun <tomas.roun8@gmail.com>
+License: MIT License
+        
+        Copyright (c) European Organization for Nuclear Research (CERN)
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/tomasr8/messageformat2
+Project-URL: Github, https://github.com/tomasr8/messageformat2
+Keywords: i18n,internationalization,localization,messageformat,messageformat 2,cldr,gettext
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Internationalization
+Classifier: Topic :: Software Development :: Localization
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Babel
+Requires-Dist: click
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: uv; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-snapshot; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: mkdocs; extra == "dev"
+Requires-Dist: mkdocstrings[python]; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocstrings[python]; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+
+
+
+# MessageFormat2 [![Documentation Status](https://readthedocs.org/projects/messageformat2/badge/?version=latest)](https://messageformat2.readthedocs.io/en/latest/?badge=latest) [![CI](https://github.com/tomasr8/messageformat2/workflows/CI/badge.svg)](https://github.com/tomasr8/messageformat2/workflows/CI/badge.svg) [![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
+
+This is a Python implementation of the [Unicode Message Format 2.0
+specification](https://www.unicode.org/reports/tr35/tr35-72/tr35-messageFormat.html).
+
+Message Format 2.0 (MF2) is a new iteration of Message Format which aims to be
+more expressive and flexible than both Message Format 1.0 and, in the context of
+Python, gettext.
+
+If you would like to learn more about MF2 itself head over to the [Unicode technical
+specification](https://www.unicode.org/reports/tr35/tr35-72/tr35-messageFormat.html).
+
+## Features
+
+The library includes:
+
+- A message parser and a formatter
+- Several builtin formatters and selectors described by the
+  [spec](https://www.unicode.org/reports/tr35/tr35-72/tr35-messageFormat.html#function-registry)
+  and the possibility to write custom formatters/selectors
+- Helper classes to inspect and transform the message [data
+  model](https://www.unicode.org/reports/tr35/tr35-72/tr35-messageFormat.html#interchange-data-model)
+
+## [Documentation](https://messageformat2.readthedocs.io/en/latest/)
+
+## Installation
+
+Via pip for Python `>= 3.12`
+
+```sh
+pip install messageformat2
+```
+
+## Examples
+
+### Simple messages
+
+```python
+from messageformat2 import format_message
+
+format_message("Hello, {$name}!", {"name": "Alice"})  # -> "Hello, Alice!"
+```
+
+Messages can be reused with different inputs.
+
+```python
+from messageformat2 import Message
+
+message = Message("Hello, {$name}!")
+message.format({"name": "Alice"})  # -> "Hello, Alice!"
+message.format({"name": "Bob"})  # -> "Hello, Bob!"
+```
+
+### Built-in formatters
+
+There are several builtin locale-aware formatters available.
+
+```python
+from datetime import datetime
+from messageformat2 import Message
+
+message = Message("Today's date is {$now :date}")
+now = datetime.now()
+message.format({"now": now}, locale='en_US')
+# -> Today's date is 5/10/2024
+message.format({"now": now}, locale='en_GB')
+# -> Today's date is 10/05/2024
+```
+
+### Plural support
+
+MF2 supports pluralization using built-in or custom selectors.
+
+```python
+from messageformat2 import Message
+
+msg = Message ("""\
+.match {$count :number}
+one {{You have {$count} notification.}}
+*   {{You have {$count} notifications.}}
+""")
+
+msg.format({"count": 42}, locale='en_US') # -> "You have 42 notifications."
+msg.format({"count": 1}, locale='en_US') # -> "You have 1 notification."
+```
+
+Complete documentation is available [here](https://messageformat2.readthedocs.io/en/latest/).

messageformat2-0.1.0/README.md

@@ -0,0 +1,89 @@
+
+
+# MessageFormat2 [![Documentation Status](https://readthedocs.org/projects/messageformat2/badge/?version=latest)](https://messageformat2.readthedocs.io/en/latest/?badge=latest) [![CI](https://github.com/tomasr8/messageformat2/workflows/CI/badge.svg)](https://github.com/tomasr8/messageformat2/workflows/CI/badge.svg) [![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
+
+This is a Python implementation of the [Unicode Message Format 2.0
+specification](https://www.unicode.org/reports/tr35/tr35-72/tr35-messageFormat.html).
+
+Message Format 2.0 (MF2) is a new iteration of Message Format which aims to be
+more expressive and flexible than both Message Format 1.0 and, in the context of
+Python, gettext.
+
+If you would like to learn more about MF2 itself head over to the [Unicode technical
+specification](https://www.unicode.org/reports/tr35/tr35-72/tr35-messageFormat.html).
+
+## Features
+
+The library includes:
+
+- A message parser and a formatter
+- Several builtin formatters and selectors described by the
+  [spec](https://www.unicode.org/reports/tr35/tr35-72/tr35-messageFormat.html#function-registry)
+  and the possibility to write custom formatters/selectors
+- Helper classes to inspect and transform the message [data
+  model](https://www.unicode.org/reports/tr35/tr35-72/tr35-messageFormat.html#interchange-data-model)
+
+## [Documentation](https://messageformat2.readthedocs.io/en/latest/)
+
+## Installation
+
+Via pip for Python `>= 3.12`
+
+```sh
+pip install messageformat2
+```
+
+## Examples
+
+### Simple messages
+
+```python
+from messageformat2 import format_message
+
+format_message("Hello, {$name}!", {"name": "Alice"})  # -> "Hello, Alice!"
+```
+
+Messages can be reused with different inputs.
+
+```python
+from messageformat2 import Message
+
+message = Message("Hello, {$name}!")
+message.format({"name": "Alice"})  # -> "Hello, Alice!"
+message.format({"name": "Bob"})  # -> "Hello, Bob!"
+```
+
+### Built-in formatters
+
+There are several builtin locale-aware formatters available.
+
+```python
+from datetime import datetime
+from messageformat2 import Message
+
+message = Message("Today's date is {$now :date}")
+now = datetime.now()
+message.format({"now": now}, locale='en_US')
+# -> Today's date is 5/10/2024
+message.format({"now": now}, locale='en_GB')
+# -> Today's date is 10/05/2024
+```
+
+### Plural support
+
+MF2 supports pluralization using built-in or custom selectors.
+
+```python
+from messageformat2 import Message
+
+msg = Message ("""\
+.match {$count :number}
+one {{You have {$count} notification.}}
+*   {{You have {$count} notifications.}}
+""")
+
+msg.format({"count": 42}, locale='en_US') # -> "You have 42 notifications."
+msg.format({"count": 1}, locale='en_US') # -> "You have 1 notification."
+```
+
+Complete documentation is available [here](https://messageformat2.readthedocs.io/en/latest/).

messageformat2-0.1.0/docs/builtins.md

@@ -0,0 +1,172 @@
+The default function registry includes these functions
+
+in line with the specification in the CLDR 45 technical preview
+
+### `:string`
+
+#### Formatter
+
+As a formatter, this functions simply call `str(value)`
+
+#### Selector
+
+As a selector, this function simply selects the exact match among the variant keys
+
+```python
+format_message("""\
+.match {$pet :string}
+dog {{I have a dog}}
+cat {{I have a cat}}
+* {{I have a {$pet}}}
+""", {"pet": "cat"})
+# -> "I have a cat"
+```
+
+### `:number`
+
+#### Formatter
+
+- `compactDisplay`
+    - short (default)
+    - long
+- notation
+    - standard
+    - scientific
+    - engineering (not implemented)
+    - compact
+- `numberingSystem`
+    valid Unicode Number System Identifier (default is locale-specific)
+- `signDisplay` (not implemented)
+- `style`
+    - decimal (default)
+    - percent
+- `useGrouping`
+    - auto (default)
+    - always
+    - min2
+- `minimumFractionDigits` (not implemented)
+- `maximumFractionDigits` (not implemented)
+
+#### Selector
+
+The selector takes the same options as the formatter in addition to:
+
+- `select`
+    - plural (default)
+    - ordinal
+    - exact
+
+The selector does exact string comparison with the variant keys but also keyword comparisons.
+
+### `:integer`
+
+#### Formatter
+
+- `numberingSystem`
+    valid Unicode Number System Identifier (default is locale-specific)
+- `signDisplay` (not implemented)
+- `style`
+    - decimal (default)
+    - percent
+- `useGrouping`
+    - auto (default)
+    - always
+    - min2
+- `minimumIntegerDigits` (not implemented)
+- `maximumSignificantDigits` (not implemented)
+
+#### Selector
+
+The selector takes the same options as the formatter in addition to:
+
+- `select`
+    - plural (default)
+    - ordinal
+    - exact
+
+The selector does exact string comparison with the variant keys but also keyword comparisons.
+
+### `:datetime`
+
+The value must either a `datetime` instance or an ISO8601 string that can be parsed using `datetime.fromisoformat`.
+
+#### Formatter
+
+- `Datestyle`
+    - full
+    - long
+    - medium
+    - short (default)
+- `timeStyle` (not implemented)
+- `weekday`:
+    - long
+    - short
+    - narrow
+- `era`:
+    - long
+    - short
+    - narrow
+- `year`:
+    - numeric
+    - 2-digit
+- `month`:
+    - numeric
+    - 2-digit
+- `day`:
+    - numeric
+    - 2-digit
+- `hour`:
+    - numeric
+    - 2-digit
+- `minute`:
+    - numeric
+    - 2-digit
+- `second`:
+    - numeric
+    - 2-digit
+- `fractionalSecondDigits`:
+    - 1
+    - 2
+    - 3
+- `hourCycle`:
+    - h11
+    - h12
+    - h23
+    - h24
+- `timeZoneName` (not implemented)
+
+#### Selector
+
+The `:date` selector is not supported currently as it is not required by MF2
+
+### `:date`
+
+The value must either a `datetime` instance or an ISO8601 string that can be parsed using `datetime.fromisoformat`.
+
+#### Formatter
+
+- `style`
+    - full
+    - long
+    - medium
+    - short (default)
+
+#### Selector
+
+The `:date` selector is not supported currently as it is not required by MF2
+
+### `:time`
+
+The value must either a `datetime.time` instance
+
+#### Formatter
+
+- `style`
+    - full
+    - long
+    - medium
+    - short (default)
+
+#### Selector
+
+The `:time` selector is not supported currently as it is not required by MF2

messageformat2-0.1.0/docs/datamodel.md

@@ -0,0 +1,10 @@
+::: messageformat2.datamodel
+    options:
+      show_root_members_full_path: true
+      show_if_no_docstring: True
+      members_order: source
+      filters:
+      - "!^__"
+      - "!^_Matcher"
+      - "!^_generic_visit"
+      - "!^DataModelValidator"

messageformat2-0.1.0/docs/errors.md

@@ -0,0 +1,4 @@
+::: messageformat2.errors
+    options:
+      members_order: source
+

messageformat2-0.1.0/docs/explanation.md

@@ -0,0 +1,86 @@
+This part of the project documentation focuses on an
+**understanding-oriented** approach. You'll get a
+chance to read about the background of the project,
+as well as reasoning about how it was implemented.
+
+> **Note:** Expand this section by considering the
+> following points:
+
+- Give context and background on your library
+- Explain why you created it
+- Provide multiple examples and approaches of how
+  to work with it
+- Help the reader make connections
+- Avoid writing instructions or technical descriptions
+  here
+
+Invalid syntax
+A complex message cannot start with leading whitespace. Such a message is treated as a simple message by the grammar
+
+## Whitespace
+
+This library implements the [grammar](https://www.unicode.org/reports/tr35/tr35-72/tr35-messageFormat.html#complete-abnf) exactly as specified which includes whitespace.
+According to the grammar, complex messages (messages containing declarations and/or the match block) cannot have a leading whitespace. For example, this message:
+
+```python
+    .match {$count :integer}
+* {{count is {$count}}}
+```
+
+will be parsed as a simple message (message not containing any declarations/match blocks, only patterns `{...}`). The parsing will fail
+because a pattern cannot contain unescaped `{`.
+
+When defining complex messages using multiline strings, don't forget to use a leading `\` to remove the first newline character:
+
+```python
+Message("""\  # <- notice the backslash
+.match {$count: integer}
+* {{count is {$count}}}""")
+```
+
+```python
+Message(""".match {$count: integer}
+* {{count is {$count}}}""")
+```
+
+## Computation model
+
+All expressions are lazily evaluated at the time of use. If the same variable if referenced more than once, it will be evaaluated more than once.
+IF you have formatters/selectors with side effects be careful.
+
+```python
+counter = 0
+
+def formatter_with_side_effect(value, locale, options):
+    nonlocal counter
+    counter +=1
+    return str(value)
+
+msg = Message("\
+.local $foo = {|foo| :side_effect}
+{{{$foo} {$foo}}}
+")
+msg.format(formatters={'side_effect': formatter_with_side_effect})
+print(counter)  # -> 2
+```
+
+## Function composition
+
+Composition of functions is only allowed for the same functions i.e.
+
+```python
+.local $x {42 :integer}
+{{x = {$x :integer}}}
+```
+
+```python
+.local $x {42 :integer}
+{{x = {$x :string}}}
+```
+
+Options are merged together with the later options overwritting any earlier options
+
+```python
+.local $date {|2024-05-10| :date style=short}
+{{date = {$date :date style=full}}}
+```

messageformat2-0.1.0/docs/getting_started.md

@@ -0,0 +1,58 @@
+## Installation
+
+This package is available via `pip` for Python `>= 3.12`:
+
+```sh
+pip install messageformat2
+```
+
+## Simple messages
+
+```python
+from messageformat2 import format_message
+
+format_message("Hello, {$name}!", {"name": "Alice"})  # -> "Hello, Alice!"
+```
+
+Messages can be reused with different inputs.
+
+```python
+from messageformat2 import Message
+
+message = Message("Hello, {$name}!")
+message.format({"name": "Alice"})  # -> "Hello, Alice!"
+message.format({"name": "Bob"})  # -> "Hello, Bob!"
+```
+
+## Built-in formatters
+
+There are several builtin locale-aware [formatters](/builtins) available.
+
+```python
+from datetime import datetime
+from messageformat2 import Message
+
+message = Message("Today's date is {$now :date}")
+now = datetime.now()
+message.format({"now": now}, locale='en_US')
+# -> Today's date is 5/10/2024
+message.format({"now": now}, locale='en_GB')
+# -> Today's date is 10/05/2024
+```
+
+## Plural support
+
+MF2 supports pluralization using built-in or custom selectors.
+
+```python
+from messageformat2 import Message
+
+msg = Message ("""\
+.match {$count :number}
+one {{You have {$count} notification.}}
+*   {{You have {$count} notifications.}}
+""")
+
+msg.format({"count": 42}, locale='en_US') # -> "You have 42 notifications."
+msg.format({"count": 1}, locale='en_US') # -> "You have 1 notification."
+```