Prerequisites and Assumptions
Here’s an outline of what I’m assuming about you and what you already know, as well as what software you’ll need ready and installed on your computer.
Python 3 and Programming
I’ve tried to write this book with beginners in mind, but if you’re new to programming, I’m assuming that you’ve already learned the basics of Python. So if you haven’t already, do run through a Python beginner’s tutorial or get an introductory book like Dive Into Python or Learn Python the Hard Way, or, just for fun, Invent Your Own Computer Games with Python, all of which are excellent introductions.
If you’re an experienced programmer but new to Python, you should get along just fine. Python is joyously simple to understand.
I’m using Python 3 for this book. When I wrote the first edition in 2013–14, Python 3 had been around for several years, and the world was just about on the tipping point at which it was the preferred choice. You should be able to follow this book on Mac, Windows, or Linux. Detailed installation instructions for each OS follow.
|This book was tested against Python 3.6. If you’re on an earlier version, you will find minor differences (the f-string syntax, for example), so you’re best off upgrading if you can.|
I wouldn’t recommend trying to use Python 2, as the differences are more substantial. You’ll still be able to carry across all the lessons you learn in this book if your next project happens to be in Python 2. But spending time figuring out whether the reason your program output looks different from mine is because of Python 2, or because you made an actual mistake, won’t be time spent productively.
In any case, I expect you to have access to Python, to know how to launch it from a command line, and to know how to edit a Python file and run it. Again, have a look at the three books I recommended previously if you’re in any doubt.
|If you already have Python 2 installed, and you’re worried that installing Python 3 will break it in some way, don’t! Python 3 and 2 can coexist peacefully on the same system, particularly if you’re using a virtualenv, which we will be.|
How HTML Works
I’m also assuming you have a basic grasp of how the web works—what HTML is, what a POST request is, and so on. If you’re not sure about those, you’ll need to find a basic HTML tutorial; there are a few at http://www.webplatform.org/. If you can figure out how to create an HTML page on your PC and look at it in your browser, and understand what a form is and how it might work, then you’re probably OK.
The book uses the Django framework, which is (probably) the most well-established web framework in the Python world. I’ve written the book assuming that the reader has no prior knowledge of Django, but if you’re new to Python and new to web development and new to testing, you may occasionally find that there’s just one too many topics and sets of concepts to try and take on board. If that’s the case, I recommend taking a break from the book, and taking a look at a Django tutorial. DjangoGirls is the best, most beginner-friendly tutorial I know of. The official tutorial is also excellent for more experienced programmers (make sure you follow the 1.11 tutorial rather than a 2.x one though).
|This book was published before Django 2.0 came out, and as such is written for Django v1.11 (which is an "long-term-support" or LTS edition). If you’re keen to use Django 2, I strongly recommend doing so after you’ve read this book, in your own projects, rather than installing it now and trying to adapt as you go along. Django hasn’t changed that much, but when things look different on your own PC from what the book says should happen, you’ll waste time trying to figure out whether it’s because Django has changed, or because you’ve made a mistake.|
Read on for instructions on installing Django.
Required Software Installations
Aside from Python, you’ll need:
- The Firefox web browser
Selenium can actually drive any of the major browsers, but Firefox is the best to use as an example because it’s reliably cross-platform and, as a bonus, is less sold out to corporate interests.
- The Git version control system
This is available for any platform, at http://git-scm.com/. On Windows, this comes with the Bash command line, which is needed for the book.
- A virtualenv with Python 3, Django 1.11, and Selenium 3 in it
Python’s virtualenv and pip tools now come bundled with Python 3.4+ (they didn’t always used to, so this is a big hooray). Detailed instructions for preparing your virtualenv follow.
This is the driver that will let us remotely control Firefox via Selenium. I’ll point to a download link in Installing Firefox and Geckodriver.
Git’s Default Editor, and Other Basic Git Config
provide step-by-step instructions for Git, but it may be a good idea to
get a bit of configuration done now. For example, when you do your first
commit, by default vi will pop up, at which point you may have no idea what
to do with it. Well, much as vi has two modes, you then have two choices. One
is to learn some minimal vi commands (press the i key to go into insert mode,
type your text, press
<Esc> to go back to normal mode, then write the file
and quit with
:wq<Enter>). You’ll then have joined the great fraternity of
people who know this ancient, revered text editor.
Or you can point-blank refuse to be involved in such a ridiculous throwback to
the 1970s, and configure Git to use an editor of your choice. Quit vi using
<Esc> followed by
:q!, then change your Git default editor. See the Git
basic Git configuration.
Installing Firefox and Geckodriver
Firefox is available as a download for Windows and macOS from https://www.mozilla.org/firefox/. On Linux, you probably already have it installed, but otherwise your package manager will have it.
Geckodriver is available from https://github.com/mozilla/geckodriver/releases. You need to download and extract it and put it somewhere on your system path.
For Windows, you can just put it in the same folder as your code for this book—or if you put it in your Python Scripts folder, it’ll be available for other projects.
For macOS or Linux, one convenient place to put it is /usr/local/bin (you’ll need
To test that you’ve got this working, open up a Bash console and you should be able to run:
$ geckodriver --version geckodriver 0.20.1 The source code of this program is available at https://github.com/mozilla/geckodriver. This program is subject to the terms of the Mozilla Public License 2.0. You can obtain a copy of the license at https://mozilla.org/MPL/2.0/.
Setting Up Your Virtualenv
A Python virtualenv (short for virtual environment) is how you set up your environment for different Python projects. It allows you to use different packages (e.g., different versions of Django, and even different versions of Python) in each project. And because you’re not installing things system-wide, it means you don’t need root permissions.
Let’s create a Python 3 virtualenv. I’m assuming you’re working in a folder called python-tdd-book, but you can name your work folder whatever you like. Stick to the name "virtualenv" for the virtualenv, though.
$ cd python-tdd-book $ py -3.6 -m venv virtualenv
On Windows, the
py executable is a shortcut for different Python versions. On
Mac or Linux, we use
$ cd python-tdd-book $ python3.6 -m venv virtualenv
Activating and Deactivating the Virtualenv
Whenever you work on the book, you’ll want to make sure your virtualenv has
been "activated". You can always tell when your virtualenv is active because
(virtualenv) in parentheses, in your prompt. But you can
also check by running
which python to check whether Python is currently
the system-installed one, or the virtualenv one.
The command to activate the virtualenv is
source virtualenv/Scripts/activate on
source virtualenv/bin/activate on Mac/Linux. The command to
deactivate is just
Try it out like this:
$ source virtualenv/Scripts/activate (virtualenv)$ (virtualenv)$ which python /C/Users/harry/python-tdd-book/virtualenv/Scripts/python (virtualenv)$ deactivate $ $ which python /c/Users/harry/AppData/Local/Programs/Python/Python36-32/python
$ source virtualenv/bin/activate (virtualenv)$ (virtualenv)$ which python /home/myusername/python-tdd-book/virtualenv/bin/python (virtualenv)$ deactivate $ $ which python /usr/bin/python
Always make sure your virtualenv is active when working on the book. Look
out for the
Installing Django and Selenium
We’ll install Django 1.11 and the latest Selenium, Selenium 3.
Remember to make sure your virtualenv is active first!
(virtualenv) $ pip install "django<1.12" "selenium<4" Collecting django==1.11.13 Using cached Django-1.11.13-py2.py3-none-any.whl Collecting selenium<4 Using cached selenium-3.12.0-py2.py3-none-any.whl Installing collected packages: django, selenium Successfully installed django-1.11.13 selenium-3.12.0
Some Error Messages You’re Likely to See When You Inevitably Fail to Activate Your Virtualenv
If you’re new to virtualenvs—or even if you’re not, to be honest—at some point you’re guaranteed to forget to activate it, and then you’ll be staring at an error message. Happens to me all the time. Here are some of the things to look out for:
ImportError: No module named selenium
ImportError: No module named django.core.management
As always, look out for that
(virtualenv) in your command prompt, and a
source virtualenv/Scripts/activate or
virtualenv/bin/activate is probably what you need to get it working again.
Here’s a couple more, for good measure:
bash: virtualenv/Scripts/activate: No such file or directory
This means you’re not currently in the right directory for working on the
project. Try a
cd tdd-python-book, or similar.
Alternatively, if you’re sure you’re in the right place, you may have run into a bug from an older version of Python, where it wouldn’t install an activate script that was compatible with Git-Bash. Reinstall Python 3, and make sure you have version 3.6.3 or later, and then delete and re-create your virtualenv.
If you see something like this, it’s probably the same issue, you need to upgrade Python:
bash: @echo: command not found bash: virtualenv/Scripts/activate.bat: line 4: syntax error near unexpected token `( bash: virtualenv/Scripts/activate.bat: line 4: `if not defined PROMPT ('
Final one! If you see this:
'source' is not recognized as an internal or external command, operable program or batch file.
It’s because you’ve launched the default Windows command prompt,
instead of Git-Bash. Close it and open the latter.
|Did these instructions not work for you? Or have you got better ones? Get in touch: [email protected]!|