Book Image

Dancing with Python

By : Robert S. Sutor
Book Image

Dancing with Python

By: Robert S. Sutor

Overview of this book

Dancing with Python helps you learn Python and quantum computing in a practical way. It will help you explore how to work with numbers, strings, collections, iterators, and files. The book goes beyond functions and classes and teaches you to use Python and Qiskit to create gates and circuits for classical and quantum computing. Learn how quantum extends traditional techniques using the Grover Search Algorithm and the code that implements it. Dive into some advanced and widely used applications of Python and revisit strings with more sophisticated tools, such as regular expressions and basic natural language processing (NLP). The final chapters introduce you to data analysis, visualizations, and supervised and unsupervised machine learning. By the end of the book, you will be proficient in programming the latest and most powerful quantum computers, the Pythonic way.
Table of Contents (29 chapters)
Part I: Getting to Know Python
PART II: Algorithms and Circuits
PART III: Advanced Features and Libraries
Other Books You May Enjoy
Appendix C: The Complete UniPoly Class
Appendix D: The Complete Guitar Class Hierarchy
Appendix F: Production Notes

7.8 Documenting Python code

A docstring is a free-standing string surrounded by three double quotes that describes what your code does.

Developers read the docstrings when browsing your code. By their location, Python associates docstrings with your modules, classes, functions, and methods. Python collects the docstrings and makes them available to your code’s users via functions like help. Third-party tools like Sphinx can process your code to create beautiful web and PDF documents for your users’ reference. [SPH]

One of the most popular Python documentation conventions is part of the Google Python Style Guide. [GSG, Section 3.8] To add lightweight markup for formatting, many coders use “reStructuredText” within their docstrings. [RST] The NumPy and SciPy package developers combined and tweaked these into the “numpydoc docstring guide.” I use their conventions...