added configuration for pre-commit.

Author: cedricbonhomme

.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+repos:
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.31.1
+    hooks:
+      - id: pyupgrade
+        args: ["--py37-plus"]
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.0.1
+    hooks:
+      - id: reorder-python-imports
+        additional_dependencies: ["setuptools>60.9"]
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/flake8
+    rev: 4.0.1
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - flake8-bugbear
+          - flake8-implicit-str-concat
+        args: ["--max-line-length=100"]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: fix-byte-order-marker
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  - repo: https://github.com/trailofbits/pip-audit
+    rev: v2.4.8
+    hooks:
+      -   id: pip-audit

COPYING

@@ -671,4 +671,4 @@ into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

bin/enigma.py

@@ -1,10 +1,8 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
 import sys
 
-from pyenigma.rotor import *
 from pyenigma.enigma import *
+from pyenigma.rotor import *
 
 """A trivial and minimaliste CLI.
 """
@@ -29,7 +27,7 @@ def main():
         r2 = sys.argv[4].upper()
         r3 = sys.argv[5].upper()
         plugs = sys.argv[6].upper()
-        verbose = (sys.argv[7] if 7 < len(sys.argv) else '') in ['-v', '--verbose']
+        verbose = (sys.argv[7] if 7 < len(sys.argv) else "") in ["-v", "--verbose"]
     except:
         usage()
         exit()
@@ -75,5 +73,6 @@ def main():
                 r2,
                 r3,
                 plugs,
-            ), file=sys.stderr
+            ),
+            file=sys.stderr,
         )

poetry.lock

@@ -1,8 +1,6 @@
 #! /usr/bin/env python
-#-*- coding: utf-8 -*-
-
-from . import rotor
 from . import enigma
+from . import rotor
 
 __author__ = "Christophe Goessen, Cedric Bonhomme"
 __version__ = "0.4.0"

pyenigma/__init__.py

@@ -1,19 +1,18 @@
 #!/usr/bin/env python
-#-*- coding: utf-8 -*-
-
 from pyenigma.rotor import *
 
-class Enigma(object):
+
+class Enigma:
     """Represents an Enigma machine.
     Initializes an Enigma machine with these arguments:
     - ref: reflector;
     - r1, r2, r3: rotors;
     - key: initial state of rotors;
     - plus: plugboard settings.
     """
+
     def __init__(self, ref, r1, r2, r3, key="AAA", plugs="", ring="AAA"):
-        """Initialization of the Enigma machine.
-        """
+        """Initialization of the Enigma machine."""
         self.reflector = ref
         self.rotor1 = r1
         self.rotor2 = r2
@@ -25,29 +24,29 @@ def __init__(self, ref, r1, r2, r3, key="AAA", plugs="", ring="AAA"):
         self.rotor1.ring = ring[0]
         self.rotor2.ring = ring[1]
         self.rotor3.ring = ring[2]
-        self.reflector.state = 'A'
+        self.reflector.state = "A"
 
-        plugboard_settings= [(elem[0], elem[1]) for elem in plugs.split()]
+        plugboard_settings = [(elem[0], elem[1]) for elem in plugs.split()]
 
         alpha = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
         alpha_out = [" "] * 26
         for i in range(len(alpha)):
             alpha_out[i] = alpha[i]
         for k, v in plugboard_settings:
-            alpha_out[ord(k)-ord('A')] = v
-            alpha_out[ord(v)-ord('A')] = k
+            alpha_out[ord(k) - ord("A")] = v
+            alpha_out[ord(v) - ord("A")] = k
 
         try:
             self.transtab = str.maketrans(alpha, "".join(alpha_out))
         except:
             # Python 2
             from string import maketrans
-            self.transtab = maketrans(alpha,"".join(alpha_out))
+
+            self.transtab = maketrans(alpha, "".join(alpha_out))
 
     def encipher(self, plaintext_in):
-        """Encrypt 'plaintext_in'.
-        """
-        ciphertext = ''
+        """Encrypt 'plaintext_in'."""
+        ciphertext = ""
         plaintext_in_upper = plaintext_in.upper()
         plaintext = plaintext_in_upper.translate(self.transtab)
         for c in plaintext:
@@ -85,13 +84,14 @@ def encipher(self, plaintext_in):
         return fres
 
     def __str__(self):
-        """Pretty display.
-        """
+        """Pretty display."""
         return """
-        Reflector: %s
+        Reflector: {}
 
-        Rotor 1: %s
+        Rotor 1: {}
 
-        Rotor 2: %s
+        Rotor 2: {}
 
-        Rotor 3: %s""" % (self.reflector, self.rotor1, self.rotor2, self.rotor3)
+        Rotor 3: {}""".format(
+            self.reflector, self.rotor1, self.rotor2, self.rotor3
+        )