Change API so variables are passed in as an argument

Although this is slightly more verbose, it gives us better opportunities
for backward-compatibility if we choose to add new options to
`get_translation` later. The name 'variables' is taken from the official
Fluent docs https://projectfluent.org/fluent/guide/variables.html

Author: seddonym

README.md

@@ -40,8 +40,8 @@ bundle = rustfluent.Bundle(
 # Fetch a translation
 assert bundle.get_translation("hello-world") == "Hello World"
 
-# Fetch a translation that takes a keyword argument
-assert bundle.get_translation("hello-user", user="Bob") == "Hello, \u2068Bob\u2069"
+# Fetch a translation that includes variables
+assert bundle.get_translation("hello-user", variables={"user": "Bob"}) == "Hello, \u2068Bob\u2069"
 ```
 
 The Unicode characters around "Bob" in the above example are for

src/lib.rs

@@ -47,11 +47,11 @@ impl Bundle {
         Ok(Self { bundle })
     }
 
-    #[pyo3(signature = (identifier, **kwargs))]
+    #[pyo3(signature = (identifier, variables=None))]
     pub fn get_translation(
         &self,
         identifier: &str,
-        kwargs: Option<&Bound<'_, PyDict>>,
+        variables: Option<&Bound<'_, PyDict>>,
     ) -> PyResult<String> {
         let msg = match self.bundle.get_message(identifier) {
             Some(m) => m,
@@ -71,9 +71,9 @@ impl Bundle {
 
         let mut args = FluentArgs::new();
 
-        if let Some(kwargs) = kwargs {
-            for kwarg in kwargs {
-                args.set(kwarg.0.to_string(), kwarg.1.to_string());
+        if let Some(variables) = variables {
+            for variable in variables {
+                args.set(variable.0.to_string(), variable.1.to_string());
             }
         }
 

src/rustfluent.pyi

@@ -1,3 +1,3 @@
 class Bundle:
     def __init__(self, language: str, ftl_filenames: list[str]) -> None: ...
-    def get_translation(self, identifier: str, **kwargs: str) -> str: ...
+    def get_translation(self, identifier: str, variables: dict[str, str] | None = None) -> str: ...

tests/test_python_interface.py

@@ -25,7 +25,9 @@ def test_en_basic_with_named_arguments():
 
 def test_en_with_args():
     bundle = fluent.Bundle("en", [str(data_dir / "en.ftl")])
-    assert bundle.get_translation("hello-user", user="Bob") == "Hello, \u2068Bob\u2069"
+    assert (
+        bundle.get_translation("hello-user", variables={"user": "Bob"}) == "Hello, \u2068Bob\u2069"
+    )
 
 
 def test_fr_basic():
@@ -35,7 +37,10 @@ def test_fr_basic():
 
 def test_fr_with_args():
     bundle = fluent.Bundle("fr", [str(data_dir / "fr.ftl")])
-    assert bundle.get_translation("hello-user", user="Bob") == "Bonjour, \u2068Bob\u2069!"
+    assert (
+        bundle.get_translation("hello-user", variables={"user": "Bob"})
+        == "Bonjour, \u2068Bob\u2069!"
+    )
 
 
 def test_new_overwrites_old():
@@ -44,13 +49,16 @@ def test_new_overwrites_old():
         [str(data_dir / "fr.ftl"), str(data_dir / "en_hello.ftl")],
     )
     assert bundle.get_translation("hello-world") == "Hello World"
-    assert bundle.get_translation("hello-user", user="Bob") == "Bonjour, \u2068Bob\u2069!"
+    assert (
+        bundle.get_translation("hello-user", variables={"user": "Bob"})
+        == "Bonjour, \u2068Bob\u2069!"
+    )
 
 
 def test_id_not_found():
     bundle = fluent.Bundle("fr", [str(data_dir / "fr.ftl")])
     with pytest.raises(ValueError):
-        bundle.get_translation("missing", user="Bob")
+        bundle.get_translation("missing", variables={"user": "Bob"})
 
 
 def test_file_not_found():