Configure TxNative as library

According to https://www.kbairak.net/programming/python/2020/09/16/global-singleton-vs-instance-for-libraries.html

Author: Konstantinos Bairaktaris

tests/native/core/test_core.py

@@ -52,7 +52,7 @@ class TestNative(object):
 
     def _get_tx(self, **kwargs):
         mytx = TxNative()
-        mytx.init(['en', 'el'], 'cds_token', **kwargs)
+        mytx.setup(languages=['en', 'el'], token='cds_token', **kwargs)
         return mytx
 
     @patch('transifex.native.core.StringRenderer.render')

tests/native/core/test_daemon.py

@@ -10,7 +10,9 @@ class TestFetchingDaemon(object):
     @patch('transifex.native.daemon.tx')
     def test_daemon_starts(self, patched_tx):
         tx = TxNative()
-        tx.init(['en', 'el'], 'some:token', 'https://some.host')
+        tx.setup(languages=['en', 'el'],
+                 token='some:token',
+                 cds_host='https://some.host')
 
         # the `interval` we will be using
         interval = 1
@@ -41,7 +43,9 @@ def test_daemon_exception(self, patched_logger, patched_tx):
             'Something went wrong')
 
         tx = TxNative()
-        tx.init(['en', 'el'], 'some:token', 'https://some.host')
+        tx.setup(languages=['en', 'el'],
+                 token='some:token',
+                 cds_host='https://some.host')
 
         daemon = DaemonicThread()
 

tests/native/core/test_init.py

@@ -1,4 +1,3 @@
-from transifex import native
 from transifex.native import tx as _tx
 from transifex.native.rendering import PseudoTranslationPolicy
 
@@ -7,10 +6,10 @@ class TestModuleInit(object):
     """Test __init__.py of root native module."""
 
     def test_init_uses_given_params(self):
-        native.init(
-            'mytoken', ['lang1', 'lang2'], cds_host='myhost',
-            missing_policy=PseudoTranslationPolicy(),
-        )
+        _tx.setup(token='mytoken',
+                  languages=['lang1', 'lang2'],
+                  cds_host='myhost',
+                  missing_policy=PseudoTranslationPolicy())
         assert _tx._cds_handler.token == 'mytoken'
         assert _tx._cds_handler.host == 'myhost'
         assert _tx._languages == ['lang1', 'lang2']

transifex/native/__init__.py

@@ -1,32 +1,5 @@
 from transifex.native.core import TxNative
 
 
-def init(
-    token, languages, secret=None,
-    cds_host=None, missing_policy=None,
-    error_policy=None
-):
-    """Initialize the framework.
-
-    :param list languages: A list of language codes for the languages
-        the application is localized into
-    :param str token: the API token to use for connecting to the CDS
-    :param str secret: the additional secret required for pushing translations
-    :param str cds_host: an optional host for the Content Delivery Service,
-        defaults to the host provided by Transifex
-    :param AbstractRenderingPolicy missing_policy: an optional policy to use
-        for returning strings when a translation is missing
-    :param AbstractErrorPolicy error_policy: an optional policy to use
-        for defining how to handle translation rendering errors
-    """
-    tx.init(
-        languages,
-        token,
-        secret=secret,
-        cds_host=cds_host,
-        missing_policy=missing_policy,
-        error_policy=error_policy
-    )
-
-
 tx = TxNative()
+t = tx.translate

transifex/native/core.py

@@ -14,21 +14,17 @@ class TxNative(object):
     """The main class of the framework, responsible for orchestrating all
     behavior."""
 
-    def __init__(self):
-        # The class uses an untypical initialization scheme, defining
-        # an init() method, instead of initializing inside the constructor
-        # This is necessary for allowing it to be initialized by its clients
-        # with proper arguments, while at the same time being very easy
-        # to import and use a single "global" instance
-        self._cache = None
+    def __init__(self, **kwargs):
         self._languages = []
-        self._missing_policy = None
-        self._cds_handler = None
+        self._missing_policy = SourceStringPolicy()
+        self._cds_handler = CDSHandler()
+        self._cache = MemoryCache()
+        self._error_policy = SourceStringErrorPolicy()
 
-    def init(
-        self, languages, token, secret=None, cds_host=None,
-        missing_policy=None, error_policy=None
-    ):
+        self.setup(**kwargs)
+
+    def setup(self, languages=None, token=None, secret=None, cds_host=None,
+              missing_policy=None, error_policy=None):
         """Create an instance of the core framework class.
 
         Also warms up the cache by fetching the translations from the CDS.
@@ -45,13 +41,17 @@ def init(
         :param AbstractErrorPolicy error_policy: an optional policy
             to determine how to handle rendering errors
         """
-        self._languages = languages
-        self._cache = MemoryCache()
-        self._missing_policy = missing_policy or SourceStringPolicy()
-        self._error_policy = error_policy or SourceStringErrorPolicy()
-        self._cds_handler = CDSHandler(configured_languages=self._languages,
-                                       token=token, secret=secret,
-                                       host=cds_host)
+        if languages is not None:
+            self._languages = languages
+        if missing_policy is not None:
+            self._missing_policy = missing_policy
+        if error_policy is not None:
+            self._error_policy = error_policy
+
+        self._cds_handler.setup(configured_languages=languages,
+                                token=token,
+                                secret=secret,
+                                host=cds_host)
 
     def translate(
         self, source_string, language_code, is_source=False,

transifex/native/django/apps.py

@@ -5,7 +5,7 @@
 from django.apps import AppConfig
 from django.core.signals import request_finished
 from django.utils.translation import to_locale
-from transifex.native import init, tx
+from transifex.native import tx
 from transifex.native.daemon import daemon
 from transifex.native.django import settings as native_settings
 from transifex.native.rendering import (parse_error_policy,
@@ -77,14 +77,12 @@ def ready(self):
         error_policy = parse_error_policy(
             native_settings.TRANSIFEX_ERROR_POLICY
         )
-        init(
-            native_settings.TRANSIFEX_TOKEN,
-            languages,
-            secret=native_settings.TRANSIFEX_SECRET,
-            cds_host=native_settings.TRANSIFEX_CDS_HOST,
-            missing_policy=missing_policy,
-            error_policy=error_policy
-        )
+        tx.setup(token=native_settings.TRANSIFEX_TOKEN,
+                 languages=languages,
+                 secret=native_settings.TRANSIFEX_SECRET,
+                 cds_host=native_settings.TRANSIFEX_CDS_HOST,
+                 missing_policy=missing_policy,
+                 error_policy=error_policy)
 
         if fetch_translations:
             logger.info(