update comment

changelog.d/12572.feature

@@ -0,0 +1 @@
+Add the Synapse function `types.map_username_to_mxid_localpart` to the Module API.

synapse/module_api/__init__.py

@@ -117,6 +117,7 @@ from synapse.types import (
     UserInfo,
     UserProfile,
     create_requester,
+    map_username_to_mxid_localpart,
 )
 from synapse.util import Clock
 from synapse.util.async_helpers import maybe_awaitable
@@ -573,6 +574,26 @@ class ModuleApi:
             return username
         return UserID(username, self._hs.hostname).to_string()
 
+    def normalize_username(
+        self, username: Union[str, bytes], case_sensitive: bool = False
+    ) -> str:
+        """Map a username onto a string suitable for a MXID
+
+        This follows the algorithm laid out at
+        https://matrix.org/docs/spec/appendices.html#mapping-from-other-character-sets.
+
+        Added in Synapse v1.58.0
+
+        Args:
+            username: username to be mapped
+            case_sensitive: true if TEST and test should be mapped
+            onto different mxids
+
+            Returns:
+                string suitable for a mxid localpart
+        """
+        return map_username_to_mxid_localpart(username, case_sensitive)
+
     async def get_profile_for_user(self, localpart: str) -> ProfileInfo:
         """Look up the profile info for the user with the given localpart.
 

tests/module_api/test_api.py

@@ -635,6 +635,14 @@ class ModuleApiTestCase(HomeserverTestCase):
             [{"set_tweak": "sound", "value": "default"}]
         )
 
+    def test_normalize_username(self) -> None:
+        username = "Haxxor"
+        username2 = "_leet"
+        username3 = "aNoThErTeSt"
+        self.assertEqual(self.module_api.normalize_username(username), "haxxor")
+        self.assertEqual(self.module_api.normalize_username(username2), "=5fleet")
+        self.assertEqual(self.module_api.normalize_username(username3), "anothertest")
+
 
 class ModuleApiWorkerTestCase(BaseMultiWorkerStreamTestCase):
     """For testing ModuleApi functionality in a multi-worker setup"""