web-dev-qa-db-fra.com

Dois-je ignorer le dossier .idea lors de l'utilisation de PyCharm avec Git?

J'ai lu sur l'intégration de Git dans PyCharm et créé un référentiel Git à partir de PyCharm. J'ai fait cela dans PyCharm parce que j'espérais que PyCharm saurait si le .idea devrait être ignoré, et si tel est le cas, il créerait automatiquement un .gitignore fichier avec la ligne .idea/ dedans.

Mais ce n'est pas le cas, j'ai donc supposé que je ne devais pas ignorer le .idea foler. Cependant, j'ai fait une recherche rapide et j'ai trouvé l'exemple de quelqu'un .gitignore fichier, ici , qui ignore clairement le .idea dossier.

Donc, ma question est, si le .idea dossier ignoré ou non?

pythongitpycharm
37
Ray

Ignorer l'intégralité du dossier .idea n'est pas nécessairement la meilleure idée. Il y a un certain nombre de discussions similaires à ce sujet.

Mais je suggère de vérifier la FAQ officielle à ce sujet.

25
Topka

Tous les fichiers de paramètres du répertoire .idea doivent être placés sous contrôle de version à l'exception de workspace.xml, qui stocke vos préférences locales. Le fichier workspace.xml doit être marqué comme ignoré par VCS .

- documentation du projet PyCharm 2017.

Pour expliquer davantage, workspace.xml contient des préférences d'espace de travail spécifiques à l'utilisateur. Cela inclut variables d'environnement , les fichiers récemment consultés et la position du curseur.

25
Artem Zaytsev

Je suggérerais d'ignorer le dossier .idea Lors du partage de votre projet, malgré ce que documentation de PyCharm recommande.

Bien que le partage des paramètres de votre projet ne soit pas intrinsèquement une mauvaise idée, vous devez être conscient de plusieurs exceptions et problèmes potentiels.

  • Le fichier workspace.xml Contient divers paramètres spécifiques à l'utilisateur, tels que les variables d'environnement, la position du curseur et l'emplacement Python SDK.
    • Les variables environnementales peuvent inclure des données privées, telles que les noms d'utilisateur et les mots de passe
  • Le dossier dictionaries contient des orthographes personnalisées, qui peuvent provoquer des conflits si deux développeurs ont le même nom.
  • Le dossier .idea Est spécifique à PyCharm, ce qui signifie que les développeurs utilisant un autre IDE peuvent conduire à la désynchronisation du projet.
  • propre documentation d'IntelliJ inclut plusieurs avertissements pour des fichiers spécifiques qui ne doivent pas être partagés.

Si vous décidez de partager .idea, documentation officielle d'IntelliJ donne les conseils suivants

[Le format .idea] est utilisé par toutes les versions récentes IDE par défaut. Voici ce que vous devez partager:

  • Tous les fichiers sous le répertoire . Idea à la racine du projet sauf le workspace.xml et tasks.xml fichiers qui stockent les paramètres spécifiques à l'utilisateur
  • Tous les fichiers de module .iml qui peuvent être situés dans différents répertoires de module (s'applique à IntelliJ IDEA)

Faites attention à partager les éléments suivants:

  • Artefacts Android qui produisent une construction signée (contiendra les mots de passe du magasin de clés)
  • Dans IDEA 13 et versions antérieures dataSources.ids , datasources.xml peut contenir des mots de passe de base de données. IDEA 14 résout ce problème .

Vous pouvez envisager de ne pas partager les éléments suivants:

  • . iml fichiers pour le Gradle ou Projets basés sur Maven , car ces fichiers seront générés lors de l'importation
  • fichier gradle.xml , voir cette discussion
  • dossier des dictionnaires utilisateur (pour éviter les conflits si un autre développeur porte le même nom)
  • Fichiers XML sous . Idea/bibliothèques dans le cas où ils sont générés à partir de Gradle ou Maven projet

Source: JetBrains - Comment gérer des projets sous Version Control Systems

4
Steven M. Vascellaro