python-intl 0.6.0__tar.gz → 0.7.1__tar.gz

{python_intl-0.6.0 → python_intl-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-intl
-Version: 0.6.0
+Version: 0.7.1
 Summary: Python implementation of the Intl JavaScript API
 Author: David Danier
 Author-email: David Danier <david.danier@gmail.com>
@@ -87,6 +87,20 @@ formatter.format_range(datetime, datetime_till)
 
 ### `Intl.Collator`
 
+#### Example usage
+
+```python
+import python_intl as Intl
+
+collator = Intl.Collator("de-DE", {"numeric": True})
+collator.compare("10", "9")
+# Result = 1, which means 9 comes before 10
+
+# You can also use sorted, although this is not available in JavaScript
+collator.sorted(["10", "9"])
+# Result = ['9', '10']
+```
+
 #### Compatibility
 
 | Method             | Status | Python name |
@@ -95,6 +109,12 @@ formatter.format_range(datetime, datetime_till)
 
 **Note:** Not all options are currently supported.
 
+#### Additional methods
+
+* `Collator.sorted`: Somewhat like `sorted`, but uses the collator for comparison. If you want
+  to sort complex datastructures you can provide a `key` parameter (like with `sorted`) to
+  get a comparable string value (for example by returning an attribute).
+
 ## Installation
 
 Be sure to be able to install `PyICU`, see the installation docs there:

{python_intl-0.6.0 → python_intl-0.7.1}/README.md

@@ -74,6 +74,20 @@ formatter.format_range(datetime, datetime_till)
 
 ### `Intl.Collator`
 
+#### Example usage
+
+```python
+import python_intl as Intl
+
+collator = Intl.Collator("de-DE", {"numeric": True})
+collator.compare("10", "9")
+# Result = 1, which means 9 comes before 10
+
+# You can also use sorted, although this is not available in JavaScript
+collator.sorted(["10", "9"])
+# Result = ['9', '10']
+```
+
 #### Compatibility
 
 | Method             | Status | Python name |
@@ -82,6 +96,12 @@ formatter.format_range(datetime, datetime_till)
 
 **Note:** Not all options are currently supported.
 
+#### Additional methods
+
+* `Collator.sorted`: Somewhat like `sorted`, but uses the collator for comparison. If you want
+  to sort complex datastructures you can provide a `key` parameter (like with `sorted`) to
+  get a comparable string value (for example by returning an attribute).
+
 ## Installation
 
 Be sure to be able to install `PyICU`, see the installation docs there:

{python_intl-0.6.0 → python_intl-0.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-intl"
-version = "0.6.0"
+version = "0.7.1"
 description = "Python implementation of the Intl JavaScript API"
 readme = "README.md"
 license = "MIT"

{python_intl-0.6.0 → python_intl-0.7.1}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "python-intl"
-version = "0.6.0"
+version = "0.7.1"
 description = "Python implementation of the Intl JavaScript API"
 readme = "README.md"
 authors = [

{python_intl-0.6.0 → python_intl-0.7.1}/python_intl/collator.py

@@ -1,8 +1,10 @@
 from __future__ import annotations
 
 import dataclasses
+import functools
+from collections.abc import Callable, Iterable
 from functools import cached_property
-from typing import TYPE_CHECKING, Literal
+from typing import TYPE_CHECKING, Literal, overload
 
 import icu  # type: ignore[import-untyped]
 
@@ -124,3 +126,17 @@ class Collator:
 
     def compare(self, string_a: str, string_b: str) -> ComparisonResultT:
         return _COLLATOR_RESULT_TO_RESULT[self._icu_collator.compare(string_a, string_b)]
+
+    @overload
+    def sorted(self, items: Iterable[str], /, key: None = None) -> Iterable[str]: ...
+    @overload
+    def sorted[T](self, items: Iterable[T], /, key: Callable[[T], str]) -> Iterable[T]: ...
+    def sorted(self, items, /, key = None):
+        return sorted(
+            items,
+            key=functools.cmp_to_key(
+                (lambda a, b: self.compare(key(a), key(b)))
+                if key
+                else self.compare,
+            ),
+        )