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.7 Commenting Python code

A Python comment begins with a “#” and continues to the end of the line. This symbol is called a hash sign. Your comments help those who read your code understand why and how you implemented the functionality the way you did. Your documentation helps those who use your code understand the functionality it provides. We discuss commenting Python code in this section. In the next section, we explore how you can best document your source code.

Although I have used comments for this purpose so far, use documentation techniques to describe your functions, methods, and classes. Use these to describe parameters, their types, and their roles. Starting in the next section, I will do this.

Ideally, you should beautifully write your code and carefully choose your names. This way, anyone reading your Python source can instantly understand what it does. At all times, aim for ...