Merge pull request faif#417 from grimley517/faif#415-linter-preventin…

…g-prs

faif#415 linter preventing prs

.github/workflows/lint_python.yml

@@ -8,15 +8,6 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: 3.x
-      - 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 --py37-plus **/*.py
+      - shell: bash
+        name: Lint and test
+        run: ./lint.sh

.gitignore

@@ -10,3 +10,5 @@ venv/
 .vscode/
 .python-version
 .coverage
+build/
+dist/

README.md

@@ -105,7 +105,12 @@ To see Python 2 compatible versions of some patterns please check-out the [legac
 When everything else is done - update corresponding part of README.
 
 ##### Travis CI
-Please run `tox` or `tox -e ci37` before submitting a patch to be sure your changes will pass CI.
+Please run the following before submitting a patch
+- `black .` This lints your code.
+
+Then either:
+- `tox` or `tox -e ci37` This runs unit tests. see tox.ini for further details.
+- If you have a bash compatible shell use `./lint.sh` This script will lint and test your code. This script mirrors the CI pipeline actions.      
 
 You can also run `flake8` or `pytest` commands manually. Examples can be found in `tox.ini`.
 

lint.sh

@@ -0,0 +1,14 @@
+#! /bin/bash
+
+pip install --upgrade pip
+pip install black codespell flake8 isort mypy pytest pyupgrade tox
+black --check .
+codespell --quiet-level=2  # --ignore-words-list="" --skip=""
+flake8 . --count --show-source --statistics
+isort --profile black .
+tox
+pip install -e .
+mypy --ignore-missing-imports . || true
+pytest .
+pytest --doctest-modules . || true
+shopt -s globstar && pyupgrade --py37-plus **/*.py

patterns/behavioral/catalog.py

@@ -46,7 +46,6 @@ def main_method(self) -> None:
 
 # Alternative implementation for different levels of methods
 class CatalogInstance:
-
     """catalog of multiple methods that are executed depending on an init
 
     parameter
@@ -82,7 +81,6 @@ def main_method(self) -> None:
 
 
 class CatalogClass:
-
     """catalog of multiple class methods that are executed depending on an init
 
     parameter
@@ -121,7 +119,6 @@ def main_method(self):
 
 
 class CatalogStatic:
-
     """catalog of multiple static methods that are executed depending on an init
 
     parameter

patterns/behavioral/iterator_alt.py

@@ -4,6 +4,7 @@
 *TL;DR
 Traverses a container and accesses the container's elements.
 """
+
 from __future__ import annotations
 
 

patterns/behavioral/memento.py

@@ -5,8 +5,8 @@
 Provides the ability to restore an object to its previous state.
 """
 
-from typing import Callable, List
 from copy import copy, deepcopy
+from typing import Callable, List
 
 
 def memento(obj, deep=False):

patterns/behavioral/publish_subscribe.py

@@ -4,7 +4,6 @@
 Author: https://github.com/HanWenfang
 """
 
-
 from __future__ import annotations
 
 

patterns/behavioral/strategy.py

@@ -7,7 +7,6 @@
 Enables selecting an algorithm at runtime.
 """
 
-
 from __future__ import annotations
 
 from typing import Callable
@@ -56,7 +55,8 @@ def apply_discount(self) -> float:
         return self.price - discount
 
     def __repr__(self) -> str:
-        return f"<Order price: {self.price} with discount strategy: {getattr(self.discount_strategy,'__name__',None)}>"
+        strategy = getattr(self.discount_strategy, "__name__", None)
+        return f"<Order price: {self.price} with discount strategy: {strategy}>"
 
 
 def ten_percent_discount(order: Order) -> float:

patterns/creational/abstract_factory.py

@@ -62,7 +62,6 @@ def __str__(self) -> str:
 
 
 class PetShop:
-
     """A pet shop"""
 
     def __init__(self, animal_factory: Type[Pet]) -> None:
@@ -78,14 +77,6 @@ def buy_pet(self, name: str) -> Pet:
         return pet
 
 
-# Additional factories:
-
-# Create a random animal
-def random_animal(name: str) -> Pet:
-    """Let's be dynamic!"""
-    return random.choice([Dog, Cat])(name)
-
-
 # Show pets with various factories
 def main() -> None:
     """
@@ -95,27 +86,10 @@ def main() -> None:
     Here is your lovely Cat<Lucy>
     >>> pet.speak()
     meow
-
-    # A shop that sells random animals
-    >>> shop = PetShop(random_animal)
-    >>> for name in ["Max", "Jack", "Buddy"]:
-    ...    pet = shop.buy_pet(name)
-    ...    pet.speak()
-    ...    print("=" * 20)
-    Here is your lovely Cat<Max>
-    meow
-    ====================
-    Here is your lovely Dog<Jack>
-    woof
-    ====================
-    Here is your lovely Dog<Buddy>
-    woof
-    ====================
     """
 
 
 if __name__ == "__main__":
-    random.seed(1234)  # for deterministic doctest outputs
     shop = PetShop(random_animal)
     import doctest
 

patterns/creational/borg.py

@@ -32,6 +32,7 @@
 *TL;DR
 Provides singleton-like behavior sharing state between instances.
 """
+
 from typing import Dict
 
 

patterns/creational/factory.py

@@ -21,9 +21,8 @@
 *TL;DR
 Creates objects without having to specify the exact class.
 """
-from typing import Dict
-from typing import Protocol
-from typing import Type
+
+from typing import Dict, Protocol, Type
 
 
 class Localizer(Protocol):
@@ -50,7 +49,6 @@ def localize(self, msg: str) -> str:
 
 
 def get_localizer(language: str = "English") -> Localizer:
-
     """Factory"""
     localizers: Dict[str, Type[Localizer]] = {
         "English": EnglishLocalizer,

patterns/creational/prototype.py

@@ -20,6 +20,7 @@
 *TL;DR
 Creates new object instances by cloning prototype.
 """
+
 from __future__ import annotations
 
 from typing import Any

patterns/other/blackboard.py

@@ -8,6 +8,7 @@
 
 https://en.wikipedia.org/wiki/Blackboard_system
 """
+
 from __future__ import annotations
 
 import abc

patterns/other/graph_search.py

@@ -1,5 +1,4 @@
 class GraphSearch:
-
     """Graph search emulation in python, from source
     http://www.python.org/doc/essays/graphs/
 

tests/behavioral/test_strategy.py

@@ -1,6 +1,6 @@
 import pytest
 
-from patterns.behavioral.strategy import Order, ten_percent_discount, on_sale_discount
+from patterns.behavioral.strategy import Order, on_sale_discount, ten_percent_discount
 
 
 @pytest.fixture

tests/creational/test_pool.py

@@ -29,7 +29,6 @@ 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))"""