Fix flake8 check and related warnings

Author: gyermolenko

.travis.yml

@@ -20,7 +20,7 @@ script:
   - pytest -s -vv --cov=. --log-level=INFO tests/
   # Actually run all the scripts, contributing to coverage
   - PYTHONPATH=. ./run_all.sh
-  - flake8 *py
+  - flake8 patterns/
 
 after_success:
   - codecov

append_output.sh

@@ -16,4 +16,4 @@ echo "$src" > $1
 echo -e "\n" >> $1
 echo "$output_marker" >> $1
 echo "$output" >> $1
-echo '"""' >> $1
+echo '"""  # noqa' >> $1

patterns/behavioral/command.py

@@ -6,7 +6,8 @@
 Encapsulates all information needed to perform an action or trigger an event.
 
 *Examples in Python ecosystem:
-Django HttpRequest (without `execute` method): https://docs.djangoproject.com/en/2.1/ref/request-response/#httprequest-objects
+Django HttpRequest (without `execute` method):
+ https://docs.djangoproject.com/en/2.1/ref/request-response/#httprequest-objects
 """
 
 from __future__ import print_function

patterns/behavioral/iterator.py

@@ -29,13 +29,9 @@ def main():
     for number in count_to_two():
         print(number, end=' ')
 
-    print()
-
-    print('Counting to five...')
+    print('\nCounting to five...')
     for number in count_to_five():
         print(number, end=' ')
-        
-    print()
 
 
 if __name__ == "__main__":
@@ -47,4 +43,4 @@ def main():
 one two 
 Counting to five...
 one two three four five 
-"""
+"""  # noqa

patterns/behavioral/mediator.py.bkp

@@ -0,0 +1,165 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+http://web.archive.org/web/20120309135549/http://dpip.testingperspective.com/?p=28
+
+*TL;DR80
+Encapsulates how a set of objects interact.
+"""
+
+import random
+import time
+
+
+class TC:
+    """TestCategory
+    responsible for running the tests with the help of setup(), execute() and tearDown() methods
+    """
+
+    def __init__(self):
+        self._tm = None
+        self._bProblem = 0
+
+    def setup(self):
+        print("Setting up the Test")
+        time.sleep(0.1)
+        self._tm.prepareReporting()
+
+    def execute(self):
+        if not self._bProblem:
+            print("Executing the test")
+            time.sleep(0.1)
+        else:
+            print("Problem in setup. Test not executed.")
+
+    def tearDown(self):
+        if not self._bProblem:
+            print("Tearing down")
+            time.sleep(0.1)
+            self._tm.publishReport()
+        else:
+            print("Test not executed. No tear down required.")
+
+    def setTM(self, tm):
+        self._tm = tm
+
+    def setProblem(self, value):
+        self._bProblem = value
+
+
+class Reporter:
+    """
+    - calls its prepare() method while TestCategory starts getting executed
+    - calls its report() method when TestCategory finishes its execution.
+    """
+    def __init__(self):
+        self._tm = None
+
+    def prepare(self):
+        print("Reporter Class is preparing to report the results")
+        time.sleep(0.1)
+
+    def report(self):
+        print("Reporting the results of Test")
+        time.sleep(0.1)
+
+    def setTM(self, tm):
+        self._tm = tm
+
+
+class DB:
+    """
+    stores the execution status of the test category by first
+    calling the insert() method while the test category is in setup(),
+    and then calls the update() method once the test category has finished execution.
+    In this way, at any given point of time, the test execution status is available for framework user to query from the database
+    """
+    def __init__(self):
+        self._tm = None
+
+    def insert(self):
+        print("Inserting the execution begin status in the Database")
+        time.sleep(0.1)
+        # Following code is to simulate a communication from DB to TC
+        if random.randrange(1, 4) == 3:
+            return -1
+
+    def update(self):
+        print("Updating the test results in Database")
+        time.sleep(0.1)
+
+    def setTM(self, tm):
+        self._tm = tm
+
+
+class TestManager:
+    """
+    Mediator between Class TC, Class Reporter and Class DB, the Colleagues in the system
+    coordinates for
+     test category execution (Class TC)
+     and fetching the reports (Class Reporter)
+     and getting the test execution status in database (Class DB) with the help of prepareReporting() and publishReport() methods
+    """
+    def __init__(self):
+        self._reporter = None
+        self._db = None
+        self._tc = None
+
+    def prepareReporting(self):
+        rvalue = self._db.insert()
+        if rvalue == -1:
+            self._tc.setProblem(1)
+            self._reporter.prepare()
+
+    def setReporter(self, reporter):
+        self._reporter = reporter
+
+    def setDB(self, db):
+        self._db = db
+
+    def publishReport(self):
+        self._db.update()
+        self._reporter.report()
+
+    def setTC(self, tc):
+        self._tc = tc
+
+
+if __name__ == '__main__':
+    reporter = Reporter()
+    db = DB()
+    tm = TestManager()
+    tm.setReporter(reporter)
+    tm.setDB(db)
+    reporter.setTM(tm)
+    db.setTM(tm)
+    # For simplification we are looping on the same test.
+    # Practically, it could be about various unique test classes and their
+    # objects
+    for i in range(3):
+        tc = TC()
+        tc.setTM(tm)
+        tm.setTC(tc)
+        tc.setup()
+        tc.execute()
+        tc.tearDown()
+
+### OUTPUT ###
+# Setting up the Test
+# Inserting the execution begin status in the Database
+# Executing the test
+# Tearing down
+# Updating the test results in Database
+# Reporting the results of Test
+# Setting up the Test
+# Inserting the execution begin status in the Database
+# Reporter Class is preparing to report the results
+# Problem in setup. Test not executed.
+# Test not executed. No tear down required.
+# Setting up the Test
+# Inserting the execution begin status in the Database
+# Executing the test
+# Tearing down
+# Updating the test results in Database
+# Reporting the results of Test

patterns/behavioral/memento.py

@@ -98,25 +98,26 @@ def main():
             print(num_obj)
         num_obj.value += 'x'  # will fail
         print(num_obj)
-    except Exception as e:
+    except Exception:
         a_transaction.rollback()
         print('-- rolled back')
     print(num_obj)
 
     print('-- now doing stuff ...')
     try:
         num_obj.do_stuff()
-    except Exception as e:
+    except Exception:
         print('-> doing stuff failed!')
         import sys
         import traceback
 
         traceback.print_exc(file=sys.stdout)
     print(num_obj)
 
+
 if __name__ == '__main__':
     main()
-    
+
 
 OUTPUT = """
 <NumObj: -1>

patterns/behavioral/specification.py

@@ -102,7 +102,7 @@ def main():
     print(root_specification.is_satisfied_by(ivan))
     print(root_specification.is_satisfied_by(vasiliy))
 
-    
+
 if __name__ == '__main__':
     main()
 

patterns/behavioral/state.py

@@ -76,7 +76,7 @@ def main():
     for action in actions:
         action()
 
-        
+
 if __name__ == '__main__':
     main()
 

patterns/behavioral/template.py

@@ -5,7 +5,7 @@
 An example of the Template pattern in Python
 
 *TL;DR80
-Defines the skeleton of a base algorithm, deferring definition of exact 
+Defines the skeleton of a base algorithm, deferring definition of exact
 steps to subclasses.
 
 *Examples in Python ecosystem:

patterns/fundamental/delegation_pattern.py

@@ -32,7 +32,7 @@ def __init__(self, delegate):
 
     def __getattr__(self, name):
         attr = getattr(self.delegate, name)
-        
+
         if not callable(attr):
             return attr
 

patterns/structural/flyweight.py

@@ -119,8 +119,8 @@ def __init__(self, *args, **kwargs):
     cm2 = Card2('10', 'h', a=1)
     cm3 = Card2('10', 'h', a=2)
 
-    assert (cm1 == cm2) and ( cm1 != cm3)
-    assert (cm1 is cm2) and ( cm1 is not cm3)
+    assert (cm1 == cm2) and (cm1 != cm3)
+    assert (cm1 is cm2) and (cm1 is not cm3)
     assert len(instances_pool) == 2
 
     del cm1

setup.cfg

@@ -2,3 +2,8 @@
 max-line-length = 120
 ignore = E266 E731
 exclude = .venv*
+
+[tool:pytest]
+filterwarnings =
+    ; ignore TestRunner class from facade example
+    ignore:.*test class 'TestRunner'.*:Warning

setup.py

@@ -7,8 +7,7 @@
         "Programming Language :: Python :: 2",
         "Programming Language :: Python :: 2.7",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.4",
-        "Programming Language :: Python :: 3.5",
         "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
     ],
 )