Comment changer le nom d'une application Django ?

Question

J'ai changé le nom d'une application dans Django en renommant son dossier, ses importations et toutes ses références (templates/index). Mais maintenant j'obtiens cette erreur quand j'essaie d'exécuter python manage.py runserver

Error: Could not import settings 'nameofmynewapp.settings' (Is it on sys.path?): No module named settings

Comment puis-je déboguer et résoudre cette erreur ? Des indices ?

Answer 1

Suivez ces étapes pour changer le nom d'une application dans Django :

1. Renommer le dossier qui se trouve dans votre projet Racine
2. Modifiez toutes les références à votre application dans ses dépendances, c'est-à-dire dans le fichier views.py , urls.py , manage.py et settings.py des fichiers.
3. Modifier la table de la base de données django_content_type avec la commande suivante : UPDATE django_content_type SET app_label='<NewAppName>' WHERE app_label='<OldAppName>'
4. De plus, si vous avez des modèles, vous devrez renommer les tables des modèles. Pour postgres, utilisez ALTER TABLE <oldAppName>_modelName RENAME TO <newAppName>_modelName . Pour mysql aussi, je pense que c'est la même chose (comme mentionné par @null_radix).
5. (Pour Django >= 1.7) Mettez à jour le fichier django_migrations afin d'éviter que vos migrations précédentes ne soient réexécutées : UPDATE django_migrations SET app='<NewAppName>' WHERE app='<OldAppName>' . Note Il y a un débat (dans les commentaires) pour savoir si cette étape est nécessaire pour Django 1.8+. Si quelqu'un en est sûr, merci de mettre à jour ici.
6. Si votre models.py La classe Meta de l'entreprise a app_name listé, assurez-vous de renommer cela aussi (mentionné par @will).
7. Si vous avez donné un nom à votre static o templates dans votre application, vous devrez également les renommer. Par exemple, renommez old_app/static/old_app a new_app/static/new_app .
8. Pour renommer django models vous devrez changer django_content_type.name entrée dans DB. Pour postgreSQL, utilisez UPDATE django_content_type SET name='<newModelName>' where name='<oldModelName>' AND app_label='<OldAppName>'
9. Mise à jour 16Jul2021 : De plus, le __pycache__/ à l'intérieur de l'application doit être supprimé, sinon vous obtenez EOFError: marshal data too short when trying to run the server . Mentionné par @Serhii Kushchenko

Point méta (si vous utilisez virtualenv) : Il convient de noter que si vous renommez le répertoire qui contient votre virtualenv, il y aura probablement plusieurs fichiers dans votre env qui contiennent un chemin absolu et qui devront également être mis à jour. Si vous obtenez des erreurs telles que ImportError: No module named ... ça pourrait être le coupable. (merci à @danyamachine pour avoir fourni ceci).

Autres références : vous pouvez également vous référer aux liens ci-dessous pour avoir une vision plus complète :

1. Renommer une application avec Django et South
2. Comment faire migrer un modèle d'une application Django vers une nouvelle ?
3. Comment changer le nom d'une application Django ?
4. Migration vers l'arrière avec Django South
5. Le moyen le plus simple de renommer un modèle en utilisant Django/South ?
6. Code Python (merci à A.Raouf ) pour automatiser les étapes ci-dessus (code non testé. Vous avez été prévenu !)
7. Code Python (merci à rafaponieman ) pour automatiser les étapes ci-dessus (code non testé. Vous avez été prévenus !)

Answer 2

La nouveauté de Django 1.7 est un registre d'applications qui stocke la configuration et permet l'introspection. Cette machine vous permet de modifier plusieurs attributs de l'application.

Ce que je veux dire, c'est qu'il n'est pas toujours nécessaire de renommer une application : Avec la configuration des applications, il est possible de résoudre les conflits d'applications. Mais c'est aussi la voie à suivre si votre application a besoin d'un nom convivial.

Par exemple, je veux nommer mon application de sondage "Feedback from users". C'est comme ça :

Créer un apps.py dans le fichier polls répertoire :

from django.apps import AppConfig

class PollsConfig(AppConfig):
    name = 'polls'
    verbose_name = "Feedback from users"

Ajoutez la configuration de l'application par défaut à votre polls/__init__.py :

default_app_config = 'polls.apps.PollsConfig'

Pour plus de configuration d'applications : https://docs.djangoproject.com/en/1.7/ref/applications/

Answer 3

Un problème amusant ! Je vais bientôt devoir renommer beaucoup d'applications, alors j'ai fait un essai.

Cette méthode permet de progresser par étapes atomiques, afin de minimiser les perturbations pour les autres développeurs travaillant sur l'application que vous renommez.

Voir le lien au bas de cette réponse pour un exemple de code fonctionnel.

1. Préparer le code existant pour le déménagement :

   • Créer un configuration de l'application (set name y label aux valeurs par défaut).
   • Ajoutez la configuration de l'application à INSTALLED_APPS .
   • Sur tous les modèles, définissez explicitement db_table à la valeur actuelle.
   • Les migrations de médecins afin que db_table était "toujours" explicitement définie.
   • Assurez-vous qu'aucune migration n'est nécessaire (vérifiez l'étape précédente).

2. Modifier l'étiquette de l'application :

   • Définir label dans la configuration de l'application pour le nouveau nom de l'application.

   • Mettre à jour les migrations et les clés étrangères pour référencer le nouveau label d'application.

   • Mise à jour des modèles pour les vues génériques basées sur des classes (la Le chemin par défaut est <app_label>/<model_name>_<suffix>.html )

   • Exécuter du SQL brut pour réparer les migrations et content_types (malheureusement, un peu de SQL brut est inévitable). Vous ne pouvez pas l'exécuter dans le cadre d'une migration.

     UPDATE django_migrations
        SET app = 'catalogue'
      WHERE app = 'shop';
     
     UPDATE django_content_type
        SET app_label = 'catalogue'
      WHERE app_label = 'shop';

   • Assurez-vous qu'aucune migration n'est nécessaire (vérifiez l'étape précédente).

3. Renommer les tables :

   • Supprimer "personnalisé". db_table .
   • Exécuter makemigrations afin que django puisse renommer la table "à la valeur par défaut".

4. Déplacez les fichiers :

   • Renommer le répertoire des modules.
   • Corriger les importations.
   • Mise à jour de la configuration de l'application name .
   • Mise à jour où INSTALLED_APPS fait référence à la configuration de l'application.

5. Rangement :

   • Supprimez la configuration des applications personnalisées si elle n'est plus nécessaire.
   • Si la configuration de l'application a disparu, n'oubliez pas de la supprimer aussi de INSTALLED_APPS .

---

Exemple de solution : J'ai créé app-rename-exemple Vous trouverez ici un exemple de projet où vous pourrez voir comment j'ai renommé une application, un commit à la fois.

L'exemple utilise Python 2.7 et Django 1.8, mais je suis sûr que le même processus fonctionnera au moins sur Python 3.6 et Django 2.1.

Answer 4

Dans le cas où vous utilisez PyCharm et que le projet cesse de fonctionner après le renommage :

1. Editez la configuration Run/Debug et changez la variable d'environnement DJANGO_SETTINGS_MODULE, car elle inclut le nom de votre projet.
2. Allez dans Paramètres / Langues et cadres / Django et mettez à jour l'emplacement du fichier de paramètres.

Answer 5

Dans de nombreux cas, je crois que @allcaps's réponse fonctionne bien.

Cependant, il est parfois nécessaire de renommer réellement une application, par exemple pour améliorer la lisibilité du code ou éviter toute confusion.

La plupart des autres réponses impliquent soit manipulation manuelle de bases de données o bricoler des migrations existantes ce que je n'aime pas beaucoup.

Comme alternative, j'aime créer une nouvelle application avec le nom désiré, copier le tout, m'assurer que cela fonctionne, puis supprimer l'application originale :

1. Commencez un nouveau avec le nom désiré, et copiez tout le code de l'application originale dans celle-ci. Assurez-vous que vous corrigez l'espacement des noms, dans le code nouvellement copié, pour correspondre au nom de la nouvelle application.

2. makemigrations y migrate . Remarque : si l'application comporte beaucoup de clés étrangères, il y aura probablement des problèmes de conflits d'accesseurs inversés lors de la migration initiale de l'application copiée. Vous devez renommer l'accesseur related_name (ou en ajouter de nouveaux) sur l'ancienne application pour résoudre les conflits.

3. Créer un migration des données qui copie les données pertinentes des tableaux de l'application originale dans les tableaux de la nouvelle application, et migrate encore.

À ce stade, tout fonctionne encore, car l'application originale et ses données sont toujours en place.

4. Maintenant vous pouvez remanier tout le code dépendant, afin qu'il n'utilise que la nouvelle application. Voir les autres réponses pour des exemples de ce à quoi il faut faire attention.

5. Une fois que vous êtes certain que tout fonctionne, vous pouvez supprimer l'application originale. Cela implique une autre migration (de schéma).

Cela présente l'avantage que chaque étape utilise le mécanisme normal de migration de Django, sans manipulation manuelle de la base de données, et que nous pouvons tout suivre dans le contrôle de la source. En outre, nous conservons l'application originale et ses données jusqu'à ce que nous soyons sûrs que tout fonctionne.