Refactoring

Make FluentBundle module optional

Author: spookylukey

docs/usage.rst

@@ -27,7 +27,7 @@ Once you have some FTL files, you can generate translations using the
 
 .. code-block:: python
 
-    >>> from fluent_compiler import FluentBundle
+    >>> from fluent_compiler.bundle import FluentBundle
 
 You pass a list of locales to the constructor - the first being the
 desired locale, with fallbacks after that:

src/fluent_compiler/__init__.py

@@ -1,75 +1 @@
 from __future__ import absolute_import, unicode_literals
-
-import attr
-
-from .compiler import compile_messages
-from .utils import ATTRIBUTE_SEPARATOR, TERM_SIGIL
-
-
-class FluentBundle(object):
-    """
-    A FluentBundle is a single-language store of translations.  It can
-    format translation units (entities) to strings.
-
-    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. See the documentation of
-    the Fluent syntax for more information.
-
-    """
-    def __init__(self, locale, resources, functions=None, use_isolating=True, escapers=None):
-        self.locale = locale
-        compiled_ftl = compile_messages(
-            resources,
-            locale,
-            use_isolating=use_isolating,
-            functions=functions,
-            escapers=escapers)
-        self._compiled_messages = compiled_ftl.message_functions
-        self._compilation_errors = compiled_ftl.errors
-
-    @classmethod
-    def from_string(cls, locale, text, functions=None, use_isolating=True, escapers=None):
-        return cls(
-            locale,
-            [FtlResource(text)],
-            use_isolating=use_isolating,
-            functions=functions,
-            escapers=escapers
-        )
-
-    @classmethod
-    def from_files(cls, locale, filenames, functions=None, use_isolating=True, escapers=None):
-        return cls(
-            locale,
-            [FtlResource.from_file(f) for f in filenames],
-            use_isolating=use_isolating,
-            functions=functions,
-            escapers=escapers
-        )
-
-    def has_message(self, message_id):
-        if message_id.startswith(TERM_SIGIL) or ATTRIBUTE_SEPARATOR in message_id:
-            return False
-        return message_id in self._compiled_messages
-
-    def format(self, message_id, args=None):
-        errors = []
-        return self._compiled_messages[message_id](args, errors), errors
-
-    def check_messages(self):
-        return self._compilation_errors
-
-
-@attr.s
-class FtlResource(object):
-    '''
-    Represents an (unparsed) FTL file (contents and optional filename)
-    '''
-    text = attr.ib()
-    filename = attr.ib(default=None)
-
-    @classmethod
-    def from_file(cls, filename):
-        return cls(text=open(filename).read(), filename=filename)

src/fluent_compiler/bundle.py

@@ -0,0 +1,60 @@
+from __future__ import absolute_import, unicode_literals
+
+from .compiler import compile_messages, FtlResource
+from .utils import ATTRIBUTE_SEPARATOR, TERM_SIGIL
+
+
+class FluentBundle(object):
+    """
+    A FluentBundle is a single-language store of translations.  It can
+    format translation units (entities) to strings.
+
+    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. See the documentation of
+    the Fluent syntax for more information.
+
+    """
+    def __init__(self, locale, resources, functions=None, use_isolating=True, escapers=None):
+        self.locale = locale
+        compiled_ftl = compile_messages(
+            resources,
+            locale,
+            use_isolating=use_isolating,
+            functions=functions,
+            escapers=escapers)
+        self._compiled_messages = compiled_ftl.message_functions
+        self._compilation_errors = compiled_ftl.errors
+
+    @classmethod
+    def from_string(cls, locale, text, functions=None, use_isolating=True, escapers=None):
+        return cls(
+            locale,
+            [FtlResource.from_string(text)],
+            use_isolating=use_isolating,
+            functions=functions,
+            escapers=escapers
+        )
+
+    @classmethod
+    def from_files(cls, locale, filenames, functions=None, use_isolating=True, escapers=None):
+        return cls(
+            locale,
+            [FtlResource.from_file(f) for f in filenames],
+            use_isolating=use_isolating,
+            functions=functions,
+            escapers=escapers
+        )
+
+    def has_message(self, message_id):
+        if message_id.startswith(TERM_SIGIL) or ATTRIBUTE_SEPARATOR in message_id:
+            return False
+        return message_id in self._compiled_messages
+
+    def format(self, message_id, args=None):
+        errors = []
+        return self._compiled_messages[message_id](args, errors), errors
+
+    def check_messages(self):
+        return self._compilation_errors

src/fluent_compiler/compiler.py

@@ -57,6 +57,23 @@
 PROPERTY_EXTERNAL_ARG = 'PROPERTY_EXTERNAL_ARG'
 
 
+@attr.s
+class FtlResource(object):
+    '''
+    Represents an (unparsed) FTL file (contents and optional filename)
+    '''
+    text = attr.ib()
+    filename = attr.ib(default=None)
+
+    @classmethod
+    def from_string(cls, text):
+        return cls(text)
+
+    @classmethod
+    def from_file(cls, filename):
+        return cls(text=open(filename).read(), filename=filename)
+
+
 @attr.s
 class CurrentEnvironment(object):
     # The parts of CompilerEnvironment that we want to mutate (and restore)

tests/format/test_arguments.py

@@ -2,7 +2,7 @@
 
 import unittest
 
-from fluent_compiler import FluentBundle
+from fluent_compiler.bundle import FluentBundle
 from fluent_compiler.errors import FluentReferenceError
 
 from ..utils import dedent_ftl

tests/format/test_attributes.py

@@ -2,7 +2,7 @@
 
 import unittest
 
-from fluent_compiler import FluentBundle
+from fluent_compiler.bundle import FluentBundle
 from fluent_compiler.errors import FluentReferenceError
 
 from ..utils import dedent_ftl

tests/format/test_builtins.py

@@ -4,7 +4,7 @@
 from datetime import date, datetime
 from decimal import Decimal
 
-from fluent_compiler import FluentBundle
+from fluent_compiler.bundle import FluentBundle
 from fluent_compiler.errors import FluentReferenceError
 from fluent_compiler.types import fluent_date, fluent_number
 

tests/format/test_escapers.py

@@ -8,7 +8,7 @@
 from markdown import markdown
 from markupsafe import Markup, escape
 
-from fluent_compiler import FluentBundle
+from fluent_compiler.bundle import FluentBundle
 
 from ..utils import dedent_ftl
 

tests/format/test_functions.py

@@ -4,7 +4,7 @@
 
 import six
 
-from fluent_compiler import FluentBundle
+from fluent_compiler.bundle import FluentBundle
 from fluent_compiler.errors import FluentReferenceError
 from fluent_compiler.types import FluentNone, fluent_number
 

tests/format/test_isolating.py

@@ -2,7 +2,7 @@
 
 import unittest
 
-from fluent_compiler import FluentBundle
+from fluent_compiler.bundle import FluentBundle
 
 from ..utils import dedent_ftl
 

tests/format/test_parameterized_terms.py

@@ -2,7 +2,7 @@
 
 import unittest
 
-from fluent_compiler import FluentBundle
+from fluent_compiler.bundle import FluentBundle
 from fluent_compiler.errors import FluentFormatError, FluentReferenceError
 
 from ..utils import dedent_ftl

tests/format/test_placeables.py

@@ -2,7 +2,7 @@
 
 import unittest
 
-from fluent_compiler import FluentBundle
+from fluent_compiler.bundle import FluentBundle
 from fluent_compiler.errors import FluentCyclicReferenceError, FluentReferenceError
 
 from ..utils import dedent_ftl

tests/format/test_primitives.py

@@ -5,7 +5,7 @@
 
 import six
 
-from fluent_compiler import FluentBundle
+from fluent_compiler.bundle import FluentBundle
 
 from ..utils import dedent_ftl
 

tests/format/test_select_expression.py

@@ -2,7 +2,7 @@
 
 import unittest
 
-from fluent_compiler import FluentBundle
+from fluent_compiler.bundle import FluentBundle
 from fluent_compiler.errors import FluentReferenceError
 
 from ..utils import dedent_ftl

tests/test_bundle.py

@@ -4,7 +4,7 @@
 import traceback
 import unittest
 
-from fluent_compiler import FluentBundle, FtlResource
+from fluent_compiler.bundle import FluentBundle, FtlResource
 from fluent_compiler.errors import FluentDuplicateMessageId, FluentJunkFound, FluentReferenceError
 from fluent_compiler.types import FluentNumber
 

tests/test_compiler.py

@@ -4,8 +4,7 @@
 
 from markupsafe import Markup, escape
 
-from fluent_compiler import FtlResource
-from fluent_compiler.compiler import compile_messages
+from fluent_compiler.compiler import compile_messages, FtlResource
 from fluent_compiler.errors import FluentCyclicReferenceError, FluentFormatError, FluentReferenceError
 from fluent_compiler.utils import SimpleNamespace
 

tools/benchmarks/compiler.py

@@ -7,7 +7,7 @@
 import subprocess
 import sys
 
-from fluent_compiler import FluentBundle
+from fluent_compiler.bundle import FluentBundle
 
 this_file = os.path.abspath(__file__)
 this_dir = os.path.dirname(this_file)

tools/benchmarks/fluent_benchmark.py

@@ -6,9 +6,8 @@
 import sys
 
 import pytest
-import six
 
-from fluent_compiler import FluentBundle
+from fluent_compiler.bundle import FluentBundle
 
 FTL_CONTENT = """
 one = One
@@ -66,5 +65,5 @@ def test_imports():
             ]
             for k in fluent_deps:
                 del sys.modules[k]
-            from fluent_compiler import FluentBundle  # noqa
+            from fluent_compiler.bundle import FluentBundle  # noqa
         benchmark(test_imports)

tools/benchmarks/gettext_comparisons.py

@@ -12,7 +12,7 @@
 import six
 from fluent.runtime import FluentBundle as InterpretingFluentBundle
 
-from fluent_compiler import FluentBundle as CompilingFluentBundle
+from fluent_compiler.bundle import FluentBundle as CompilingFluentBundle
 
 this_file = os.path.abspath(__file__)
 this_dir = os.path.dirname(this_file)