Merge pull request #1 from faif/master

weiplanet · web-flow · commit 2ee57e27c948 · 2021-01-12T16:37:58.000-08:00
sync 2101
diff --git a/.github/workflows/lint_python.yml b/.github/workflows/lint_python.yml
@@ -0,0 +1,20 @@
+name: lint_python
+on: [pull_request, push]
+jobs:
+  lint_python:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - run: pip install --upgrade pip
+      - run: pip install black codespell flake8 isort mypy pytest pyupgrade tox
+      - run: black --check .
+      - run: codespell --quiet-level=2  # --ignore-words-list="" --skip=""
+      - run: flake8 . --count --show-source --statistics
+      - run: isort --profile black .
+      - run: tox
+      - run: pip install -e .
+      - run: mypy --ignore-missing-imports . || true
+      - run: pytest .
+      - run: pytest --doctest-modules . || true
+      - run: shopt -s globstar && pyupgrade --py36-plus **/*.py
diff --git a/.travis.yml b/.travis.yml
@@ -1,21 +1,19 @@
-dist: xenial
+os: linux
+dist: focal
 language: python
 
-sudo: false
-
-matrix:
+jobs:
   include:
     - python: "3.7"
       env: TOXENV=py37
-    - python: "3.8"
-      env: TOXENV=py38
+    - python: "3.9"
+      env: TOXENV=py39
 
 cache:
   - pip
 
 install:
-  - pip install tox
-  - pip install codecov
+  - pip install codecov tox
 
 script:
   - tox
diff --git a/patterns/behavioral/iterator.py b/patterns/behavioral/iterator.py
@@ -10,8 +10,7 @@
 def count_to(count):
     """Counts by word numbers, up to a maximum of five"""
     numbers = ["one", "two", "three", "four", "five"]
-    for number in numbers[:count]:
-        yield number
+    yield from numbers[:count]
 
 
 # Test the generator
diff --git a/patterns/behavioral/memento.py b/patterns/behavioral/memento.py
@@ -66,7 +66,7 @@ def __init__(self, value):
         self.value = value
 
     def __repr__(self):
-        return "<%s: %r>" % (self.__class__.__name__, self.value)
+        return f"<{self.__class__.__name__}: {self.value!r}>"
 
     def increment(self):
         self.value += 1
diff --git a/patterns/behavioral/publish_subscribe.py b/patterns/behavioral/publish_subscribe.py
@@ -46,7 +46,7 @@ def unsubscribe(self, msg):
         self.provider.unsubscribe(msg, self)
 
     def run(self, msg):
-        print("{} got {}".format(self.name, msg))
+        print(f"{self.name} got {msg}")
 
 
 def main():
@@ -65,7 +65,7 @@ def main():
     >>> vani.subscribe("movie")
     >>> vani.unsubscribe("movie")
 
-    # Note that no one subscirbed to `ads`
+    # Note that no one subscribed to `ads`
     # and that vani changed their mind
 
     >>> fftv.publish("cartoon")
diff --git a/patterns/behavioral/template.py b/patterns/behavioral/template.py
@@ -24,7 +24,7 @@ def get_csv():
 
 def convert_to_text(data):
     print("[CONVERT]")
-    return "{} as text".format(data)
+    return f"{data} as text"
 
 
 def saver():
@@ -33,7 +33,7 @@ def saver():
 
 def template_function(getter, converter=False, to_save=False):
     data = getter()
-    print("Got `{}`".format(data))
+    print(f"Got `{data}`")
 
     if len(data) <= 3 and converter:
         data = converter(data)
@@ -43,7 +43,7 @@ def template_function(getter, converter=False, to_save=False):
     if to_save:
         saver()
 
-    print("`{}` was processed".format(data))
+    print(f"`{data}` was processed")
 
 
 def main():
diff --git a/patterns/creational/abstract_factory.py b/patterns/creational/abstract_factory.py
@@ -46,8 +46,8 @@ def show_pet(self):
         """Creates and shows a pet using the abstract factory"""
 
         pet = self.pet_factory()
-        print("We have a lovely {}".format(pet))
-        print("It says {}".format(pet.speak()))
+        print(f"We have a lovely {pet}")
+        print(f"It says {pet.speak()}")
 
 
 class Dog:
diff --git a/patterns/dependency_injection.py b/patterns/dependency_injection.py
@@ -74,7 +74,7 @@ def production_code_time_provider() -> str:
     datetime for this example).
     """
     current_time = datetime.datetime.now()
-    current_time_formatted = "{}:{}".format(current_time.hour, current_time.minute)
+    current_time_formatted = f"{current_time.hour}:{current_time.minute}"
     return current_time_formatted
 
 
diff --git a/patterns/structural/bridge.py b/patterns/structural/bridge.py
@@ -10,13 +10,13 @@
 # ConcreteImplementor 1/2
 class DrawingAPI1:
     def draw_circle(self, x, y, radius):
-        print("API1.circle at {}:{} radius {}".format(x, y, radius))
+        print(f"API1.circle at {x}:{y} radius {radius}")
 
 
 # ConcreteImplementor 2/2
 class DrawingAPI2:
     def draw_circle(self, x, y, radius):
-        print("API2.circle at {}:{} radius {}".format(x, y, radius))
+        print(f"API2.circle at {x}:{y} radius {radius}")
 
 
 # Refined Abstraction
diff --git a/patterns/structural/decorator.py b/patterns/structural/decorator.py
@@ -42,7 +42,7 @@ def __init__(self, wrapped):
         self._wrapped = wrapped
 
     def render(self):
-        return "<b>{}</b>".format(self._wrapped.render())
+        return f"<b>{self._wrapped.render()}</b>"
 
 
 class ItalicWrapper(TextTag):
@@ -52,7 +52,7 @@ def __init__(self, wrapped):
         self._wrapped = wrapped
 
     def render(self):
-        return "<i>{}</i>".format(self._wrapped.render())
+        return f"<i>{self._wrapped.render()}</i>"
 
 
 def main():
diff --git a/patterns/structural/facade.py b/patterns/structural/facade.py
@@ -51,7 +51,7 @@ class Memory:
     """
 
     def load(self, position, data):
-        print("Loading from {0} data: '{1}'.".format(position, data))
+        print(f"Loading from {position} data: '{data}'.")
 
 
 class SolidStateDrive:
@@ -60,7 +60,7 @@ class SolidStateDrive:
     """
 
     def read(self, lba, size):
-        return "Some data from sector {0} with size {1}".format(lba, size)
+        return f"Some data from sector {lba} with size {size}"
 
 
 class ComputerFacade:
diff --git a/patterns/structural/flyweight.py b/patterns/structural/flyweight.py
@@ -53,7 +53,7 @@ def __new__(cls, value, suit):
     #     self.value, self.suit = value, suit
 
     def __repr__(self):
-        return "<Card: {}{}>".format(self.value, self.suit)
+        return f"<Card: {self.value}{self.suit}>"
 
 
 def main():
diff --git a/patterns/structural/front_controller.py b/patterns/structural/front_controller.py
@@ -27,7 +27,7 @@ def dispatch(self, request):
         elif request.type == Request.tablet_type:
             self.tablet_view.show_index_page()
         else:
-            print("cant dispatch the request")
+            print("Cannot dispatch the request")
 
 
 class RequestController:
@@ -69,7 +69,7 @@ def main():
     Displaying tablet index page
 
     >>> front_controller.dispatch_request(Request('desktop'))
-    cant dispatch the request
+    Cannot dispatch the request
 
     >>> front_controller.dispatch_request('mobile')
     request must be a Request object
diff --git a/patterns/structural/mvc.py b/patterns/structural/mvc.py
@@ -29,7 +29,7 @@ class Price(float):
         __str__ functionality."""
 
         def __str__(self):
-            return "{:.2f}".format(self)
+            return f"{self:.2f}"
 
     products = {
         "milk": {"price": Price(1.50), "quantity": 10},
@@ -40,8 +40,7 @@ def __str__(self):
     item_type = "product"
 
     def __iter__(self):
-        for item in self.products:
-            yield item
+        yield from self.products
 
     def get(self, product):
         try:
@@ -86,7 +85,7 @@ def show_item_information(self, item_type, item_name, item_info):
         print(printout)
 
     def item_not_found(self, item_type, item_name):
-        print('That {} "{}" does not exist in the records'.format(item_type, item_name))
+        print(f'That {item_type} "{item_name}" does not exist in the records')
 
 
 class Controller:
diff --git a/tests/creational/test_lazy.py b/tests/creational/test_lazy.py
@@ -1,5 +1,3 @@
-from __future__ import print_function
-
 import unittest
 
 from patterns.creational.lazy_evaluation import Person
@@ -19,7 +17,7 @@ def test_relatives_not_in_properties(self):
         self.assertNotIn("relatives", self.John.__dict__)
 
     def test_extended_properties(self):
-        print(u"John's relatives: {0}".format(self.John.relatives))
+        print(f"John's relatives: {self.John.relatives}")
         self.assertDictEqual(
             {
                 "name": "John",
@@ -31,7 +29,7 @@ def test_extended_properties(self):
         )
 
     def test_relatives_after_access(self):
-        print(u"John's relatives: {0}".format(self.John.relatives))
+        print(f"John's relatives: {self.John.relatives}")
         self.assertIn("relatives", self.John.__dict__)
 
     def test_parents(self):
diff --git a/tests/creational/test_pool.py b/tests/creational/test_pool.py
@@ -31,8 +31,8 @@ def test_frozen_pool(self):
 class TestNaitivePool(unittest.TestCase):
 
     """def test_object(queue):
-           queue_object = QueueObject(queue, True)
-           print('Inside func: {}'.format(queue_object.object))"""
+    queue_object = QueueObject(queue, True)
+    print('Inside func: {}'.format(queue_object.object))"""
 
     def test_pool_behavior_with_single_object_inside(self):
         sample_queue = queue.Queue()
diff --git a/tests/test_hsm.py b/tests/test_hsm.py
@@ -35,16 +35,16 @@ def test_calling_next_state_shall_change_current_state(cls):
         cls.hsm._current_state = Standby(cls.hsm)  # initial state
 
     def test_method_perform_switchover_shall_return_specifically(cls):
-        """ Exemplary HierachicalStateMachine method test.
-        (here: _perform_switchover()). Add additional test cases... """
+        """Exemplary HierachicalStateMachine method test.
+        (here: _perform_switchover()). Add additional test cases..."""
         return_value = cls.hsm._perform_switchover()
         expected_return_value = "perform switchover"
         cls.assertEqual(return_value, expected_return_value)
 
 
 class StandbyStateTest(unittest.TestCase):
-    """ Exemplary 2nd level state test class (here: Standby state). Add missing
-    state test classes... """
+    """Exemplary 2nd level state test class (here: Standby state). Add missing
+    state test classes..."""
 
     @classmethod
     def setUpClass(cls):
diff --git a/tox.ini b/tox.ini
@@ -1,5 +1,6 @@
 [tox]
-envlist = py37,py38,cov-report
+envlist = py37,py38,py39,cov-report
+skip_missing_interpreters = true
 
 
 [testenv]
@@ -8,7 +9,7 @@ setenv =
 deps =
     -r requirements-dev.txt
 commands =
-    flake8 patterns/
+    flake8 . --exclude=./.*
     ; `randomly-seed` option from `pytest-randomly` helps with deterministic outputs for examples like `other/blackboard.py`
     pytest --randomly-seed=1234 --doctest-modules patterns/
     pytest -s -vv --cov={envsitepackagesdir}/patterns --log-level=INFO tests/
