\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{hvid2301} \pdfinfo{ /Title (pytest-usage.pdf) /Creator (Cheatography) /Author (hvid2301) /Subject (pytest usage Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{48A30B} \definecolor{LightBackground}{HTML}{F3F9EF} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{pytest usage Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{hvid2301} via \textcolor{DarkBackground}{\uline{cheatography.com/186766/cs/39050/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}hvid2301 \\ \uline{cheatography.com/hvid2301} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 1st June, 2023.\\ Updated 1st June, 2023.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{2} \begin{tabularx}{8.4cm}{p{0.8 cm} p{0.8 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Installation}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{pip install pytest} \tn % Row Count 1 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4.24 cm} x{3.76 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Running pytest}} \tn % Row 0 \SetRowColor{LightBackground} pytest test\_mod.py & Run tests in module \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} pytest testing/ & Run multiple modules \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} pytest \seqsplit{test\_mod.py::test\_func} & Run a specific test within a module. \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} pytest \seqsplit{test\_mod.py::TestClass::test\_method} & Run a specific method of a class. \tn % Row Count 9 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Assertions}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{pytest allows you to use the standard Python assert for verifying expectations and values in Python tests. For example, you can write the following:} \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} `assert a \% 2 == 0` & assert that you have a certain value. \tn % Row Count 5 (+ 2) % Row 2 \SetRowColor{LightBackground} `assert a \% 2 == 0,\{\{nl\}\}"value was odd, should be even"` & specify a message with the assertion like this \tn % Row Count 8 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{5.44 cm} x{2.56 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Grouping in tests}} \tn % Row 0 \SetRowColor{LightBackground} \{\{literal\}\}@pytest.mark.\textless{}markername\textgreater{} & mark it in tests \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} pytest tests/ -m "sanitytests" & run using -m flag \tn % Row Count 4 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Disable tests}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{`@pytest.mark.skip(\{\{nl\}\} reason="no way of currently testing this")`} \tn % Row Count 2 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Assertion of expected exceptions}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Test if the exception is raised} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`def test\_zero\_division():\{\{nl\}\} with pytest.raises(ZeroDivisionError):\{\{nl\}\} 1 / 0`} \tn % Row Count 3 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Test for specific exception info} \tn % Row Count 4 (+ 1) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`def test\_recursion\_depth():\{\{nl\}\} with \seqsplit{pytest.raises(RuntimeError)} as excinfo:\{\{nl\}\} assert "maximum" in str(excinfo.value)`} \tn % Row Count 7 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{MultiThreading}} \tn % Row 0 \SetRowColor{LightBackground} `pip install pytest-xdist\{\{nl\}\} pytest tests/ -n 3` & Pytest does not run in parallel by default, therefor we need to enable this behaviour through a plugin. \tn % Row Count 6 (+ 6) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Fixtures}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{In testing, a fixture provides a defined, reliable and consistent context for the tests. This could include environment (for example a database configured with known parameters) or content (such as a dataset).} \tn % Row Count 5 (+ 5) % Row 1 \SetRowColor{white} `@pytest.fixture\{\{nl\}\} def input\_value():\{\{nl\}\} input = 10\{\{nl\}\} return input` & Create fixture in conftest \tn % Row Count 10 (+ 5) % Row 2 \SetRowColor{LightBackground} `def test\_divisible\_by\_3(input\_value):\{\{nl\}\} assert input\_value \% 3 == 0` & Use it in tests \tn % Row Count 14 (+ 4) % Row 3 \SetRowColor{white} `@pytest.fixture\{\{nl\}\} def sending\_user(mail\_admin):\{\{nl\}\} user = mail\_admin.create\_user()\{\{nl\}\} yield user\{\{nl\}\} \seqsplit{mail\_admin.delete\_user(user)`} & using yield to setup and teardown test environment \tn % Row Count 22 (+ 8) % Row 4 \SetRowColor{LightBackground} \{\{literal\}\}@pytest.fixture(scope="function") & \{\{rowspan=4\}\} Pytest fixtures have scope. This scope controls how often the fixture is executed or, in other words, how often the setup and teardown of the fixture is performed. \tn % Row Count 31 (+ 9) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Fixtures (cont)}} \tn % Row 5 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{\{\{literal\}\}@pytest.fixture(scope="module")} \tn % Row Count 1 (+ 1) % Row 6 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{\{\{literal\}\}@pytest.fixture(scope="class")} \tn % Row Count 2 (+ 1) % Row 7 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{\{\{literal\}\}@pytest.fixture(scope="session")} \tn % Row Count 3 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Data parameterization}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{The builtin pytest.mark.parametrize decorator enables parametrization of arguments for a test function} \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{Define parametrized tests} \tn % Row Count 4 (+ 1) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{\seqsplit{`@pytest.mark.parametrize("num}, output",\{\{nl\}\} {[}(1,11),(2,22),(3,35),(4,44){]})\{\{nl\}\}def \seqsplit{test\_multiplication\_11(num}, output):\{\{nl\}\} assert 11*num == output`} \tn % Row Count 8 (+ 4) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{Running specific tests of a parametrized test.} \tn % Row Count 9 (+ 1) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{test\_mod.py::test\_multiplication\_11{[}2-22{]}} \tn % Row Count 10 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}