Récupération des docstrings

Vous et un groupe d'amis travaillez à la création d'un nouvel IDE Python exceptionnel (environnement de développement intégré, tel que PyCharm, Spyder, Eclipse, Visual Studio, etc.). L'équipe souhaite ajouter une fonctionnalité qui affiche une info-bulle contenant la docstring d'une fonction dès que l'utilisateur commence à saisir le nom de la fonction. De cette manière, l'utilisateur n'a pas besoin de se rendre ailleurs pour consulter la documentation relative à la fonction qu'il souhaite utiliser. Il vous a été demandé de compléter la fonction build_tooltip() qui récupère une docstring à partir d'une fonction arbitraire.

Vous réutiliserez la fonction count_letter() que vous avez développée dans le dernier exercice pour démontrer que nous pouvons extraire correctement sa docstring.

Cet exercice fait partie du cours

<cours>Écrire des fonctions en Python</cours>

Exercice interactif pratique

Essayez cet exercice en complétant ce code d’exemple.

# Get the "count_letter" docstring by using an attribute of the function
docstring = ____.____

border = '#' * 28
print('{}\n{}\n{}'.format(border, docstring, border))

Modifier et exécuter le code

Cet exercice fait partie du cours

<cours>Écrire des fonctions en Python</cours>

IntermédiaireNiveau de compétence

4.8+

Commencer le cours gratuitement

The goal of this course is to transform you into a Python expert, and so the first chapter starts off with best practices when writing functions. You'll cover docstrings and why they matter and how to know when you need to turn a chunk of code into a function. You will also learn the details of how Python passes arguments to functions, as well as some common gotchas that can cause debugging headaches when calling functions.

Exercise 1: Docstrings Exercise 2: Rédaction d'une docstring Exercise 3: Récupération des docstrings

Exercice actuel

Exercise 4: Les docstrings à la rescousse !Exercise 5: DRY et "Do One Thing"Exercise 6: Extraire une fonction Exercise 7: Diviser une fonction Exercise 8: Transmettre par affectation Exercise 9: Modifiable ou immuable ?Exercise 10: Meilleures pratiques pour les arguments par défaut

If you've ever seen the "with" keyword in Python and wondered what its deal was, then this is the chapter for you! Context managers are a convenient way to provide connections in Python and guarantee that those connections get cleaned up when you are done using them. This chapter will show you how to use context managers, as well as how to write your own.

Exercise 1: Using context managers Exercise 2: The number of cats Exercise 3: The speed of cats Exercise 4: Writing context managers Exercise 5: The timer() context manager Exercise 6: A read-only open() context manager Exercise 7: Advanced topics Exercise 8: Context manager use cases Exercise 9: Scraping the NASDAQ Exercise 10: Changing the working directory

Decorators are an extremely powerful concept in Python. They allow you to modify the behavior of a function without changing the code of the function itself. This chapter will lay the foundational concepts needed to thoroughly understand decorators (functions as objects, scope, and closures), and give you a good introduction into how decorators are used and defined. This deep dive into Python internals will set you up to be a superstar Pythonista.

Exercise 1: Functions are objects Exercise 2: Building a command line data app Exercise 3: Reviewing your co-worker's code Exercise 4: Returning functions for a math game Exercise 5: Scope Exercise 6: Understanding scope Exercise 7: Modifying variables outside local scope Exercise 8: Closures Exercise 9: Checking for closure Exercise 10: Closures keep your values safe Exercise 11: Decorators Exercise 12: Using decorator syntax Exercise 13: Defining a decorator

Now that you understand how decorators work under the hood, this chapter gives you a bunch of real-world examples of when and how you would write decorators in your own code. You will also learn advanced decorator concepts like how to preserve the metadata of your decorated functions and how to write decorators that take arguments.

Exercise 1: Real-world examples Exercise 2: Print the return type Exercise 3: Counter Exercise 4: Decorators and metadata Exercise 5: Preserving docstrings when decorating functions Exercise 6: Measuring decorator overhead Exercise 7: Decorators that take arguments Exercise 8: Run_n_times()Exercise 9: HTML Generator Exercise 10: Timeout(): a real world example Exercise 11: Tag your functions Exercise 12: Check the return type Exercise 13: Great job!