Created fluent.bundle as namespace package

Author: spookylukey

.gitignore

@@ -2,3 +2,5 @@
 *.pyc
 .eggs/
 fluent.egg-info/
+fluent_syntax.egg-info/
+fluent_bundle.egg-info/

.travis.yml

@@ -9,6 +9,7 @@ python:
   - "nightly"
 env:
   - PACKAGE=fluent-syntax
+  - PACKAGE=fluent-bundle
 install: pip install tox-travis
 script: cd $PACKAGE; tox
 notifications:

README.md

@@ -39,20 +39,20 @@ Usage
 -----
 
 To generate translations from this Python libary, you start with the
-`MessageContext` class:
+`FluentBundle` class:
 
-    >>> from fluent.context import MessageContext
+    >>> from fluent.bundle import FluentBundle
 
 You pass a list of locales to the constructor - the first being the desired
 locale, with fallbacks after that:
 
-    >>> context = MessageContext(["en-US"])
+    >>> bundle = FluentBundle(["en-US"])
 
 
 You must then add messages. These would normally come from a `.ftl` file stored
 on disk, here we will just add them directly:
 
-    >>> context.add_messages("""
+    >>> bundle.add_messages("""
     ... welcome = Welcome to this great app!
     ... greet-by-name = Hello, { $name }!
     ... """)
@@ -64,17 +64,17 @@ implementation tries hard to recover from any formatting errors and generate the
 most human readable representation of the value. The `format` method therefore
 returns a tuple containing `(translated string, errors)`, as below.
 
-    >>> translated, errs = context.format('welcome')
+    >>> translated, errs = bundle.format('welcome')
     >>> translated
     "Welcome to this great app!"
     >>> errs
     []
 
-    >>> translated, errs = context.format('greet-by-name', {'name': 'Jane'})
+    >>> translated, errs = bundle.format('greet-by-name', {'name': 'Jane'})
     >>> translated
     'Hello, \u2068Jane\u2069!'
 
-    >>> translated, errs = context.format('greet-by-name', {})
+    >>> translated, errs = bundle.format('greet-by-name', {})
     >>> translated
     'Hello, \u2068name\u2069!'
     >>> errs
@@ -85,7 +85,7 @@ are Unicode bidi isolation characters that help to ensure that the interpolated
 strings are handled correctly in the situation where the text direction of the
 substitution might not match the text direction of the localized text. These
 characters can be disabled if you are sure that is not possible for your app by
-passing `use_isolating=False` to the `MessageContext` constructor.
+passing `use_isolating=False` to the `FluentBundle` constructor.
 
 Python 2
 --------
@@ -105,23 +105,23 @@ Numbers
 When rendering translations, Fluent passes any numeric arguments (int or float)
 through locale-aware formatting functions:
 
-    >>> context.add_messages("show-total-points = You have { $points } points.")
-    >>> val, errs = context.format("show-total-points", {'points': 1234567})
+    >>> bundle.add_messages("show-total-points = You have { $points } points.")
+    >>> val, errs = bundle.format("show-total-points", {'points': 1234567})
     >>> val
     'You have 1,234,567 points.'
 
 
 You can specify your own formatting options on the arguments passed in by
 wrapping your numeric arguments with `fluent.types.fluent_number`:
 
-    >>> from fluent.types import fluent_number
+    >>> from fluent.bundle.types import fluent_number
     >>> points = fluent_number(1234567, useGrouping=False)
-    >>> context.format("show-total-points", {'points': points})[0]
+    >>> bundle.format("show-total-points", {'points': points})[0]
     'You have 1234567 points.'
 
     >>> amount = fluent_number(1234.56, style="currency", currency="USD")
-    >>> context.add_messages("your-balance = Your balance is { $amount }")
-    >>> context.format("your-balance", {'amount': amount})[0]
+    >>> bundle.add_messages("your-balance = Your balance is { $amount }")
+    >>> bundle.format("your-balance", {'amount': amount})[0]
     'Your balance is $1,234.56'
 
 Thee options available are defined in the Fluent spec for
@@ -136,14 +136,14 @@ Python `dateime.datetime` and `datetime.date` objects are also passed through
 locale aware functions:
 
     >>> from datetime import date
-    >>> context.add_messages("today-is = Today is { $today }")
-    >>> val, errs = context.format("today-is", {"today": date.today() })
+    >>> bundle.add_messages("today-is = Today is { $today }")
+    >>> val, errs = bundle.format("today-is", {"today": date.today() })
     >>> val
     'Today is Jun 16, 2018'
 
 You can explicitly call the `DATETIME` builtin to specify options:
 
-    >>> context.add_messages('today-is = Today is { DATETIME($today, dateStyle: "short") }')
+    >>> bundle.add_messages('today-is = Today is { DATETIME($today, dateStyle: "short") }')
 
 See the [DATETIME
 docs](https://projectfluent.org/fluent/guide/functions.html#datetime). However,
@@ -153,12 +153,12 @@ currently the only supported options to `DATETIME` are:
 * `dateStyle` and `timeStyle` which are [proposed
   additions](https://github.com/tc39/proposal-ecma402-datetime-style) to the ECMA i18n spec.
 
-To specify options from Python code, use `fluent.types.fluent_date`:
+To specify options from Python code, use `fluent.bundle.types.fluent_date`:
 
-    >>> from fluent.types import fluent_date
+    >>> from fluent.bundle.types import fluent_date
     >>> today = date.today()
     >>> short_today = fluent_date(today, dateStyle='short')
-    >>> val, errs = context.format("today-is", {"today": short_today })
+    >>> val, errs = bundle.format("today-is", {"today": short_today })
     >>> val
     'Today is 6/17/18'
 
@@ -180,8 +180,8 @@ You can also specify timezone for displaying `datetime` objects in two ways:
         >>> utcnow
         datetime.datetime(2018, 6, 17, 12, 15, 5, 677597)
 
-        >>> context.add_messages("now-is = Now is { $now }")
-        >>> val, errs = context.format("now-is",
+        >>> bundle.add_messages("now-is = Now is { $now }")
+        >>> val, errs = bundle.format("now-is",
         ...    {"now": fluent_date(utcnow,
         ...                        timeZone="Europe/Moscow",
         ...                        dateStyle="medium",
@@ -194,7 +194,7 @@ Custom functions
 ----------------
 
 You can add functions to the ones available to FTL authors by passing
-a `functions` dictionary to the `MessageContext` constructor:
+a `functions` dictionary to the `FluentBundle` constructor:
 
 
     >>> import platform
@@ -204,24 +204,24 @@ a `functions` dictionary to the `MessageContext` constructor:
     ...            'Darwin': 'mac',
     ...            'Windows': 'windows'}.get(platform.system(), 'other')
 
-    >>> context = MessageContext(['en-US'], functions={'OS': os_name})
-    >>> context.add_messages("""
+    >>> bundle = FluentBundle(['en-US'], functions={'OS': os_name})
+    >>> bundle.add_messages("""
     ... welcome = { OS() ->
     ...    [linux]    Welcome to Linux
     ...    [mac]      Welcome to Mac
     ...    [windows]  Welcome to Windows
     ...   *[other]    Welcome
     ...   }
     ... """)
-    >>> print(context.format('welcome')[0]
+    >>> print(bundle.format('welcome')[0]
     Welcome to Linux
 
 These functions can accept positioal and keyword arguments (like the `NUMBER`
 and `DATETIME` builtins), and in this case must accept the following types of
 arguments:
 
 * unicode strings (i.e. `unicode` on Python 2, `str` on Python 3)
-* `fluent.types.FluentType` subclasses, namely:
+* `fluent.bundle.types.FluentType` subclasses, namely:
   * `FluentNumber` - `int`, `float` or `Decimal` objects passed in externally,
     or expressed as literals, are wrapped in these. Note that these objects also
     subclass builtin `int`, `float` or `Decimal`, so can be used as numbers in

fluent-bundle/fluent/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__('pkgutil').extend_path(__path__, __name__)

fluent/context.py fluent-bundle/fluent/bundle/__init__.pyfluent/context.py renamed to fluent-bundle/fluent/bundle/__init__.py

@@ -4,19 +4,20 @@
 import babel.numbers
 import babel.plural
 
+from fluent.syntax import FluentParser
+from fluent.syntax.ast import Message, Term
+
 from .builtins import BUILTINS
 from .resolver import resolve
-from .syntax import FluentParser
-from .syntax.ast import Message, Term
 
 
-class MessageContext(object):
+class FluentBundle(object):
     """
     Message contexts are single-language stores of translations.  They are
     responsible for parsing translation resources in the Fluent syntax and can
     format translation units (entities) to strings.
 
-    Always use `MessageContext.format` to retrieve translation units from
+    Always use `FluentBundle.format` to retrieve translation units from
     a context.  Translations can contain references to other entities or
     external arguments, conditional logic in form of select expressions, traits
     which describe their grammatical features, and can use Fluent builtins.

fluent/builtins.py fluent-bundle/fluent/bundle/builtins.pyfluent/builtins.py renamed to fluent-bundle/fluent/bundle/builtins.py

@@ -6,10 +6,13 @@
 import attr
 import six
 
+from fluent.syntax.ast import (AttributeExpression, CallExpression, Message,
+                               MessageReference, NumberLiteral, Pattern,
+                               Placeable, SelectExpression, StringLiteral, Term,
+                               TermReference, TextElement, VariableReference,
+                               VariantExpression, VariantList, Identifier)
+
 from .errors import FluentCyclicReferenceError, FluentReferenceError
-from .syntax.ast import (AttributeExpression, CallExpression, Message, MessageReference, NumberLiteral,
-                         Pattern, Placeable, SelectExpression, StringLiteral, Term, TermReference, TextElement,
-                         VariableReference, VariantExpression, VariantList, Identifier)
 from .types import FluentDateType, FluentNone, FluentNumber, fluent_date, fluent_number
 from .utils import numeric_to_native
 
@@ -45,7 +48,7 @@ class ResolverEnvironment(object):
 
 def resolve(context, message, args, errors=None):
     """
-    Given a MessageContext, a Message instance and some arguments,
+    Given a FluentBundle, a Message instance and some arguments,
     resolve the message to a string.
 
     This is the normal entry point for this module.