Rename TextsProvider to TextProvider

docs/usage/all_in_one_cli.md

@@ -23,7 +23,7 @@ Options:
                                   will connect to the default database
                                   specified in the URI
   --texts TEXT                    Class with texts  [default:
-                                  suppgram.texts.en.EnglishTextsProvider]
+                                  suppgram.texts.en.EnglishTextProvider]
   --telegram-customer-bot-token-file FILE
                                   Path to file storing token for Telegram bot
                                   serving customers. Alternatively,

docs/usage/customizing_texts.md

@@ -1,8 +1,8 @@
 # Customizing texts
 
-Suppgram encapsulates all text generation in [TextsProvider][suppgram.texts.TextsProvider] class.
+Suppgram encapsulates all text generation in [TextProvider][suppgram.texts.TextProvider] class.
 
-::: suppgram.texts.TextsProvider
+::: suppgram.texts.TextProvider
     handler: python
     options:
       show_root_heading: true
@@ -14,24 +14,24 @@ for details.
 
 Suppgram also provides out-of-the-box text pack for English language.
 
-::: suppgram.texts.en.EnglishTextsProvider
+::: suppgram.texts.en.EnglishTextProvider
     handler: python
     options:
       show_root_heading: true
       show_source: false
       heading_level: 2
 
-If you want to customize your texts, you can either implement your own `TextsProvider` or tweak an
+If you want to customize your texts, you can either implement your own `TextProvider` or tweak an
 existing one. For example, let's say we want to hide customer contacts from agents for some privacy reasons.
 Our code would look like the following:
 
 ```python
 # ./mytexts.py
 
-from suppgram.texts.en import EnglishTextsProvider
+from suppgram.texts.en import EnglishTextProvider
 
 
-class MyTextsProvider(EnglishTextsProvider):
+class MyTextProvider(EnglishTextProvider):
     customer_profile_contacts = "📒 Contacts: (hidden)"
 ```
 
@@ -40,16 +40,16 @@ Then we can customize texts provider in all-in-one CLI:
 $ python -m suppgram.cli.all_in_one \
          --sqlalchemy-uri sqlite+aiosqlite:///test.db \
          --telegram-owner-id <your Telegram user ID> \
-         --texts mytexts.MyTextsProvider
+         --texts mytexts.MyTextProvider
 ```
 or via builder:
 ```python
 from suppgram.builder import Builder
 
-from mytexts import MyTextsProvider
+from mytexts import MyTextProvider
 
 
 builder = Builder()
 ...
-builder = builder.with_texts(MyTextsProvider())
+builder = builder.with_texts(MyTextProvider())
 ```

suppgram/backends/local.py

@@ -29,16 +29,16 @@
 from suppgram.helpers import flat_gather
 from suppgram.observer import LocalObservable
 from suppgram.storage import Storage
-from suppgram.texts.en import EnglishTextsProvider
-from suppgram.texts.interface import TextsProvider
+from suppgram.texts.en import EnglishTextProvider
+from suppgram.texts.interface import TextProvider
 
 
 class LocalBackend(BackendInterface):
     def __init__(
         self,
         storage: Storage,
         workplace_managers: List[WorkplaceManager],
-        texts: TextsProvider = EnglishTextsProvider(),
+        texts: TextProvider = EnglishTextProvider(),
     ):
         self._storage = storage
         self._workplace_managers = workplace_managers

suppgram/builder.py

@@ -9,8 +9,8 @@
 from suppgram.frontend import ManagerFrontend, CustomerFrontend, AgentFrontend
 from suppgram.helpers import flat_gather
 from suppgram.storage import Storage
-from suppgram.texts.en import EnglishTextsProvider
-from suppgram.texts.interface import TextsProvider
+from suppgram.texts.en import EnglishTextProvider
+from suppgram.texts.interface import TextProvider
 
 logger = logging.getLogger(__name__)
 
@@ -30,7 +30,7 @@ def __init__(self) -> None:
         self._mongodb_client: Optional[Any] = None
         self._mongodb_database: Optional[Any] = None
 
-        self._texts: Optional[TextsProvider] = None
+        self._texts: Optional[TextProvider] = None
 
         # Helper classes, including implementation-specific:
         self._telegram_app_manager: Optional[Any] = None
@@ -133,8 +133,8 @@ def with_mongodb_storage(
         self._storage = MongoDBStorage(collections=mongodb_collections)
         return self
 
-    def with_texts(self, texts: TextsProvider) -> "Builder":
-        """Configure arbitrary [TextsProvider][suppgram.texts.TextsProvider] instance."""
+    def with_texts(self, texts: TextProvider) -> "Builder":
+        """Configure arbitrary [TextProvider][suppgram.texts.TextProvider] instance."""
         if self._texts is not None:
             raise ValueError(
                 f"can't use {type(texts).__name__} — already instantiated {type(self._texts).__name__}"
@@ -144,7 +144,7 @@ def with_texts(self, texts: TextsProvider) -> "Builder":
         return self
 
     def with_texts_class_path(self, texts_class_path: str) -> "Builder":
-        """Create [TextsProvider][suppgram.texts.TextsProvider] instance of given class.
+        """Create [TextProvider][suppgram.texts.TextProvider] instance of given class.
 
         Assumes that its `__init__` method doesn't require any arguments."""
         if self._texts is not None:
@@ -231,9 +231,9 @@ def _build_storage(self) -> Storage:
             raise NoStorageSpecified()
         return self._storage
 
-    def _build_texts(self) -> TextsProvider:
+    def _build_texts(self) -> TextProvider:
         if self._texts is None:
-            self._texts = EnglishTextsProvider()
+            self._texts = EnglishTextProvider()
         return self._texts
 
     def _build_telegram_app_manager(self) -> Any:

suppgram/cli/all_in_one.py

@@ -40,7 +40,7 @@
 @click.option(
     "--texts",
     "texts_class_path",
-    default="suppgram.texts.en.EnglishTextsProvider",
+    default="suppgram.texts.en.EnglishTextProvider",
     show_default=True,
     help="Class with texts",
 )

suppgram/frontends/shell/customer_frontend.py

@@ -12,7 +12,7 @@
     Message,
 )
 from suppgram.frontend import CustomerFrontend
-from suppgram.texts.interface import TextsProvider
+from suppgram.texts.interface import TextProvider
 
 
 class ShellCustomerFrontend(CustomerFrontend):
@@ -22,7 +22,7 @@ class ShellCustomerFrontend(CustomerFrontend):
     Useful for debug purposes.
     """
 
-    def __init__(self, backend: Backend, texts: TextsProvider):
+    def __init__(self, backend: Backend, texts: TextProvider):
         """
         Arguments:
             backend: used backend instance.
@@ -32,9 +32,7 @@ def __init__(self, backend: Backend, texts: TextsProvider):
         self._backend = backend
         self._texts = texts
 
-        backend.on_new_message_for_customer.add_handler(
-            self._handle_new_message_for_customer_event
-        )
+        backend.on_new_message_for_customer.add_handler(self._handle_new_message_for_customer_event)
 
     async def start(self):
         asyncio.create_task(self._run())
@@ -55,9 +53,7 @@ async def _run(self):
                 ),
             )
 
-    async def _handle_new_message_for_customer_event(
-        self, event: NewMessageForCustomerEvent
-    ):
+    async def _handle_new_message_for_customer_event(self, event: NewMessageForCustomerEvent):
         text = event.message.text
         if event.message.kind == MessageKind.RESOLVED:
             text = self._texts.telegram_customer_conversation_resolved_message

suppgram/frontends/telegram/agent_frontend.py

@@ -59,7 +59,7 @@
     TelegramMessage,
 )
 from suppgram.helpers import flat_gather
-from suppgram.texts.interface import TextsProvider, Format
+from suppgram.texts.interface import TextProvider, Format
 
 logger = logging.getLogger(__name__)
 
@@ -76,7 +76,7 @@ def __init__(
         backend: Backend,
         helper: TelegramHelper,
         storage: TelegramStorage,
-        texts: TextsProvider,
+        texts: TextProvider,
     ):
         self._backend = backend
         self._helper = helper

suppgram/frontends/telegram/customer_frontend.py

@@ -30,7 +30,7 @@
     make_customer_diff,
 )
 from suppgram.frontends.telegram.storage import TelegramStorage, TelegramMessageKind
-from suppgram.texts.interface import TextsProvider
+from suppgram.texts.interface import TextProvider
 
 logger = logging.getLogger(__name__)
 
@@ -51,7 +51,7 @@ def __init__(
         app_manager: TelegramAppManager,
         backend: Backend,
         storage: TelegramStorage,
-        texts: TextsProvider,
+        texts: TextProvider,
     ):
         """
         This constructor should not be used directly; use [Builder][suppgram.builder.Builder] instead.

suppgram/frontends/telegram/manager_frontend.py

@@ -54,7 +54,7 @@
     TelegramMessage,
 )
 from suppgram.helpers import flat_gather
-from suppgram.texts.interface import TextsProvider
+from suppgram.texts.interface import TextProvider
 
 logger = logging.getLogger(__name__)
 
@@ -71,7 +71,7 @@ def __init__(
         backend: Backend,
         helper: TelegramHelper,
         storage: TelegramStorage,
-        texts: TextsProvider,
+        texts: TextProvider,
     ):
         self._backend = backend
         self._helper = helper

suppgram/texts/__init__.py

@@ -1 +1 @@
-from .interface import TextsProvider  # noqa
+from .interface import TextProvider  # noqa

suppgram/texts/en.py

@@ -6,12 +6,12 @@
     MessageKind,
     Agent,
 )
-from suppgram.texts.interface import TextsProvider, Text, Format
+from suppgram.texts.interface import TextProvider, Text, Format
 
 logger = logging.getLogger(__name__)
 
 
-class EnglishTextsProvider(TextsProvider):
+class EnglishTextProvider(TextProvider):
     telegram_customer_unsupported_message_content = (
         "😞 Sorry, this kind of content is not supported right now. "
         "Support agent will not see this message."

suppgram/texts/interface.py

@@ -50,7 +50,7 @@ def parse_mode(self) -> Optional[str]:
         return self.format.convert_to_parse_mode()
 
 
-class TextsProvider:
+class TextProvider:
     """Provides static texts and functions to compose dynamic texts where necessary."""
 
     telegram_customer_unsupported_message_content: str

tests/frontends/telegram/conftest.py

@@ -34,7 +34,7 @@
 from suppgram.frontends.telegram.workplace_manager import TelegramWorkplaceManager
 from suppgram.storage import Storage
 from suppgram.storages.inmemory import InMemoryStorage
-from suppgram.texts.en import EnglishTextsProvider
+from suppgram.texts.en import EnglishTextProvider
 
 
 @pytest.fixture
@@ -164,7 +164,7 @@ async def customer_frontend(
         app_manager=app_manager,
         backend=backend,
         storage=telegram_storage,
-        texts=EnglishTextsProvider(),
+        texts=EnglishTextProvider(),
     )
     await frontend.initialize()
     return frontend
@@ -187,7 +187,7 @@ async def agent_frontend(
         backend=backend,
         helper=telegram_helper,
         storage=telegram_storage,
-        texts=EnglishTextsProvider(),
+        texts=EnglishTextProvider(),
     )
     await frontend.initialize()
     return frontend