Browse Source

docstringggggg

David Robertson 1 year ago
parent
commit
0953cad3e4
1 changed files with 4 additions and 0 deletions
  1. 4 0
      synapse/util/stringutils.py

+ 4 - 0
synapse/util/stringutils.py

@@ -250,4 +250,8 @@ def base62_encode(num: int, minwidth: int = 1) -> str:
 
 
 def non_null_str_or_none(val: Any) -> Optional[str]:
+    """Check that the arg is a string containing no null (U+0000) codepoints.
+
+    If so, returns the given string unmodified; otherwise, returns None.
+    """
     return val if isinstance(val, str) and "\u0000" not in val else None