Style fixes

Author: Daniel Zagaynov

src/pyxcrypt/__init__.py

@@ -1,14 +1,19 @@
 """
 This file is part of pyxcrypt.
 
-pyxcrypt is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License
-as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
-
-pyxcrypt is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+pyxcrypt is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License
+as published by the Free Software Foundation, either version 3 of
+the License, or (at your option) any later version.
+
+pyxcrypt is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY;
+without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.
 See the GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License along with pyxcrypt.
+You should have received a copy of the GNU General Public License
+along with pyxcrypt.
 If not, see <https://www.gnu.org/licenses/>.
 """
 
@@ -22,18 +27,18 @@
 
 def crypt_gensalt(prefix=None, count=0, rbytes=None, nrbytes=0):
     """
-    Compile a string for use as the setting argument to crypt
-
-    :param prefix: selects the hashing method to use
-    :type prefix: str, bytes-like object or None
-    :param count: controls the CPU time cost of the hash
-    :type count: int
-    :param rbytes: random bytes for use as a "salt"
-    :type rbytes: str, bytes-like object or None
-    :param nrbytes: length of result
-    :type nrbytes: int
-    :return: salt
-    :rtype: str
+    Compile a string for use as the setting argument to crypt.
+
+    :param prefix: selects the hashing method to use;
+    :type prefix: str, bytes-like object or None;
+    :param count: controls the CPU time cost of the hash;
+    :type count: int;
+    :param rbytes: random bytes for use as a "salt";
+    :type rbytes: str, bytes-like object or None;
+    :param nrbytes: length of result;
+    :type nrbytes: int;
+    :return: salt;
+    :rtype: str.
     """
     hashes = {"yescrypt": "$y$",
               "gost-yescrypt": "$gy$",
@@ -53,21 +58,22 @@ def crypt_gensalt(prefix=None, count=0, rbytes=None, nrbytes=0):
               "nt": "$3$",
               "bsdicrypt": "_",
               "descrypt": ""}
-    return pyxcrypt._crypt_gensalt(prefix if prefix not in hashes else hashes[prefix], count, rbytes, nrbytes)
+    return pyxcrypt._crypt_gensalt(prefix if prefix not in hashes else
+                                   hashes[prefix], count, rbytes, nrbytes)
 
 
 def crypt_gensalt_default(count=0, rbytes=None, nrbytes=0):
     """
-    Same as crypt_gensalt but with the default (prefered) hashing method
-
-    :param count: controls the CPU time cost of the hash
-    :type count: int
-    :param rbytes: random bytes for use as a "salt"
-    :type rbytes: str, bytes-like object or None
-    :param nrbytes: length of result
-    :type nrbytes: int
-    :return: salt
-    :rtype: str
+    Same as crypt_gensalt but with the default (prefered) hashing method.
+
+    :param count: controls the CPU time cost of the hash;
+    :type count: int;
+    :param rbytes: random bytes for use as a "salt";
+    :type rbytes: str, bytes-like object or None;
+    :param nrbytes: length of result;
+    :type nrbytes: int;
+    :return: salt;
+    :rtype: str.
     """
     return crypt_gensalt(None, count, rbytes, nrbytes)
 
@@ -77,39 +83,39 @@ def crypt_checksalt(salt):
     Checks the setting string against the system configuration and reports
     whether the hashing method and parameters it specifies are acceptable.
 
-    :param salt: salt generated by crypt_gensalt
-    :type salt: str, bytes-like object
-    :return: one of CRYPT_SALT_OK/CRYPT_SALT_INVALID/CRYPT_SALT_METHOD_LEGACY
-    :rtype: int
+    :param salt: salt generated by crypt_gensalt;
+    :type salt: str, bytes-like object;
+    :return: one of CRYPT_SALT_OK/CRYPT_SALT_INVALID/CRYPT_SALT_METHOD_LEGACY;
+    :rtype: int.
     """
     return pyxcrypt._crypt_checksalt(salt)
 
 
 def crypt_checksalt_filter(salt):
     """
     Same as pyxcrypt.crypt_checksalt but returns True for CRYPT_SALT_OK
-    and False otherwise
+    and False otherwise.
 
-    :param salt: salt generated by crypt_gensalt
-    :type salt: str, bytes-like object
-    :return: True for CRYPT_SALT_OK and False otherwise
-    :rtype: bool
+    :param salt: salt generated by crypt_gensalt;
+    :type salt: str, bytes-like object;
+    :return: True for CRYPT_SALT_OK and False otherwise;
+    :rtype: bool.
     """
     return pyxcrypt._crypt_checksalt(salt) == CRYPT_SALT_OK
 
 
 def crypt(phrase, salt=crypt_gensalt()):
     """
-    Irreversibly “hash” phrase using a cryptographic “hashing method”.
+    Irreversibly "hash" phrase using a cryptographic "hashing method".
     By default parameter "salt" set to crypt_gensalt() without args, which
     generates salt with the default "hashing method" with random bytes
-    obtained from the operating system
-
-    :param phrase: phrase to be "hashed"
-    :type phrase: str, bytes-like object
-    :param salt: salt, generated by crypt_gensalt
-    :type salt: str, bytes-like object
-    :return: "hashed" phrase
-    :rtype: str
+    obtained from the operating system.
+
+    :param phrase: phrase to be "hashed";
+    :type phrase: str, bytes-like object;
+    :param salt: salt, generated by crypt_gensalt;
+    :type salt: str, bytes-like object;
+    :return: "hashed" phrase;
+    :rtype: str.
     """
     return pyxcrypt._crypt(phrase, salt)

src/pyxcrypt/pyxcrypt.c

@@ -1,14 +1,19 @@
 /*
  * This file is part of pyxcrypt.
  *
- * pyxcrypt is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ * pyxcrypt is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
  *
- * pyxcrypt is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
- * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * pyxcrypt is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.
  * See the GNU General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License along with pyxcrypt.
+ * You should have received a copy of the GNU General Public License
+ * along with pyxcrypt.
  * If not, see <https://www.gnu.org/licenses/>.
  */
 
@@ -37,7 +42,8 @@ static PyObject * _crypt_gensalt(PyObject *self, PyObject *args)
         PyErr_SetString(PyExc_TypeError, "Expected 4 arguments");
         return NULL;
     }
-    if (PyArg_ParseTuple(args, "z#kz#i", &prefix, &dumb_sz_1, &count, &rbytes, &dumb_sz_2, &nrbytes) == -1)
+    if (PyArg_ParseTuple(args, "z#kz#i", &prefix, &dumb_sz_1, &count, &rbytes,
+                &dumb_sz_2, &nrbytes) == -1)
     {
         PyErr_SetString(PyExc_TypeError, "Arguments parsing");
         return NULL;
@@ -65,7 +71,8 @@ static PyObject * _crypt(PyObject *self, PyObject *args)
         PyErr_SetString(PyExc_TypeError, "Expected 2 arguments");
         return NULL;
     }
-    if (PyArg_ParseTuple(args, "z#z#", &phrase, &dumb_sz_1, &setting, &dumb_sz_2) == -1)
+    if (PyArg_ParseTuple(args, "z#z#", &phrase, &dumb_sz_1, &setting,
+                &dumb_sz_2) == -1)
     {
         PyErr_SetString(PyExc_TypeError, "Arguments parsing");
         return NULL;
@@ -75,7 +82,7 @@ static PyObject * _crypt(PyObject *self, PyObject *args)
         PyErr_SetString(PyExc_MemoryError, strerror(errno));
         return NULL;
     }
-    memset (data, 0, sizeof(*data));
+    memset(data, 0, sizeof(*data));
     if (crypt_r(phrase, setting, data) == NULL || data->output[0] == '*')
     {
         PyErr_SetString(PyExc_RuntimeError, strerror(errno));
@@ -110,9 +117,13 @@ static PyObject * _crypt_checksalt(PyObject *self, PyObject *args)
 }
 
 static PyMethodDef PyXcryptMethods[] = {
-    {"_crypt_gensalt", _crypt_gensalt, METH_VARARGS, "compile a string for use as the setting argument to crypt"},
-    {"_crypt", _crypt, METH_VARARGS, "irreversibly \"hash\" phrase using a cryptographic \"hashing method\""},
-    {"_crypt_checksalt", _crypt_checksalt, METH_VARARGS, "checks the setting string against the system configuration and reports whether the hashing method and parameters it specifies are acceptable"},
+    {"_crypt_gensalt", _crypt_gensalt, METH_VARARGS,
+     "compile a string for use as the setting argument to crypt"},
+    {"_crypt", _crypt, METH_VARARGS,
+     "irreversibly \"hash\" phrase using a cryptographic \"hashing method\""},
+    {"_crypt_checksalt", _crypt_checksalt, METH_VARARGS,
+     "checks the setting string against the system configuration and reports "
+     "whether the hashing method and parameters it specifies are acceptable"},
     {NULL, NULL, 0, NULL}
 };