chore: rename the function to increase readability

Author: stevenhua0320

news/deprecate-symmetryutilities-6.rst

@@ -1,10 +1,10 @@
 **Added:**
 
 * Added ``_find_constraints`` method in ``SymmetryConstraints`` class
-* Added ``pospar_symbols`` method in ``SymmetryConstraints`` class
-* Added ``pospar_values`` method in ``SymmetryConstraints`` class
-* Added ``upar_symbols`` method in ``SymmetryConstraints`` class
-* Added ``upar_values`` method in ``SymmetryConstraints`` class
+* Added ``pos_parm_symbols`` method in ``SymmetryConstraints`` class
+* Added ``pos_parm_values`` method in ``SymmetryConstraints`` class
+* Added ``u_parm_symbols`` method in ``SymmetryConstraints`` class
+* Added ``u_parm_values`` method in ``SymmetryConstraints`` class
 * Added ``u_formulas`` method in ``SymmetryConstraints`` class
 
 **Changed:**

src/diffpy/structure/symmetryutilities.py

@@ -1224,9 +1224,9 @@ def posparSymbols(self):
 
         Please use 'diffpy.structure.SymmetryConstraints.pospar_symbols' instead.
         """
-        return self.pospar_symbols()
+        return self.pos_parm_symbols()
 
-    def pospar_symbols(self):
+    def pos_parm_symbols(self):
         """Return list of standard position parameter symbols."""
         return [n for n, v in self.pospars]
 
@@ -1237,9 +1237,9 @@ def posparValues(self):
 
         Please use 'diffpy.structure.SymmetryConstraints.pospar_values' instead.
         """
-        return self.pospar_values()
+        return self.pos_parm_values()
 
-    def pospar_values(self):
+    def pos_parm_values(self):
         """Return list of position parameters values."""
         return [v for n, v in self.pospars]
 
@@ -1265,7 +1265,7 @@ def positionFormulas(self, xyzsymbols=None):
             emsg = "Not enough symbols for %i position parameters" % len(self.pospars)
             raise SymmetryError(emsg)
         # build translation dictionary
-        trsmbl = dict(zip(self.pospar_symbols(), xyzsymbols))
+        trsmbl = dict(zip(self.pos_parm_symbols(), xyzsymbols))
 
         def translatesymbol(matchobj):
             return trsmbl[matchobj.group(0)]
@@ -1307,9 +1307,9 @@ def UparSymbols(self):
 
         Please use 'diffpy.structure.SymmetryConstraints.upar_symbols' instead.
         """
-        return self.upar_symbols()
+        return self.u_parm_symbols()
 
-    def upar_symbols(self):
+    def u_parm_symbols(self):
         """Return list of standard atom displacement parameter
         symbols."""
         return [n for n, v in self.Upars]
@@ -1324,7 +1324,7 @@ def UparValues(self):
         """
         return [v for n, v in self.Upars]
 
-    def upar_values(self):
+    def u_parm_values(self):
         """Return list of atom displacement parameters values."""
         return [v for n, v in self.Upars]
 
@@ -1362,7 +1362,7 @@ def u_formulas(self, Usymbols=None):
             emsg = "Not enough symbols for %i U parameters" % len(self.Upars)
             raise SymmetryError(emsg)
         # build translation dictionary
-        trsmbl = dict(zip(self.upar_symbols(), Usymbols))
+        trsmbl = dict(zip(self.u_parm_symbols(), Usymbols))
 
         def translatesymbol(matchobj):
             return trsmbl[matchobj.group(0)]

tests/test_symmetryutilities.py

@@ -912,9 +912,9 @@ def test_upar_symbols(self):
         pos = [[0, 0, 0]]
         Uijs = numpy.zeros((1, 3, 3))
         sc1 = SymmetryConstraints(sg1, pos, Uijs)
-        self.assertEqual(6, len(sc1.upar_symbols()))
+        self.assertEqual(6, len(sc1.u_parm_symbols()))
         sc225 = SymmetryConstraints(sg225, pos, Uijs)
-        self.assertEqual(["U110"], sc225.upar_symbols())
+        self.assertEqual(["U110"], sc225.u_parm_symbols())
         return
 
     def test_UparValues(self):
@@ -940,11 +940,11 @@ def test_upar_values(self):
         pos = [[0, 0, 0]]
         Uijs = [[[0.1, 0.4, 0.5], [0.4, 0.2, 0.6], [0.5, 0.6, 0.3]]]
         sc1 = SymmetryConstraints(sg1, pos, Uijs)
-        duv = 0.1 * numpy.arange(1, 7) - sc1.upar_values()
+        duv = 0.1 * numpy.arange(1, 7) - sc1.u_parm_values()
         self.assertAlmostEqual(0, max(numpy.fabs(duv)), places)
         sc225 = SymmetryConstraints(sg225, pos, Uijs)
-        self.assertEqual(1, len(sc225.upar_values()))
-        self.assertAlmostEqual(0.2, sc225.upar_values()[0], places)
+        self.assertEqual(1, len(sc225.u_parm_values()))
+        self.assertAlmostEqual(0.2, sc225.u_parm_values()[0], places)
         return
 
     def test_posparSymbols_and_posparValues(self):
@@ -1108,7 +1108,7 @@ def test_pospar_symbols_and_pospar_values(params, expected_symbols, expected_val
     eau = ExpandAsymmetricUnit(sg225, [[0, 0, 0]])
     sc = SymmetryConstraints(sg225, eau.expandedpos)
     sc.pospars = params
-    actual_symbols, actual_values = sc.pospar_symbols(), sc.pospar_values()
+    actual_symbols, actual_values = sc.pos_parm_symbols(), sc.pos_parm_values()
     assert actual_symbols == expected_symbols
     assert actual_values == expected_values