Update shuffled_shift_cipher.py

Author: lighting9999

ciphers/shuffled_shift_cipher.py

@@ -5,30 +5,21 @@
 
 
 class ShuffledShiftCipher:
-         """
-     This algorithm uses the Caesar Cipher algorithm but removes the option to
-     use brute force to decrypt the message.
-
-     The passcode is a random password from the selection buffer of
-     1. uppercase letters of the English alphabet
-     2. lowercase letters of the English alphabet
-     3. digits from 0 to 9
-
-     Using unique characters from the passcode, the normal list of characters,
-     that can be allowed in the plaintext, is pivoted and shuffled. Refer to docstring
-     of __make_key_list() to learn more about the shuffling.
-
-     Then, using the passcode, a number is calculated which is used to encrypt the
-     plaintext message with the normal shift cipher method, only in this case, the
-     reference, to look back at while decrypting, is shuffled.
-
-     Each cipher object can possess an optional argument as passcode, without which a
-     new passcode is generated for that object automatically.
-     cip1 = ShuffledShiftCipher('d4usr9TWxw9wMD')
-     cip2 = ShuffledShiftCipher()
-
+    """
     Enhanced Caesar Cipher with shuffled character set for stronger encryption.
     Uses a passcode to generate a unique shuffled key list and shift key.
+
+    The passcode is a random password from the selection buffer of:
+    1. Uppercase letters of the English alphabet
+    2. Lowercase letters of the English alphabet
+    3. Digits from 0 to 9
+
+    Each cipher object can possess an optional argument as passcode, without which a
+    new passcode is generated for that object automatically.
+    
+    Example:
+    >>> cip1 = ShuffledShiftCipher('d4usr9TWxw9wMD')
+    >>> cip2 = ShuffledShiftCipher()
     """
 
     def __init__(self, passcode: str | None = None) -> None:
@@ -61,8 +52,8 @@ def __make_key_list(self) -> list[str]:
         # Get printable characters except rare whitespace
         key_options = string.printable.strip("\r\x0b\x0c")
         breakpoints = sorted(set(self.__passcode))
-        shuffled: list[str] = []  # Explicit type annotation
-        temp: list[str] = []  # Explicit type annotation
+        shuffled: list[str] = []
+        temp: list[str] = []
 
         for char in key_options:
             temp.append(char)
@@ -80,7 +71,7 @@ def __make_shift_key(self) -> int:
 
     def encrypt(self, plaintext: str) -> str:
         """Encrypt plaintext using shuffled shift cipher."""
-        encoded: list[str] = []  # Explicit type annotation
+        encoded: list[str] = []
         key_len = len(self.__key_list)
 
         for char in plaintext:
@@ -92,7 +83,7 @@ def encrypt(self, plaintext: str) -> str:
 
     def decrypt(self, encoded_message: str) -> str:
         """Decrypt message using shuffled shift cipher."""
-        decoded: list[str] = []  # Explicit type annotation
+        decoded: list[str] = []
         key_len = len(self.__key_list)
 
         for char in encoded_message: