django-admin εντολέςLink to this heading#Οι εφαρμογές μπορούν να κάνουν register τις δικές τους ενέργειες με το manage.py. Για παράδειγμα, ίσως να θέλετε να προσθέσετε μια manage.py ενέργεια για ένα Django app το οποίο προωθείτε για διανομή. Σε αυτό το άρθρο θα χτίσουμε μια δικιά μας εντολή, με το όνομα closepoll, για την εφαρμογή polls που φτιάξαμε στον οδηγό.
To do this, add a management/commands directory to the application. Django\nwill register a manage.py command for each Python module in that directory\nwhose name doesn’t begin with an underscore. For example:
polls/\n __init__.py\n models.py\n management/\n commands/\n _private.py\n closepoll.py\n tests.py\n views.py\nΣε αυτό το παράδειγμα, η εντολή closepoll θα είναι διαθέσιμη σε κάθε project που έχει εγκατεστημένη αυτή την εφαρμογή, ήτοι, η εφαρμογή polls βρίσκεται μέσα στη ρύθμιση INSTALLED_APPS.
Το module _private.py δεν θα είναι διαθέσιμο ως μια εντολή διαχείρισης (management command), αφού το όνομα του ξεκινά με την κάτω παύλα.
Το module closepoll.py έχει μόνο μια απαίτηση – πρέπει να ορίσει μια κλάση Command η οποία κάνει extend την κλάση BaseCommand ή μια από τις subclasses της.
Για να υλοποιήσετε την εντολή επεξεργαστείτε το αρχείο polls/management/commands/closepoll.py για να δείχνει κάπως έτσι:
from django.core.management.base import BaseCommand, CommandError\nfrom polls.models import Question as Poll\n\nclass Command(BaseCommand):\n help = 'Closes the specified poll for voting'\n\n def add_arguments(self, parser):\n parser.add_argument('poll_ids', nargs='+', type=int)\n\n def handle(self, *args, **options):\n for poll_id in options['poll_ids']:\n try:\n poll = Poll.objects.get(pk=poll_id)\n except Poll.DoesNotExist:\n raise CommandError('Poll "%s" does not exist' % poll_id)\n\n poll.opened = False\n poll.save()\n\n self.stdout.write(self.style.SUCCESS('Successfully closed poll "%s"' % poll_id))\nThe new custom command can be called using python manage.py closepoll\n<poll_ids>.
The handle() method takes one or more poll_ids and sets poll.opened\nto False for each one. If the user referenced any nonexistent polls, a\nCommandError is raised. The poll.opened attribute does not exist in\nthe tutorial and was added to\npolls.models.Question for this example.
Αλλάζοντας εύκολα την εντολή closepoll ώστε να δέχεται επιπρόσθετες επιλογές όταν την καλείτε, θα μπορούσε να διαγράφει ένα poll αντί να το θέτει ως κλειστό (poll.opened = False). Αυτές οι επιλογές μπορούν να προστεθούν στη μέθοδο add_arguments() ως εξής:
class Command(BaseCommand):\n def add_arguments(self, parser):\n # Positional arguments\n parser.add_argument('poll_ids', nargs='+', type=int)\n\n # Named (optional) arguments\n parser.add_argument(\n '--delete',\n action='store_true',\n help='Delete poll instead of closing it',\n )\n\n def handle(self, *args, **options):\n # ...\n if options['delete']:\n poll.delete()\n # ...\nΗ επιλογή (η delete στο παράδειγμα μας) είναι διαθέσιμη μέσα στη μέθοδο handle μέσα από το options dictionary με το key delete. Δείτε περισσότερα στο εγχειρίδιο της Python σχετικά με τη χρήση της argparse και τη μέθοδο add_argument .
Πέρα από τη δυνατότητα της πρόσθεσης δικών σας επιλογών στην εντολή, όλες οι εντολές διαχείρισης μπορούν να δεχτούν μερικές δικές τους, προεγκατεστημένες, επιλογές όπως η --verbosity και η --traceback.
By default, management commands are executed with the current active locale.
\nIf, for some reason, your custom management command must run without an active\nlocale (for example, to prevent translated content from being inserted into\nthe database), deactivate translations using the @no_translations\ndecorator on your handle() method:
from django.core.management.base import BaseCommand, no_translations\n\nclass Command(BaseCommand):\n ...\n\n @no_translations\n def handle(self, *args, **options):\n ...\nSince translation deactivation requires access to configured settings, the\ndecorator can’t be used for commands that work without configured settings.
\nΠληροφορίες στο πως να τεστάρετε τις δικές σας εντολές διαχείρισης, μπορείτε να βρείτε στα εργαλεία για τεστ.
\nDjango registers the built-in commands and then searches for commands in\nINSTALLED_APPS in reverse. During the search, if a command name\nduplicates an already registered command, the newly discovered command\noverrides the first.
In other words, to override a command, the new command must have the same name\nand its app must be before the overridden command’s app in\nINSTALLED_APPS.
Management commands from third-party apps that have been unintentionally\noverridden can be made available under a new name by creating a new command in\none of your project’s apps (ordered before the third-party app in\nINSTALLED_APPS) which imports the Command of the overridden\ncommand.
Η κύρια κλάση από την οποία πηγάζουν όλες οι εντολές διαχείρισης.
\nΧρησιμοποιήστε αυτή την κλάση αν θέλετε να έχετε πρόσβαση σε όλους τους μηχανισμούς οι οποίοι μεταφράζουν τις επιλογές στη γραμμή εντολών (όπως την --delete που χρησιμοποιήσαμε νωρίτερα) και αποφασίζουν, ανάλογα την επιλογή, ποιον κώδικα να καλέσουν περαιτέρω. Αν δεν θέλετε να αλλάξετε κάποια από αυτές τις συμπεριφορές, ίσως σας φανεί χρήσιμη μια από τις subclasses της BaseCommand.
Πραγματοποιώντας subclassing στην κλάση BaseCommand απαιτεί να υλοποιήσετε τη μέθοδο handle().
Όλα τα attributes μπορούν να οριστούν στη δική σας κλάση και να χρησιμοποιηθούν στις subclasses της BaseCommand.
Μια μικρή περιγραφή της εντολής η οποία θα εκτυπωθεί στην κονσόλα όταν ο χρήστης τρέξει την εντολή python manage.py help <command>.
Αν η εντολή σας ορίζει κάποια υποχρεωτικά positional arguments, μπορείτε να παραμετροποιήσετε το μήνυμα σφάλματος που επιστρέφεται, σε περίπτωση που αυτά τα arguments λείπουν. Προεπιλεγμένη τιμή είναι η έξοδος της argparse («too few arguments»).
Τύπου boolean που υποδεικνύει αν η εντολή θα εκτυπώσει (στην κονσόλα) εντολές SQL. Αν είναι True, τότε η έξοδος θα συμπεριληφθεί μέσα σε ένα BEGIN; και COMMIT;. Προεπιλεγμένη τιμή είναι το False.
Τύπου boolean. Αν είναι True, η εντολή θα εκτυπώσει ένα warning αν το σετ των migrations στο δίσκο δεν ταιριάζει με τα migrations στη βάση δεδομένων. Υπόψιν ότι, ένα warning δεν εμποδίζει την εντολή από το να εκτελεστεί. Προεπιλεγμένη τιμή είναι το False.
Τύπου boolean. Αν είναι True, τότε ολόκληρο το Django project σας θα ελεγχθεί για τυχόν σφάλματα πριν εκτελεστεί η εντολή. Προεπιλεγμένη τιμή είναι το True.
Ένα attribute που βοηθά στο να χρωματίσει την έξοδο (δηλαδή το κείμενο) όταν γράφετε στο self.stdout ή στο self.stderr. Για παράδειγμα:
self.stdout.write(self.style.SUCCESS('...'))\nΔείτε στο χρωματίζοντας την έξοδο για να μάθετε πως να τροποποιείτε την παλέτα των χρωμάτων και να δείτε τα διαθέσιμα στυλ (χρήση της έκδοσης των κεφαλαίων γραμμάτων των «ρόλων» όπως περιγράφονται σε αυτή την ενότητα).
\nΑν δηλώσετε την επιλογή --no-color όταν τρέχετε την εντολή σας, όλες οι κλήσεις της self.style() θα επιστρέψουν το αρχικό string χωρίς κάποιο χρώμα.
Η κλάση BaseCommand έχει μερικές μεθόδους οι οποίες μπορούν να παρακαμφθούν (overridden) αλλά μόνο η μέθοδος handle() πρέπει να υλοποιηθεί υποχρεωτικά.
Returns a CommandParser instance, which is an\nArgumentParser subclass with a few customizations for\nDjango.
You can customize the instance by overriding this method and calling\nsuper() with kwargs of ArgumentParser parameters.
Σημείο εισόδου για να προσθέσετε arguments στο μεταφραστή (parser) για τον χειρισμό των arguments που εισάγονται στη γραμμή εντολών (όπως το argument --delete που αναφέραμε παραπάνω). Τυχόν δικές σας διαχειριστικές εντολές θα πρέπει να παρακάμπτουν αυτή τη μέθοδο για να προσθέσουν positional και optional arguments που θα δέχεται η εντολή. Η κλήση της super() δεν είναι απαραίτητη όταν κάνετε απ’ ευθείας subclass την κλάση BaseCommand.
Επιστρέφει την έκδοση του Django, η οποία θα πρέπει να είναι η σωστή για όλες τις προεγκατεστημένες εντολές του Django. Τυχόν δικές σας διαχειριστικές εντολές μπορούν να παρακάμψουν αυτή τη μέθοδο για να επιστρέφουν τη δική τους έκδοση.
\nΠροσπαθεί να εκτελέσει την εντολή που γράψατε, πραγματοποιεί τυχόν τεστ που αφορά το σύστημα (ανάλογα την τιμή του attribute requires_system_checks). Αν η εντολή κάνει raise το exception CommandError, τότε θα εμφανιστεί ανάλογο σφάλμα στο stderr.
Η πραγματική λογική της εντολής. Όλες οι subclasses πρέπει να υλοποιήσουν αυτή τη μέθοδο.
\nIt may return a string which will be printed to stdout (wrapped\nby BEGIN; and COMMIT; if output_transaction is True).
Χρησιμοποιεί το σύστημα ελέγχου του framework για να επιθεωρήσει ολόκληρο το Django project για τυχόν προβλήματα. Τα σοβαρά προβλήματα γίνονται raised ως CommandError. Τα warnings εκτυπώνονται στο stderr. Τυχόν δευτερεύουσες ειδοποιήσεις εκτυπώνονται στο stdout.
Αν τα ορίσματα app_configs και tags είναι και τα δύο τύπου None, τότε θα γίνουν όλα τα συστήματα ελέγχου. Το όρισμα tags μπορεί να είναι μια λίστα από check tags, όπως compatibility ή models.
BaseCommand subclassesLink to this heading#Μια εντολή διαχείρισης η οποία δέχεται ως arguments (όπως το <poll_id> στην εντολή που γράψαμε παραπάνω python manage.py closepoll <poll_id>) ένα ή περισσότερα labels εφαρμογών και κάνει κάτι με καθένα από αυτά.
Αντί της υλοποίησης της μεθόδου handle(), οι subclasses πρέπει να υλοποιούν τη μέθοδο handle_app_config() η οποία θα καλείται μια φορά για κάθε εφαρμογή.
Εκτελεί τις ενέργειες της εντολής για το app_config το οποίο θα είναι ένα instance της κλάσης AppConfig που αντιστοιχεί στο label της εφαρμογής που δόθηκε στη γραμμή εντολών.
Μια εντολή διαχείρισης η οποία δέχεται ένα η περισσότερα arguments (labels) μέσω της γραμμής εντολών και κάνει κάτι με καθένα από αυτά.
\nΑντί της υλοποίησης της μεθόδου handle(), οι subclasses πρέπει να υλοποιούν τη μέθοδο handle_label(), η οποία θα καλείται μια φορά για κάθε label.
Ένα αλφαριθμητικό (string) που περιγράφει τις παραμέτρους που δόθηκαν στην εντολή. Το αλφαριθμητικό χρησιμοποιείται στα μηνύματα σφαλμάτων καθώς και στο κείμενο περιγραφής της εντολής. Προεπιλογή είναι το 'label'.
Εκτελεί τις ενέργειες της εντολής για το label, το οποίο θα είναι ένα string όπως δόθηκε στη γραμμή εντολών.
Μια κλάση Exception που υποδεικνύει ότι προέκυψε κάποιο πρόβλημα κατά τη διάρκεια εκτέλεσης της εντολής διαχείρισης.
\nIf this exception is raised during the execution of a management command from a\ncommand line console, it will be caught and turned into a nicely-printed error\nmessage to the appropriate output stream (i.e., stderr); as a result, raising\nthis exception (with a sensible description of the error) is the preferred way\nto indicate that something has gone wrong in the execution of a command. It\naccepts the optional returncode argument to customize the exit status for\nthe management command to exit with, using sys.exit().
Αν η εντολή διαχείρισης καλείται μέσα από τον κώδικα σας μέσω της συνάρτησης call_command(), τότε είναι δικό σας θέμα να κάνετε catch, όποτε το κρίνετε απαραίτητο, αυτό το exception.