black into chap 4 on refactoring

Author: hjwp

chapter_philosophy_and_refactoring.asciidoc

@@ -131,7 +131,7 @@ FAIL: test_can_start_a_list_and_retrieve_it_later
 Traceback (most recent call last):
   File "...python-tdd-book/functional_tests.py", line 19, in
 test_can_start_a_list_and_retrieve_it_later
-    self.fail('Finish the test!')
+    self.fail("Finish the test!")
 AssertionError: Finish the test!
 
  ---------------------------------------------------------------------
@@ -165,8 +165,8 @@ from selenium.webdriver.common.keys import Keys
 import time
 import unittest
 
-class NewVisitorTest(unittest.TestCase):
 
+class NewVisitorTest(unittest.TestCase):
     def setUp(self):
         self.browser = webdriver.Firefox()
 
@@ -176,39 +176,34 @@ class NewVisitorTest(unittest.TestCase):
     def test_can_start_a_list_and_retrieve_it_later(self):
         # Edith has heard about a cool new online to-do app. She goes
         # to check out its homepage
-        self.browser.get('http://localhost:8000')
+        self.browser.get("http://localhost:8000")
 
         # She notices the page title and header mention to-do lists
-        self.assertIn('To-Do', self.browser.title)
-        header_text = self.browser.find_element(By.TAG_NAME, 'h1').text  #<1>
-        self.assertIn('To-Do', header_text)
+        self.assertIn("To-Do", self.browser.title)
+        header_text = self.browser.find_element(By.TAG_NAME, "h1").text  # <1>
+        self.assertIn("To-Do", header_text)
 
         # She is invited to enter a to-do item straight away
-        inputbox = self.browser.find_element(By.ID, 'id_new_item')  #<1>
-        self.assertEqual(
-            inputbox.get_attribute('placeholder'),
-            'Enter a to-do item'
-        )
+        inputbox = self.browser.find_element(By.ID, "id_new_item")  # <1>
+        self.assertEqual(inputbox.get_attribute("placeholder"), "Enter a to-do item")
 
-        # She types "Buy peacock feathers" into a text box (Edith's hobby
-        # is tying fly-fishing lures)
-        inputbox.send_keys('Buy peacock feathers')  #<2>
+        # She types "Buy peacock feathers" into a text box
+        # (Edith's hobby is tying fly-fishing lures)
+        inputbox.send_keys("Buy peacock feathers")  # <2>
 
         # When she hits enter, the page updates, and now the page lists
         # "1: Buy peacock feathers" as an item in a to-do list table
-        inputbox.send_keys(Keys.ENTER)  #<3>
-        time.sleep(1)  #<4>
+        inputbox.send_keys(Keys.ENTER)  # <3>
+        time.sleep(1)  # <4>
 
-        table = self.browser.find_element(By.ID, 'id_list_table')
-        rows = table.find_elements(By.TAG_NAME, 'tr')  #<1>
-        self.assertTrue(
-            any(row.text == '1: Buy peacock feathers' for row in rows)
-        )
+        table = self.browser.find_element(By.ID, "id_list_table")
+        rows = table.find_elements(By.TAG_NAME, "tr")  # <1>
+        self.assertTrue(any(row.text == "1: Buy peacock feathers" for row in rows))
 
-        # There is still a text box inviting her to add another item. She
-        # enters "Use peacock feathers to make a fly" (Edith is very
-        # methodical)
-        self.fail('Finish the test!')
+        # There is still a text box inviting her to add another item.
+        # She enters "Use peacock feathers to make a fly"
+        # (Edith is very methodical)
+        self.fail("Finish the test!")
 
         # The page updates again, and now shows both items on her list
         [...]
@@ -371,14 +366,15 @@ https://docs.djangoproject.com/en/1.11/intro/tutorial03/#write-views-that-actual
 Mmmh, syntax-highlighted...much nicer! Now to change our view function:
 
 [role="sourcecode"]
-.lists/views.py
+.lists/views.py (ch04l002)
 ====
 [source,python]
 ----
 from django.shortcuts import render
 
+
 def home_page(request):
-    return render(request, 'home.html')
+    return render(request, "home.html")
 ----
 ====
 
@@ -395,6 +391,7 @@ NOTE: Templates are a very powerful feature of Django's, and their main
     why we use `render` and (later) +render_to&#8203;_string+ rather
     than, say, manually reading the file from disk with the built-in `open`.
 
+
 Let's see if it works:
 
 [subs="specialcharacters,macros,callouts"]
@@ -410,7 +407,7 @@ Traceback (most recent call last):
     response = home_page(request)  <3>
                ^^^^^^^^^^^^^^^^^^
   File ...python-tdd-book/lists/views.py", line 5, in home_page
-    return render(request, 'home.html')  <4>
+    return render(request, "home.html")  <4>
            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   File ".../django/shortcuts.py", line 24, in render
     content = loader.render_to_string(template_name, context, request, using=using)
@@ -459,32 +456,32 @@ well. Belt and braces. Open it up and look for a variable called
 # Application definition
 
 INSTALLED_APPS = [
-    'django.contrib.admin',
-    'django.contrib.auth',
-    'django.contrib.contenttypes',
-    'django.contrib.sessions',
-    'django.contrib.messages',
-    'django.contrib.staticfiles',
-    'lists',
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "lists.apps.ListsConfig",
 ]
 ----
 ====
 
-//TODO: the new way of adding it would be lists.apps.ListConfig
-
 
-You can see there's lots of apps already in there by default.  We just need to
-add ours, `lists`, to the bottom of the list.  Don't forget the trailing
-comma--it may not be required, but one day you'll be really annoyed when you
-forget it and Python concatenates two strings on different lines...
+You can see there's lots of apps already in there by default.
+We just need to add ours, using the name `lists.app.ListsConfig`,
+to the bottom of the list.
+Don't forget the trailing comma--it may not be required,
+but one day you'll be really annoyed when you forget it
+and Python concatenates two strings on different lines...
 
 Now we can try running the tests again:
 
 [subs="specialcharacters,macros"]
 ----
 $ pass:quotes[*python manage.py test*]
     [...]
-    self.assertTrue(html.endswith('</html>'))
+    self.assertTrue(html.endswith("</html>"))
 AssertionError: False is not true
 ----
 
@@ -509,7 +506,7 @@ additional newline (`\n`) at the end. We can get them to pass like this:
 ====
 [source,python]
 ----
-self.assertTrue(html.strip().endswith('</html>'))
+self.assertTrue(html.strip().endswith("</html>"))
 ----
 ====
 
@@ -547,8 +544,8 @@ from django.template.loader import render_to_string
     def test_home_page_returns_correct_html(self):
         request = HttpRequest()
         response = home_page(request)
-        html = response.content.decode('utf8')
-        expected_html = render_to_string('home.html')
+        html = response.content.decode("utf8")
+        expected_html = render_to_string("home.html")
         self.assertEqual(html, expected_html)
 ----
 ====
@@ -567,15 +564,15 @@ Here's how it looks:
 ====
 [source,python]
 ----
-    def test_home_page_returns_correct_html(self):
-        response = self.client.get('/')  #<1>
+def test_home_page_returns_correct_html(self):
+    response = self.client.get("/")  # <1>
 
-        html = response.content.decode('utf8')  #<2>
-        self.assertTrue(html.startswith('<html>'))
-        self.assertIn('<title>To-Do lists</title>', html)
-        self.assertTrue(html.strip().endswith('</html>'))
+    html = response.content.decode("utf8")  # <2>
+    self.assertTrue(html.startswith("<html>"))
+    self.assertIn("<title>To-Do lists</title>", html)
+    self.assertTrue(html.strip().endswith("</html>"))
 
-        self.assertTemplateUsed(response, 'home.html')  #<3>
+    self.assertTemplateUsed(response, "home.html")  # <3>
 ----
 ====
 
@@ -607,7 +604,7 @@ deliberately break it:
 ====
 [source,python]
 ----
-        self.assertTemplateUsed(response, 'wrong.html')
+self.assertTemplateUsed(response, "wrong.html")
 ----
 ====
 
@@ -630,11 +627,11 @@ Django Test Client.  We've combined two long-winded tests into one!
 ----
 from django.test import TestCase
 
-class HomePageTest(TestCase):
 
+class HomePageTest(TestCase):
     def test_uses_home_template(self):
-        response = self.client.get('/')
-        self.assertTemplateUsed(response, 'home.html')
+        response = self.client.get("/")
+        self.assertTemplateUsed(response, "home.html")
 ----
 ====
 
@@ -671,11 +668,12 @@ On Refactoring
 ~~~~~~~~~~~~~~
 
 
-((("unit tests", "refactoring in")))((("refactoring")))That
-was an absolutely trivial example of refactoring. But, as Kent Beck puts
-it in <<tddbe,'Test-Driven Development: By Example'>>, "Am I recommending that
-you actually work this way? No. I'm recommending that you be 'able' to work
-this way".
+((("unit tests", "refactoring in")))
+((("refactoring")))
+That was an absolutely trivial example of refactoring.
+But, as Kent Beck puts it in <<tddbe,'Test-Driven Development: By Example'>>,
+"Am I recommending that you actually work this way? No.
+I'm recommending that you be 'able' to work this way".
 
 In fact, as I was writing this my first instinct was to dive in and change the
 test first--make it use the `assertTemplateUsed` function straight away;
@@ -808,9 +806,9 @@ empty...
 Now what does the FT say?
 
 ----
-  File "functional_tests.py", line 43, in
+  File "...python-tdd-book/functional_tests.py", line 40, in
 test_can_start_a_list_and_retrieve_it_later
-    any(row.text == '1: Buy peacock feathers' for row in rows)
+    self.assertTrue(any(row.text == "1: Buy peacock feathers" for row in rows))
 AssertionError: False is not true
 ----
 
@@ -823,13 +821,13 @@ a custom error message as an argument to most `assertX` methods in `unittest`:
 
 
 [role="sourcecode"]
-.functional_tests.py
+.functional_tests.py (ch04l015)
 ====
 [source,python]
 ----
     self.assertTrue(
-        any(row.text == '1: Buy peacock feathers' for row in rows),
-        "New to-do item did not appear in table"
+        any(row.text == "1: Buy peacock feathers" for row in rows),
+        "New to-do item did not appear in table",
     )
 ----
 ====

source/blackify-chap.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+set -e
+
+PREV=$1
+CHAP=$2
+
+# assumes a git remote local pointing at a local bare repo...
+REPO=local
+
+cd $CHAP/superlists
+
+git fetch $REPO
+
+STARTCOMMIT="$(git rev-parse $PREV)"
+ENDCOMMIT="$(git rev-parse $CHAP)"
+
+git checkout $CHAP
+git reset --hard $REPO/$PREV
+
+git rev-list $STARTCOMMIT^..$ENDCOMMIT| tac | xargs -n1 sh -c 'git co $0 -- . && black . && git commit -am "$(git show -s --format=%B $0)"'
+
+git diff -w $REPO/$CHAP
+
+
+cd ../..

source/chapter_philosophy_and_refactoring/superlists

@@ -525,7 +525,7 @@ def assert_console_output_correct(self, actual, expected, ls=False):
             elif line.startswith(' '):
                 self.assertLineIn(line, actual_lines)
             else:
-                self.assertLineIn(line, [l.strip() for l in actual_lines])
+                self.assertLineIn(line.rstrip(), [l.strip() for l in actual_lines])
 
         if len(expected_lines) > 4 and '[...' not in expected_fixed:
             if expected.type != 'qunit output':