Merge pull request #3 from soda480/0.1.3

0.1.3

Author: soda480

README.md

@@ -17,7 +17,7 @@ pip install ascii_animator
 ### Usage
 ```
 ascii-art-animator --help
-usage: ascii-art-animator [-h] [-s SPEED] [-f FILE] [-d]
+usage: ascii-art-animator [-h] [-s SPEED] [-f FILE] [-d] [-a] [-m MAX_LOOPS]
 
 Ascii Art Animator from GIF
 
@@ -27,6 +27,9 @@ optional arguments:
                         speed of the animation: very_slow, slow, normal, fast (default normal)
   -f FILE, --file FILE  the path to a gif file
   -d, --debug           display debug messages to stdout
+  -a, --show_axis       display the grid axis
+  -m MAX_LOOPS, --max_loops MAX_LOOPS
+                        maximum number of loops, set to 0 to loop through image until keyboard interrupt (default 3)
 ```
 
 ### Examples
@@ -39,15 +42,15 @@ Convert the following [GIF image](https://raw.githubusercontent.com/soda480/asci
 ascii-art-animator -f docs/images/marcovich.gif
 ```
 
-![example](https://raw.githubusercontent.com/soda480/ascii-animator/main/docs/images/marcovich-execution.gif)
+![example](https://raw.githubusercontent.com/soda480/ascii-animator/main/docs/images/marcovich-exec.gif)
 
 Convert the following [GIF image](https://github.com/soda480/ascii-animator/blob/main/docs/images/afuera.gif?raw=true)
 
 ```bash
 ascii-art-animator -f docs/images/afuera.gif -s fast
 ```
 
-![example](https://raw.githubusercontent.com/soda480/ascii-animator/main/docs/images/afuera-execution.gif)
+![example](https://raw.githubusercontent.com/soda480/ascii-animator/main/docs/images/afuera-exec.gif)
 
 #### Game-Of-Life
 

build.py

@@ -15,7 +15,7 @@
 authors = [Author('Emilio Reyes', 'soda480@gmail.com')]
 summary = 'A simple ASCII art animator'
 url = 'https://github.com/soda480/ascii-animator'
-version = '0.1.2'
+version = '0.1.3'
 default_task = [
     'clean',
     'analyze',

docs/images/afuera-exec.gif

@@ -1,2 +1,2 @@
-l2term~=0.1.6
+l2term~=0.1.7
 ascii-magic

docs/images/afuera-execution.gif

@@ -11,6 +11,10 @@
 logger = logging.getLogger(__name__)
 
 
+class MaxLoopsProcessed(Exception):
+    pass
+
+
 class Speed(Enum):
     VERY_SLOW = .4
     SLOW = .11
@@ -38,36 +42,37 @@ class AsciiAnimation(Animation):
     def __init__(self, path):
         logger.debug('executing AsciiAnimation constructor')
         self._frames = AsciiAnimation.get_ascii_frames_from_image(path)
-        self.current = None
+        self.current = 0
         self.cycle()
 
     @property
     def grid(self):
         return self._grid
 
     def cycle(self):
-        if self.current is None or self.current >= len(self._frames):
+        cycle_complete = False
+        if self.current >= len(self._frames):
             self.current = 0
+            cycle_complete = True
         self._grid = self._frames[self.current]
         self.current += 1
+        return cycle_complete
 
     @staticmethod
     def get_ascii_frames_from_image(path):
         logger.debug(f'extracting frames from image "{path}" and converting each frame to ascii art')
-        ansi_escape = re.compile(r'\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])')
         frames = []
         image = Image.open(path)
-        logger.debug(f'the image "{path}" has {image.n_frames} frames')
+        logger.debug(f'the image "{path}" has a total of {image.n_frames} frames')
         for frame in ImageSequence.Iterator(image):
-            ascii_art = ascii_magic.from_image(frame, columns=140)
-            ascii_art_sanitized = ansi_escape.sub('', ascii_art)
-            frames.append(ascii_art_sanitized.split("\n"))
+            ascii_art = ascii_magic.from_image(frame, columns=140, mode=ascii_magic.Modes.ASCII)
+            frames.append(ascii_art.split('\n'))
         return frames
 
 
 class Animator(object):
 
-    def __init__(self, animation=None, speed=Speed.NORMAL, show_index=False):
+    def __init__(self, animation=None, speed=Speed.NORMAL, show_axis=False, max_loops=None):
         """ initialize Animator
         """
         logger.debug('executing Animator constructor')
@@ -77,21 +82,38 @@ def __init__(self, animation=None, speed=Speed.NORMAL, show_index=False):
             raise ValueError("speed must be an instance of Speed Enum")
         self.speed = speed
         self.animation = animation
-        self.show_index = show_index
+        self.show_axis = show_axis
+        self.max_loops = max_loops
         self.start()
 
+    def _check_loops(self, cycle_complete):
+        """ raise exception if maximum number of loops has been processed
+        """
+        if not cycle_complete:
+            return
+        if self.max_loops and self.loop == self.max_loops:
+            raise MaxLoopsProcessed('maximum number of loops processed')
+        self.loop += 1
+
     def start(self):
         """ cycle throught the animation and update the terminal using Lines
         """
-        with Lines(self.animation.grid, show_index=self.show_index) as lines:
-            try:
-                logger.debug('starting ascii art animation')
+        logger.debug('starting ascii art animation')
+        try:
+            logger.debug(f'there are {len(self.animation.grid)} lines in the animation to display')
+            with Lines(self.animation.grid, show_index=self.show_axis, show_x_axis=self.show_axis) as lines:
+                self.loop = 1
                 while True:
-                    # cycle through the animation by updating a grid frame
-                    self.animation.cycle()
-                    # update terminal using the Lines object
+                    # update the grid with the next frame
+                    cycle_complete = self.animation.cycle()
+                    # update terminal via the Lines object
                     for index in range(len(self.animation.grid)):
                         lines[index] = self.animation.grid[index]
+                    self._check_loops(cycle_complete)
                     sleep(self.speed.value)
-            except KeyboardInterrupt:
-                pass
+
+        except KeyboardInterrupt:
+            logger.debug('encountered a keyboard interrupt - ending animation')
+
+        except MaxLoopsProcessed:
+            logger.debug(f'maximum loops processed {self.loop} - ending animation')

docs/images/marcovich-exec.gif

@@ -22,10 +22,12 @@ def get_speed(value):
 
 
 def main():
-    parser = argparse.ArgumentParser(description="Ascii Art Animator from GIF")
-    parser.add_argument("-s", "--speed", type=str, default='normal', help="speed of the animation: very_slow, slow, normal, fast (default normal)")
-    parser.add_argument("-f", "--file", type=str, help="the path to a gif file")
-    parser.add_argument("-d", "--debug", action="store_true", help="display debug messages to stdout")
+    parser = argparse.ArgumentParser(description='Ascii Art Animator from GIF')
+    parser.add_argument('-s', '--speed', type=str, default='normal', help='speed of the animation: very_slow, slow, normal, fast (default normal)')
+    parser.add_argument('-f', '--file', type=str, help='the path to a gif file')
+    parser.add_argument('-d', '--debug', action='store_true', help='display debug messages to stdout')
+    parser.add_argument('-a', '--show_axis', action='store_true', help='display the grid axis')
+    parser.add_argument('-m', '--max_loops', type=int, default=3, help='maximum number of loops, set to 0 to loop through image until keyboard interrupt (default 3)')
 
     args = parser.parse_args()
 
@@ -36,7 +38,9 @@ def main():
         speed = get_speed(args.speed)
         Animator(
             animation=AsciiAnimation(args.file),
-            speed=speed)
+            speed=speed,
+            show_axis=args.show_axis,
+            max_loops=args.max_loops)
 
     except argparse.ArgumentError:
         parser.print_help()
@@ -47,5 +51,5 @@ def main():
         sys.exit(2)
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     main()