[TASK] Improve expectation handling

Author: elmar-hinz

.gitignore

@@ -8,4 +8,4 @@ _build/
 latest.txt
 next.txt
 .idea
-
+challenges.env

challenges/__init__.py

@@ -1,6 +1,7 @@
-from challenges.graph import Graph, Node, Edge
-from challenges.conf import Conf
 from challenges.challenge import Challenge
+from challenges.conf import Conf
+from challenges.graph import Graph, Node, Edge
 from challenges.scaffold import Scaffold
 from challenges.runner import Runner
 from challenges.main import main
+

challenges/challenge.py

@@ -58,10 +58,25 @@ class Challenge:
 
     """
 
-    sample = 'sample'
-    """Holds a minimal example of the input.
+    sample = '''
+        sample
+        sample
+    '''
+    """Holds a minimal example of the input with additional whitespace.
 
     This class variable should always be preset with a tiny sample of input.
+    Whitespace surrounding lines is for readability. It typically needs to be 
+    stripped to get the actual sample.
+    """
+
+    expect = '''
+        expected result
+        expected result
+    '''
+    """Holds the expected result with additional leading whitespace.
+    
+    Whitespace surrounding lines is for readability. It typically needs to be 
+    stripped to get the actual expactation.
     """
 
     br = '\n'
@@ -135,8 +150,7 @@ def read(self):
 
         Typically this method can be used as is.
         """
-        lines = self.sample.strip().splitlines()
-        self.lines = [line.strip() for line in lines]
+        self.lines = self.example().splitlines()
 
     def build(self):
         """Set up the model from the input lines.
@@ -171,13 +185,36 @@ def format(self):
         self.output = str(self.result)
 
     # --------------------------------------------------
-    # Accessing lines
+    # Accessing example and expectation
+    # --------------------------------------------------
+
+    def example(self):
+        """Get the sample, with heading whitespace trimmed"""
+        lines = self.sample.strip().splitlines()
+        return '\n'.join(line.strip() for line in lines)
+
+    def expectation(self):
+        """Get the expecation, with heading whitespace trimmed"""
+        lines = self.expect.strip().splitlines()
+        return '\n'.join(line.strip() for line in lines)
+
+    # --------------------------------------------------
+    # Accessing input lines
     # --------------------------------------------------
 
     def line(self, number):
         """ Return one line by the given number. """
         return self.lines[number]
 
+    def line_to_words(self, line_nr):
+        """ Split one line into  a list of words.
+
+        The number of the line is selected by line_nr.
+        The split behaviour can be adjusted by changing self.split_pattern.
+        """
+
+        return list(re.compile(self.split_pattern).split(self.line(line_nr)))
+
     def line_to_integers(self, line_nr):
         """ Split one line into  a list of integers.
 
@@ -188,6 +225,14 @@ def line_to_integers(self, line_nr):
         return [int(i) for i in
                 re.compile(self.split_pattern).split(self.line(line_nr))]
 
+    def line_to_integer(self, line_nr):
+        """ Return line as integer.
+
+        The number of the line is selected by line_nr.
+        """
+
+        return int(self.line(line_nr))
+
     def line_to_floats(self, line_nr):
         """ Split one line into  a list of floats.
 
@@ -271,6 +316,12 @@ def fasta(self, start=0, stop=None):
         # Yield final sequence
         yield name, sequence
 
+    def fasta_strands(self, start=0, stop=None):
+        """ Get the strands of a fasta read as list.
+
+        Takes the same arguments as self.fasta() and delegates to it.
+        """
+        return list(dict(self.fasta(start, stop)).values())
 
     # noinspection PyMethodMayBeStatic
     def _to_edge(self, match):

challenges/conf.py

@@ -8,7 +8,7 @@
 class Conf:
     def __init__(self):
         sys.path.insert(0, '.')
-        sys.setrecursionlimit(5000)
+        sys.setrecursionlimit(15000)
         self.root = os.path.realpath('.')
         self.parser = None
         self.args = None

challenges/main.py

@@ -1,5 +1,5 @@
-from challenges import Conf
-from challenges import Runner
+from challenges.conf import Conf
+from challenges.runner import Runner
 
 
 def main():

challenges/runner.py

@@ -2,7 +2,7 @@
 import time
 import unittest
 
-from challenges import Scaffold
+from challenges.scaffold import Scaffold
 
 
 class Runner:

challenges/scaffold.py

@@ -47,6 +47,7 @@ def scaffold(self):
 
     def get_class_content(self):
         text = '''
+# https://github.com/elmar-hinz/Python.Challenges
 from challenges import Challenge
 
 class {}Challenge(Challenge):
@@ -88,7 +89,7 @@ def test_format(self):
 
     def test_full_integration(self):
         self.challenge.main()
-        self.assertEqual(self.challenge.expect, self.challenge.output)
+        self.assertEqual(self.challenge.expectation(), self.challenge.output)
 '''
         n = self.conf.get_challenge_name()
         return text.strip().format(n, n, n, n, n)

tests/test_challenge.py

@@ -6,14 +6,16 @@
 
 
 class ChallengeTestCase(unittest.TestCase):
+
     """Test cases of the challenge base class."""
 
     def setUp(self):
         self.challenge = Challenge()
 
     def test_class_attributes(self):
         """Check setting of class attributes."""
-        self.assertEqual(Challenge.sample, 'sample')
+        self.assertIn('sample', self.challenge.sample)
+        self.assertIn('expected result', self.challenge.expect)
         self.assertEqual(Challenge.br, '\n', Challenge.br)
         self.assertEqual(Challenge.split_pattern, '\s+|\s?,\s?')
         self.assertEqual(Challenge.edge_pattern, '^(\d+)->(\d+)(:(\d+))?$')
@@ -27,11 +29,19 @@ def test_instance_attributes(self):
 
     def test_instance_shadows_class_attribute_of_sample(self):
         """ Show that instance attribute shadows class attribute."""
-        self.assertEqual(Challenge.sample, 'sample')
-        self.assertEqual(self.challenge.sample, 'sample')
+        self.assertIn('sample', Challenge.sample)
+        self.assertIn('sample', self.challenge.sample)
         self.challenge.sample = 'mine'
-        self.assertEqual(Challenge.sample, 'sample')
-        self.assertEqual(self.challenge.sample, 'mine')
+        self.assertIn('sample', Challenge.sample)
+        self.assertIn('mine', self.challenge.sample)
+
+    def test_instance_shadows_class_attribute_of_expect(self):
+        """ Show that instance attribute shadows class attribute."""
+        self.assertIn('expected result', Challenge.expect)
+        self.assertIn('expected result', self.challenge.expect)
+        self.challenge.expect = 'my result'
+        self.assertIn('expected result', Challenge.expect)
+        self.assertIn('my result', self.challenge.expect)
 
     def test_read(self):
         """Show that read creates list of lines."""
@@ -227,6 +237,18 @@ def test_read_fasta_format(self):
         self.assertIn('FAS_2', fasta.keys())
         self.assertEqual('AAATTT', fasta['FAS_2'])
 
+    def test_fasta_strands(self):
+        """ Check the method works as expected. """
+        self.challenge.sample = '''
+        >FAS_1
+        AAA
+        >FAS_2
+        CCC
+        '''
+        self.challenge.read()
+        result = self.challenge.fasta_strands()
+        self.assertEqual(['AAA', 'CCC'], result)
+
     def test_format_list_of_integers(self):
         """Show concatenation of list of integers."""
         self.assertEqual(self.challenge.format_list_of_integers([1, 2]),