Paramètres VS Code pour le développement en Python avec achèvement

introduction

J'utilise VSCode, mais je ne savais pas quel plug-in (extension) devrait être défini pour préparer l'environnement de développement Python.

Quand j'ai mis dans mon propre paquet (module), je me suis mis en colère contre "" Can't Resolve ~ "` ...

Mais dernièrement, j'ai compris quel plug-in utiliser et comment le configurer.

J'espère que cela aidera les personnes qui ont du mal à créer un environnement de développement Python comme moi dans le passé.

--Prémisse

• Bon si vous avez écrit Python même un peu
• Qu'est-ce que Type Hint? Vous pouvez le configurer même si vous ne le savez pas --Installation de VS Code --en utilisant zsh --Comment vérifier: echo $ SHELL → / bin / zsh est affiché
• Objet / Objectif --Peut exécuter du code Python sur Mac --VSCode vous permet de configurer un plug-in pour Python --Avertissement par résolution de nom, méthodes candidates et indice de type
• Personne cible --Mac, débutant en Python
• Les personnes qui doivent soudainement développer avec Python --Personnes qui souhaitent se développer en utilisant la fonction complémentaire
• Exemple de code
  • BotamochiRice/dev_python_on_vscode

Rendre Pyenv disponible sur Mac

Configurons l'environnement Python. Installez Anyenv, Pyenv et Virtualenv.

Cela maintient l'environnement Python standard de votre Mac propre.

(** Il semble que Pipenv retient beaucoup l'attention dans les rues **. Je vais l'essayer la prochaine fois)

terminal

$ brew install anyenv
$ anyenv install pyenv
$ echo 'eval "$(anyenv init -)"' >> ~/.zshrc
$ anyenv install --init #C'est PYENV_Il passe par les variables d'environnement de ROOT et PATH
$ echo $PYENV_ROOT
~/.anyenv/envs/pyenv
$ brew install pyenv-virtualenv

Essayons de créer un environnement virtuel Python.

terminal

$ pyenv install 3.8.6  # 3.8.6 Python installé
$ pyenv virtualenv 3.8.6 Sandbox  #　3.8.Créez un environnement virtuel appelé Sandbox basé sur 6
$ mkdir -p ~/Documents/playground/python && cd "$_"  #Créez un exemple de répertoire et accédez-y
$ pyenv local Sandbox  #Ce répertoire utilise Python dans l'environnement Sandbox
$ pyenv version  #Vérifiez l'environnement virtuel que vous utilisez actuellement
Sandbox

Utilisez la complétion en insérant un plug-in dans VS Code

Les plug-ins requis sont les suivants. Veuillez installer à partir de la palette d'installation de l'extension VS Code.

• Python
  • ms-python.python
• Fournir un serveur de langage Python
• Un plug-in complémentaire de base fourni par Microsoft. Cela seul est faible
• MagicPython
  • magicstack.magicpython
• Plug-in de surbrillance de syntaxe
• VisualStudio IntelliCode
  • visualstudioexptteam.vscodeintellicode
• Plug-in complémentaire avec moteur AI fourni par Microsoft
• Pyright
  • ms-pyright.pyright
• Un grand favori. Un plug-in qui peut pleinement bénéficier de Type Hint --Effectuez une inférence de type variable et avertissez si différent de l'indice de type
• Code Runner
  • formulahendry.code-runner
• Vous pouvez exécuter le fichier ouvert à partir de la marque triangulaire en haut à droite.

Paramètres pour chaque plug-in

Définit principalement PYTHONPATH. En indiquant au plug-in le package (package) que vous avez créé, vous pourrez pleinement démontrer la puissance de la fonction complémentaire.

Dans ce projet, la structure des dossiers est la suivante.

De plus, dans cet article, nous développerons dans un environnement virtuel appelé Sandbox, qui a été utilisé dans la méthode d'installation de pyenv.

1. Dans VSCode, ouvrez la palette de commandes avec Commande + Maj + P (macOS) / Ctrl + Maj + P (Windows)
2. Entrez Python: Select Interpreter pour sélectionner
3. Sélectionnez l'environnement de pyenv à utiliser (Sandbox dans cet exemple)

Python Language Server

Tout d'abord, nous allons introduire flake8 en tant que Linter (outil de vérification de code statique; il vérifiera s'il est basé sur des conventions de code, etc.).

terminal

pip install flake8

Ensuite, écrivez les paramètres dans .vscode / settings.json.

Les éléments importants ici sont l'élément python.envFile et le fichier .env. Indiquez au serveur de langage Python où se trouve le "répertoire racine du programme Python".

$ {workspaceFolder} indique le répertoire ouvert dans VS Code.

json:.vscode/settings.json

{
  "python.linting.pylintEnabled": false,
  "python.linting.flake8Enabled": true,
  "python.linting.enabled": true,
  "python.linting.lintOnSave": true,
  "python.envFile": "${workspaceFolder}/.env"
}

Le répertoire racine réel est écrit en .env.

(* Si app / s'appelait src /, je lisais mon propre package sans définir PYTHONPATH. VSCode place-t-il src / dans PATH par défaut?)

.env

PYTHONPATH=app/

Paramètres d'exécution de Python avec un outil de débogage. Vous pouvez exécuter en utilisant des points d'arrêt et des montres comme indiqué dans l'écran ci-dessous, alors assurez-vous de le définir.

json:.vscode/launch.json

{
  "configurations": [
    {
      "name": "Python: Current File",
      "type": "python",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal"
    },
    {
      "name": "Python: Main",
      "type": "python",
      "request": "launch",
      "program": "${workspaceRoot}/app/main.py",
      "console": "integratedTerminal"
    }
  ]
}

Pyright

L'inférence de type et l'analyse statique sont puissantes. Dans l'image ci-dessous, Pyright vous avertit que le type du premier argument est incorrect. Seul Python Language Server n'affiche pas cet avertissement.

Définissez le répertoire racine du programme pour la résolution de nom de votre propre package.

pyrightcofig.json

{
  "executionEnvironments": [
    {
      "root": "app",
      "pythonVersion": "3.8"
    }
  ]
}

Code Runner

Il exécutera le fichier actuellement ouvert en un clic ou Ctrl + Option + N (macOS). Puisque le temps d'exécution est également affiché, il semble qu'il puisse être utilisé pour l'optimisation du programme.

Définissez le paramètre "Le répertoire de l'application est le répertoire racine de l'exécution de Python ( $ workspaceRoot / app), et exécutez-le dans l'environnement virtuel de Sandbox ($ pythonPath)".

json:.vscode/settings.json

{
  "code-runner.executorMap": {
    "python": "export PYTHONPATH=$workspaceRoot/app && $pythonPath -B -u $fullFileName"
  }
}

Plug-in recommandé qui rend le développement Python explosif

Python Docstring Generator

• njpwerner.autodocstring
• Génère des formats de document pour les classes et les fonctions telles que Java Doc
• Indice de type de lecture

enfin

PyCharm et Wing sont célèbres pour les IDE Python, mais VS Code a également des fonctions étendues. Je pense que cela peut être un IDE puissant si vous écrivez fermement la configuration.

(C'est ennuyeux d'avoir à écrire PYTHONPATH partout ...)

Microsoft a publié un plug-in appelé Pylance en version bêta, et j'espère que le développement avec VS Code sera plus pratique. Je suis.

Aussi, je l'ai écrit dans l'esprit de * "Fait est mieux que parfait." *, Veuillez donc signaler toutes les parties qui sont difficiles à comprendre. De plus, si vous avez d'autres paramètres recommandés, je vous serais reconnaissant de bien vouloir me le faire savoir dans les commentaires.

Merci pour la lecture. Si vous le trouvez utile, ** LGTM ** sera encourageant.