renamed function hyperedge.str2atom to str_to_atom

Author: telmomenezes

CHANGELOG.md

@@ -13,6 +13,7 @@
 - added get_parser to main functions (at hyperbase root).
 - improved documentation.
 - hedge now accepts ParseResults and can recursively add Hyperedge.text strings.
+- renamed function hyperedge.str2atom to str_to_atom.
 
 ### Removed
 - function patterns.edge_matches_pattern.

src/hyperbase/hyperedge.py

@@ -28,7 +28,7 @@
 valid_b_argroles: set[str] = {'m', 'a'}
 
 
-def str2atom(s: str) -> str:
+def str_to_atom(s: str) -> str:
     """Converts a string into a valid atom."""
     atom = s.lower()
 
@@ -178,7 +178,7 @@ def hedge(source: str | Hyperedge | list[Any] | tuple[Any] | ParseResult) -> Hyp
 
 def build_atom(text: str, *parts: str) -> Atom:
     """Build an atom from text and other parts."""
-    atom = str2atom(text)
+    atom = str_to_atom(text)
     parts_str = '/'.join([part for part in parts if part])
     if len(parts_str) > 0:
         atom = ''.join((atom, '/', parts_str))

tests/test_hyperedge.py

@@ -1,6 +1,6 @@
 import unittest
 
-from hyperbase.hyperedge import hedge, build_atom, str2atom, split_edge_str
+from hyperbase.hyperedge import hedge, build_atom, str_to_atom, split_edge_str
 
 
 class TestHyperedge(unittest.TestCase):
@@ -71,38 +71,38 @@ def test_replace_atom_part2(self):
     def test_replace_atom_part3(self):
         self.assertEqual(hedge('(XXX/1/yyy)').replace_atom_part(1, '77'), hedge('(XXX/77/yyy)'))
 
-    def test_str2atom1(self):
-        self.assertEqual(str2atom('abc'), 'abc')
+    def test_str_to_atom1(self):
+        self.assertEqual(str_to_atom('abc'), 'abc')
 
-    def test_str2atom2(self):
-        self.assertEqual(str2atom('abc%'), 'abc%25')
+    def test_str_to_atom2(self):
+        self.assertEqual(str_to_atom('abc%'), 'abc%25')
 
-    def test_str2atom3(self):
-        self.assertEqual(str2atom('/abc'), '%2fabc')
+    def test_str_to_atom3(self):
+        self.assertEqual(str_to_atom('/abc'), '%2fabc')
 
-    def test_str2atom4(self):
-        self.assertEqual(str2atom('a bc'), 'a%20bc')
+    def test_str_to_atom4(self):
+        self.assertEqual(str_to_atom('a bc'), 'a%20bc')
 
-    def test_str2atom5(self):
-        self.assertEqual(str2atom('ab(c'), 'ab%28c')
+    def test_str_to_atom5(self):
+        self.assertEqual(str_to_atom('ab(c'), 'ab%28c')
 
-    def test_str2atom6(self):
-        self.assertEqual(str2atom('abc)'), 'abc%29')
+    def test_str_to_atom6(self):
+        self.assertEqual(str_to_atom('abc)'), 'abc%29')
 
-    def test_str2atom7(self):
-        self.assertEqual(str2atom('.abc'), '%2eabc')
+    def test_str_to_atom7(self):
+        self.assertEqual(str_to_atom('.abc'), '%2eabc')
 
-    def test_str2atom8(self):
-        self.assertEqual(str2atom('a*bc'), 'a%2abc')
+    def test_str_to_atom8(self):
+        self.assertEqual(str_to_atom('a*bc'), 'a%2abc')
 
-    def test_str2atom9(self):
-        self.assertEqual(str2atom('ab&c'), 'ab%26c')
+    def test_str_to_atom9(self):
+        self.assertEqual(str_to_atom('ab&c'), 'ab%26c')
 
-    def test_str2atom10(self):
-        self.assertEqual(str2atom('abc@'), 'abc%40')
+    def test_str_to_atom10(self):
+        self.assertEqual(str_to_atom('abc@'), 'abc%40')
 
-    def test_str2atom11(self):
-        self.assertEqual(str2atom('graph brain/(1).'), 'graph%20brain%2f%281%29%2e')
+    def test_str_to_atom11(self):
+        self.assertEqual(str_to_atom('graph brain/(1).'), 'graph%20brain%2f%281%29%2e')
 
     def test_split_edge_str1(self):
         self.assertEqual(split_edge_str('is hyperbase/1 great/1'), ('is', 'hyperbase/1', 'great/1'))