Forum Programmation.python Débutant cherche documentation

Posté par  (site web personnel) . Licence CC By‑SA.
Étiquettes :
2
4
août
2022

Bon(jour|soir),

J'ai commencé il y a peu (une semaine), une autoformation sur Python (avec l'aide Pluralsight).

Je pense avoir compris les bases, mais je bute principalement sur la recherche de documentations.

Premièrement, je n'arrive pas à trouver un équivalent des man pour les modules python. Ça me semble quand même plus simple de ne pas sortir de mon terminal.

Genre ce qui m’intéresse, c'est de trouver la documentation de sys.path.insert(). Or dans la doc Python pour ce module, je ne trouve pas la référence à la méthode insert().

J'ai vu que la méthode existait bien pour ce module :

>>> from sys import path as test
>>> dir(test)
['__add__', '__class__', '__contains__', '__delattr__', '__delitem__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__gt__', '__hash__', '__iadd__', '__imul__', '__init__', '__init_subclass__', '__iter__', '__le__', '__len__', '__lt__', '__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__', '__sizeof__', '__str__', '__subclasshook__', 'append', 'clear', 'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

Je sais qu'elle a besoin de 2 arguments :

>>> test.insert()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: insert() takes exactly 2 arguments (0 given)

Mais là, je bloque, je n'arrive pas à savoir quels sont les arguments.

Et pendant que j'écris ces lignes, je découvre help() :

>>> help(test.insert)
Help on built-in function insert:

insert(...) method of builtins.list instance
    L.insert(index, object) -- insert object before index

Bon OK, finalement je m'en sortirai avec ça. Mais finalement, y a-t-il une documentation facilement accessible (dans mon terminal) sur Python quand on débute ?

Merci.

Bonne (soir|journ)ée.

  • # Bah en fait t'as trouvé...

    Posté par  (Mastodon) . Évalué à 3.

    Salut,

    C'est effectivement la commande help() qui permet d'avoir de l'info sur les fonctions / méthodes de python.

    Tu peux également utiliser un IDE, comme PyCharm Community par exemple, pour faire des scripts un peu plus touffus.

    Il intègre l'aide en ligne à partir de la même source que celle utilisée pas help(), à savoir les docstrings.

    Courage dans ta découverte du Python !

  • # Type "list"

    Posté par  . Évalué à 6.

    Comme la doc. le dit, sys.path est une structure de donnée de type list, un type fourni de base par Python. Sa doc. et donc le listing de ses opérateurs et méthodes, se trouve dans la section dédiée de 'Library Reference > Built-in Types'.

    Pour débuter ou prendre la température, je recommanderais avant tout de lire ou au moins survoler le tutoriel officiel, qui présente les notions générales, et dont des sections entières sont dédiées aux listes (découverte, plus de détails)—et notamment la méthode ìnsert() et ses deux arguments ;-)

    Concernant la manipulation proprement dite de sys.path pour l'insertion d'un nouveau chemin, il y a me semble-t-il essentiellement deux usages: sys.path.insert(0, '/mon/chemin') (insertion en 1ère position) et sys.path.append("/mon/chemin") (ajout en dernière position).

Suivre le flux des commentaires

Note : les commentaires appartiennent à celles et ceux qui les ont postés. Nous n’en sommes pas responsables.