Merge branch 'master' of https://github.com/denismaggior8/enigma-python

Author: denismaggior8

docs/classdiagram/enigmapython.md

@@ -278,10 +278,8 @@ classDiagram
  }
 
  class Utils {
- + @staticmethod render_enigma_diagram(enigma)
  + @staticmethod find_divergence(str1, str2)
  + @staticmethod find_all_subclasses(cls)
- + @staticmethod get_class_instance(cls)
  + @staticmethod swap_chars(string, ch1, ch2)
  }
 
@@ -363,6 +361,10 @@ classDiagram
  - __init__(self, rotor1, rotor2, rotor3, reflector, etw, auto_increment_rotors) None
  }
 
+ class XRay {
+ + @staticmethod render_enigma_xray(enigma)
+ }
+
  class ReflectorUKWBThin {
  + str wiring
  + str tag

src/enigma/enigmapython/SwappablePlugboard.py

@@ -1,5 +1,4 @@
 from .Plugboard import Plugboard
-from .Utils import Utils
 from .Alphabets import Alphabets
 from .Swappable import Swappable
 

src/enigma/enigmapython/Utils.py

@@ -1,64 +1,6 @@
-from importlib import import_module
-from rich.console import Console
-from rich.text import Text
-from enigmapython.RotatingReflector import RotatingReflector
-
 
 class Utils:
 
- @staticmethod
- def render_enigma_diagram(enigma):
- """
- Render the Enigma Z ASCII diagram with a variable number of rotors.
- UKW, ETW and Plugboard are always visible. The rotor numbers start from 0.
-
- Parameters:
- - enigma (Enigma): The Enigma machine to render (minimum 1).
- """
- console = Console()
-
- rotor_count = len(enigma.rotors)
-
- rotor_labels = " ".join([f"Rotor" for i in range(rotor_count - 1, -1, -1)])
- rotor_numbers = " ".join([f"{i}" for i in range(rotor_count - 1, -1, -1)])
-
- rotor_walls_top = " ".join(["+-----+"] * rotor_count)
-
- rotors_positions = " ".join(["{:02}".format(enigma.rotors[i].position) for i in range(rotor_count - 1, -1, -1)])
-
- rotors_rings = " ".join(["{:02}".format(enigma.rotors[i].ring) for i in range(rotor_count - 1, -1, -1)])
-
- rotor_walls = " ".join(["| |"] * rotor_count)
-
- rotor_walls_bottom = " ".join(["+-----+"] * rotor_count)
-
- rotor_walls_forward = " ".join(["| {} |".format(enigma.rotors[i].journal[-2]['output_char'] if len(enigma.rotors[i].journal) >= 2 else ' ') for i in range(rotor_count - 1, -1, -1)])
-
- rotor_walls_backward = " ".join(["| {} |".format(enigma.rotors[i].journal[-1]['output_char'] if len(enigma.rotors[i].journal) >= 2 else ' ') for i in range(rotor_count - 1, -1, -1)])
-
- rotor_wiring_top = "".join(["|-----|--<--"] * rotor_count)
-
- rotor_wiring_bottom = "".join(["|-----|-->--"] * rotor_count)
-
- diagram = f"""
- UKW {rotor_labels} ETW PLUGBOARD
- {rotor_numbers} 
- +-----+ {rotor_walls_top} +-----+ +-----+
- | | {rotor_walls} | | | |
- | +--|--<--{rotor_wiring_top}|-----|--<--|-----|----< {enigma.journal[-1]['input_char'] if len(enigma.journal) >= 1 else ' '} <-- Key
- | | {rotor_walls_forward} | {enigma.etw.journal[-2]['output_char'] if len(enigma.etw.journal) >= 2 else ' '} | | {enigma.plugboard.journal[-2]['output_char'] if len(enigma.plugboard.journal) >= 2 else ' '} | |
- | | | {rotor_walls} | | | |
- | | | {rotor_walls} | | | |
- | | | {enigma.reflector.journal[-1]['output_char'] if len(enigma.reflector.journal) >= 1 else ' '} | {rotor_walls_backward} | {enigma.etw.journal[-1]['output_char'] if len(enigma.etw.journal) >= 2 else ' '} | | 
- | +--|-->--{rotor_wiring_bottom}|-----|-->--|-----|----> {enigma.journal[-1]['output_char'] if len(enigma.journal) >= 1 else ' '} --> Lamp
- | | {rotor_walls} | | | |
- +-----+ {rotor_walls_bottom} +-----+ +-----+
-
- Pos.: {"{:02}".format(enigma.reflector.position) if isinstance(enigma.reflector, RotatingReflector) else ' '} {rotors_positions} 
- Ring: {rotors_rings}
- """
- console.print(Text(diagram, style="bold"))
- return Text(diagram, style="bold")
 
  @staticmethod
  def find_divergence(str1, str2):
@@ -94,15 +36,6 @@ def find_all_subclasses(cls):
  return set(cls.__subclasses__()).union(
  [s for c in cls.__subclasses__() for s in Utils.find_all_subclasses(c)])
 
- @staticmethod
- def get_class_instance(cls):
- try:
- module_path, class_name = cls.rsplit('.', 1)
- module = import_module(module_path)
- return getattr(module, class_name)
- except (ImportError, AttributeError) as e:
- raise ImportError(cls)
-
  @staticmethod 
  def swap_chars(string, ch1, ch2):
  if ch1 == ch2: return string

src/enigma/enigmapython/XRay.py

@@ -0,0 +1,57 @@
+from rich.console import Console
+from rich.text import Text
+
+class XRay():
+ @staticmethod
+ def render_enigma_xray(enigma):
+ """
+ Render the Enigma Z ASCII diagram with a variable number of rotors.
+ UKW, ETW and Plugboard are always visible. The rotor numbers start from 0.
+
+ Parameters:
+ - enigma (Enigma): The Enigma machine to render (minimum 1).
+ """
+ console = Console()
+
+ rotor_count = len(enigma.rotors)
+
+ rotor_labels = " ".join([f"Rotor" for i in range(rotor_count - 1, -1, -1)])
+ rotor_numbers = " ".join([f"{i}" for i in range(rotor_count - 1, -1, -1)])
+
+ rotor_walls_top = " ".join(["+-----+"] * rotor_count)
+
+ rotors_positions = " ".join(["{:02}".format(enigma.rotors[i].position) for i in range(rotor_count - 1, -1, -1)])
+
+ rotors_rings = " ".join(["{:02}".format(enigma.rotors[i].ring) for i in range(rotor_count - 1, -1, -1)])
+
+ rotor_walls = " ".join(["| |"] * rotor_count)
+
+ rotor_walls_bottom = " ".join(["+-----+"] * rotor_count)
+
+ rotor_walls_forward = " ".join(["| {} |".format(enigma.rotors[i].journal[-2]['output_char'] if len(enigma.rotors[i].journal) >= 2 else ' ') for i in range(rotor_count - 1, -1, -1)])
+
+ rotor_walls_backward = " ".join(["| {} |".format(enigma.rotors[i].journal[-1]['output_char'] if len(enigma.rotors[i].journal) >= 2 else ' ') for i in range(rotor_count - 1, -1, -1)])
+
+ rotor_wiring_top = "".join(["|-----|--<--"] * rotor_count)
+
+ rotor_wiring_bottom = "".join(["|-----|-->--"] * rotor_count)
+
+ diagram = f"""
+ UKW {rotor_labels} ETW PLUGBOARD
+ {rotor_numbers} 
+ +-----+ {rotor_walls_top} +-----+ +-----+
+ | | {rotor_walls} | | | |
+ | +--|--<--{rotor_wiring_top}|-----|--<--|-----|----< {enigma.journal[-1]['input_char'] if len(enigma.journal) >= 1 else ' '} <-- Key
+ | | {rotor_walls_forward} | {enigma.etw.journal[-2]['output_char'] if len(enigma.etw.journal) >= 2 else ' '} | | {enigma.plugboard.journal[-2]['output_char'] if len(enigma.plugboard.journal) >= 2 else ' '} | |
+ | | | {rotor_walls} | | | |
+ | | | {rotor_walls} | | | |
+ | | | {enigma.reflector.journal[-1]['output_char'] if len(enigma.reflector.journal) >= 1 else ' '} | {rotor_walls_backward} | {enigma.etw.journal[-1]['output_char'] if len(enigma.etw.journal) >= 2 else ' '} | | 
+ | +--|-->--{rotor_wiring_bottom}|-----|-->--|-----|----> {enigma.journal[-1]['output_char'] if len(enigma.journal) >= 1 else ' '} --> Lamp
+ | | {rotor_walls} | | | |
+ +-----+ {rotor_walls_bottom} +-----+ +-----+
+
+ Pos.: {"{:02}".format(enigma.reflector.position) if isinstance(enigma.reflector, RotatingReflector) else ' '} {rotors_positions} 
+ Ring: {rotors_rings}
+ """
+ console.print(Text(diagram, style="bold"))
+ return Text(diagram, style="bold")