{"title":"Bagaimana membuat perintah django-admin yang disesuaikan","version":"4.2","locale":"id","docname":"howto/custom-management-commands","url":"/id/4.2/howto/custom-management-commands/","canonical":"https://djangodocs.dev/id/4.2/howto/custom-management-commands/","summary":"Aplikasi dapat mendaftarkan tindakan mereka sendiri dengan manage.py . Sebagai contoh, anda mungkin ingin menambahkan sebuah tindakan manage.py untuk sebuah…","html":"

Bagaimana membuat perintah django-admin yang disesuaikanLink to this heading#

\n

Aplikasi dapat mendaftarkan tindakan mereka sendiri dengan manage.py. Sebagai contoh, anda mungkin ingin menambahkan sebuah tindakan manage.py untuk sebuah aplikasi Django yang anda sedang sebarkan. Dalam dokumen ini, kami akan membangun sebuah penyesuaian perintah closepoll untuk aplikasi polls dari tutorial.

\n

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:

\n
Text
polls/\n    __init__.py\n    models.py\n    management/\n        __init__.py\n        commands/\n            __init__.py\n            _private.py\n            closepoll.py\n    tests.py\n    views.py\n
\n

Dalam contoh ini, perintah closepoll akan dibuat tersedia pada setiap proyek yang menyertakan aplikasi polls dalam INSTALLED_APPS.

\n

Modul _private.py tidak akan tersedia sebagai perintah pengelolaan.

\n

Modul closepoll.py mempunyai hanya satu persyaratan -- itu harus ditentukan sebuah kelas Command yang memperpanjang BaseCommand atau satu dari subclasses nya.

\n\n

Untuk menerapkan perintah, sunting polls/management/commands/closepoll.py untuk kelihatan seperti ini:

\n
Code
from django.core.management.base import BaseCommand, CommandError\nfrom polls.models import Question as Poll\n\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(\n                self.style.SUCCESS('Successfully closed poll "%s"' % poll_id)\n            )\n
\n\n

Perintah baru penyesuaian dapat dipanggil menggunakan python manage.py closepoll <poll_ids>.

\n

Metode handle() mengambil satu atau lebih poll_ids dan mensetel poll.opened menjadi False untuk masing-masing. Jika pengguna mereferensikan jajak pendapat yang tidak ada, sebuah CommandError dimunculkan. Atribut poll.opened tidak ada dalam tutorial dan telah ditambahkan pada polls.models.Question untuk contoh ini.

\n
\n

Menerima argumen pilihanLink to this heading#

\n

closepoll yang sama dapat dengan mudah dirubah untuk menghapus jejak pendapat yang diberikan daripada menutupnya dengan menerima tambahan pilihan baris perintah. Penyesuaian pilihan ini dapat ditambahkan dalam cara add_arguments() seperti ini:

\n
Code
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
\n

Pilihan (delete dalam contoh kami) tersedia dalam pilihan parameter perintah dari cara penanganan. Lihat dokumentasi Python argparse untuk lebih tentang penggunaan add_argument.

\n

Dalam tambahan untuk dapat menambahkan penyesuaian pilihan baris perintah, semua management commands dapat menerima beberapa pilihan awal seperti --verbosity dan --traceback.

\n
\n
\n

Pengelolaan perintah dan lokalLink to this heading#

\n

Secara awalan, perintah pengelolaan dijalankan dengan lokal aktif saat ini.

\n

Jika, untuk beberapa alasan, perintah pengelolaan penyesuaian anda harus berjalan tanpa lokal aktif (sebagai contoh, untuk menghindari isi diterjemahkan dari menjadi dimasukkan kedalam basisdata), non aktifkan terjemahan menggunakan decorator @no_translations pada metode handle() anda:

\n
Code
from django.core.management.base import BaseCommand, no_translations\n\n\nclass Command(BaseCommand):\n    ...\n\n    @no_translations\n    def handle(self, *args, **options):\n        ...\n
\n

Sejak penonaktifan terjemahan membutuhkan akses untuk mengkonfigurasi pengaturan, decorator tidak dapat digunakan untuk perintah yang bekerja tanpa pengaturan yang dikonfigurasikan.

\n
\n
\n

PengujianLink to this heading#

\n

Informasi pada bagaimana untuk mencoba penyesuaian pengelolaan perintah dapat ditemukan dalam dokumen percobaan.

\n
\n
\n

Menimpa perintahLink to this heading#

\n

Django mendaftarkan perintah siap-pakai dan kemudian mencari untuk perintah dalam INSTALLED_APPS secara memutar. Selama pencarian, jika sebuah nama perintah menggandakan sebuah perintah sudah terdaftar, perintah baru yang ditemukan ditimpa dahulu.

\n

Dengan kata lain, untuk menimpa sebuah perintah, perintah baru harus memiliki nama sama dan aplikasinya harus sebelum menimpa aplikasi perintah dalam INSTALLED_APPS.

\n

Perintah pengelolaan dari aplikasi pihak-ketiga yang telah tidak sengaja ditimpa dapat dibuat tersedia dibawah sebuah nama baru dengan membuat perintah baru di satu dari aplikasi proyek anda (diurutkan sebelum aplikasi pihak-ketiga dalam INSTALLED_APPS) yang mengimpor Command dari perintah ditimpa.

\n
\n
\n

Obyek perintahLink to this heading#

\n
\n
\nclass BaseCommandLink to this definition#
\n
\n\n

Kelas dasar dari mana semua pengelolaan perintah akhirnya berasal.

\n

Gunakan kelas ini jika anda ingin mengakses semua mekanisme yang mengurai argumen baris perintah dan bekerja kode apa untuk dipanggil dalam tanggapan; jika anda tidak butuh merubah kebiasaan apapun, pertimbangkan menggunakan satu dari subclasses nya.

\n

Mensubkelaskan kelas BaseCommand membutuhkan bahwa anda menerapkan cara handle().

\n
\n

AtributLink to this heading#

\n

Semua atribut dapat di setel dalam kelas turunan anda dan dapat digunakan dalam subclasses BaseCommand.

\n
\n
\nBaseCommand.helpLink to this definition#
\n

Deskripsi singkat dari perintah, dimana akan ditampilkan di pesan bantuan ketika pengguna eksekusi perintah python manage.py help <command>.

\n
\n\n
\n
\nBaseCommand.missing_args_messageLink to this definition#
\n

Jika perintah anda menentukan argumen penempatan wajib, anda dapat menyesuaikan pesan kesalahan yang dikembalikan dalam kasus argumen yang hilang. Awalnya adalah keluaran oleh argparse ("terlalu sedikit argumen").

\n
\n\n
\n
\nBaseCommand.output_transactionLink to this definition#
\n

Sebuah boolean menunjukkan apakah perintah keluaran pernyataan SQL; jika True, keluaran akan otomatis dibungkus dengan BEGIN; dan COMMIT;. Nilai awal adalah False.

\n
\n\n
\n
\nBaseCommand.requires_migrations_checksLink to this definition#
\n

Sebuah boolean; jika True, memerintahkan mencetak sebuah peringatan jika pengaturan perpindahan pada cakram tidak cocok dengan perpindahan di basisdata. Sebuah peringatan tidak mencegah perintah dari penjalanan. Nilai awal adalah False.

\n
\n\n
\n
\nBaseCommand.requires_system_checksLink to this definition#
\n

Sebuah etiket list atau tuple, misalnya [Tags.staticfiles, Tags.models]. Pemeriksaan sistem registered in the chosen tags akan diperiksa untuk kesalahan sebelum menjalankan perintah. Nilai '__all__'``dapat digunakan untuk menentukan bahwa semua pemeriksaan sustem harus dilakukan. Nilai awalan adalah ``'__all__'.

\n
\n\n
\n
\nBaseCommand.styleLink to this definition#
\n

Sebuah atribut instance yang membantu membuat keluaran bewarna ketika menulis ke stdout atau stderr. Sebagai contoh:

\n
Code
self.stdout.write(self.style.SUCCESS("..."))\n
\n

Lihat Pewarnaan sintaksis untuk mempelajari bagaimana merubah papan warna dan melihat gaya tersedia (gunakan versi huruf besar dari "roles" yang digambarkan dalam bagian itu).

\n

Jika anda melewati pilihan --no-color ketika menjalankan perintah anda, semua pemanggilan self.style() akan mengembalikan deretan karakter asli tidak bewarna.

\n
\n\n
\n
\nBaseCommand.suppressed_base_argumentsLink to this definition#
\n

Pilihan perintah awalan untuk menekan keluaran bantuan. Ini harus berupa kumpulan dari nama-nama pilihan (misalnya '--verbosity'). Nilai awalan untuk pilihan yang ditekankan masih bisa dilewati.

\n
\n\n
\n
\n

CaraLink to this heading#

\n

BaseCommand mempunyai beberapa cara yang dapat dikesampingkan tetapi hanya cara handle() harus diterapkan.

\n\n
\n
\nBaseCommand.create_parser(prog_name, subcommand, **kwargs)Link to this definition#
\n

Mengembalikan instance CommandParser, yaitu sebuah subkelas ArgumentParser dengan sedikit penyesuaian untuk Django.

\n

Anda dapat menyesuaikan instance dengan menimpa metode ini dan memanggil super() dengan kwargs dari parameter ArgumentParser.

\n
\n\n
\n
\nBaseCommand.add_arguments(parser)Link to this definition#
\n

Titik masukan untuk menambahkan pengurai argumen untuk menangani argumen baris perintah dilewati ke perintah. Penyesuaian perintah harus menimpa metode ini untuk menambah kedua argumen penempatan dan pilihan yang diterima oleh perintah. Memanggil super() tidak dibutuhkan ketika pengsubkelasan secara langsung BaseCommand.

\n
\n\n
\n
\nBaseCommand.get_version()Link to this definition#
\n

Mengembalikan versi Django, yang seharusnya benar untuk semua perintah Django siap pakai. Perintah pasokan-pengguna dapat menimpa metode ini untuk mengembalikan versi mereka sendiri.

\n
\n\n
\n
\nBaseCommand.execute(*args, **options)Link to this definition#
\n

Mencoba menjalankan perintaj ini, melakukan pemeriksaan sistem jika diperlukan (seperti yang dikendalikan oleh atribut requires_system_checks). Jika perintah memunculkan CommandError, itu dicegat dan dicetak ke stderr.

\n
\n\n\n
\n
\nBaseCommand.handle(*args, **options)Link to this definition#
\n

Logika sebenarnya dari perintah. Subkelas harus menerapkan cara ini.

\n

Itu mungkin mengembalikan sebuah string yang akan dicetak pada stdout (dibungkus oleh BEGIN; dan COMMIT; jika output_transaction adalah True).

\n
\n\n
\n
\nBaseCommand.check(app_configs=None, tags=None, display_num_errors=False)Link to this definition#
\n

Menggunakan kerangka kerja pemeriksaan sistem untuk memeriksa keseluruhan proyek Django untuk potensi masalah. Masalah serius dimunculkan sebagai CommandError; peringatan adalah keluaran stderr; pemberitahuan kecil adalah keluaran stdout.

\n

Jika app_configs dan tags keduanya None, semua pemeriksaan sistem dilakukan. tags dapat menjadi daftar dari etiket pemeriksaan, seperti compatibility atau models.

\n
\n\n
\n
\n

Subkelas BaseCommandLink to this heading#

\n
\n
\nclass AppCommandLink to this definition#
\n
\n\n

Sebuah pengelolaan perintah yang mengambil satu atau lebih label aplikasi terpasang sebagai argumen, dan melakukan sesuatu dengan masing-masing dari mereka.

\n

Daripada menerapkan handle(), subkelas harus menerapkan handle_app_config(), yang akan dipanggil sekali untuk setiap aplikasi.

\n
\n
\nAppCommand.handle_app_config(app_config, **options)Link to this definition#
\n

Melakukan tindakan perintah untuk app_config, yang akan menjadi sebuah instance AppConfig terhubung ke sebuah label aplikasi yang diberikan pada baris perintah.

\n
\n\n
\n
\nclass LabelCommandLink to this definition#
\n
\n\n

Sebuah pengelolaan perintah yang mengambil satu atau lebih argumen (label) yang berubah-ubah pada baris perintah, dan melakukan sesuatu dengan masing-masing dari mereka.

\n

Daripada menerapkan handle(), subkelas harus menerapkan handle_label(), yang akan dipanggil sekali untuk setiap label.

\n
\n
\nLabelCommand.labelLink to this definition#
\n

Sebuah string menggambarkan argumenberubah-ubah dilewatkan ke perintah. String digunakan dalam penggunaan teks dan pesan kesalahan dari perintah. Awalan pada 'label'.

\n
\n\n
\n
\nLabelCommand.handle_label(label, **options)Link to this definition#
\n

Melakukan tindakan perintah untuk label, yang akan menjadi deretan karakter seperti yang diberikan pada baris perintah.

\n
\n\n
\n
\n

Perintah pengecualianLink to this heading#

\n
\n
\nexception CommandError(returncode=1)Link to this definition#
\n
\n\n

Kelas pengecualian mengindikasikan sebuah masalah selama menjalankan perintah pengelolaan.

\n

Jika pengecualian ini muncul selama menjalankan perintah pengelolaan dari konsol baris perintah, itu akan ditangkap dan dirubah menjadi pesan kesalahan tercetak-bagus untuk menyesuaikan aliran keluaran (yaitu, stderr); sebagai hasilnya, memunculkan pengecualian ini (dengan deskripsi kesalahan yang masuk akal) adalah cara yang dipilih untuk mengunjukkan bahwa sesuatu telah salah dalam penjalanan program. Itu menerima argumen pilihan returncode untuk menyesuaikan keadaan keluar untuk perintah pengelolaan untuk keluar, menggunakan sys.exit().

\n

Jika sebuah pengelolaan perintah dipanggil dari kode melalui call_command(), itu terserah kamu untuk menangkap pengecualian ketika dibutuhkan.

\n
\n
","rootId":"module-django.core.management","toc":[{"title":"Menerima argumen pilihan","anchor":"accepting-optional-arguments","children":[]},{"title":"Pengelolaan perintah dan lokal","anchor":"management-commands-and-locales","children":[]},{"title":"Pengujian","anchor":"testing","children":[]},{"title":"Menimpa perintah","anchor":"overriding-commands","children":[]},{"title":"Obyek perintah","anchor":"command-objects","children":[{"title":"Atribut","anchor":"attributes","children":[]},{"title":"Cara","anchor":"methods","children":[]},{"title":"Subkelas BaseCommand","anchor":"basecommand-subclasses","children":[]},{"title":"Perintah pengecualian","anchor":"command-exceptions","children":[]}]}],"breadcrumbs":[{"docname":"howto/index","title":"Panduan \"Bagaimana\"","url":"/id/4.2/howto/"}],"prev":{"docname":"howto/csrf","title":"Bagaimana menggunakan perlindungan CSRF Django","url":"/id/4.2/howto/csrf/"},"next":{"docname":"howto/custom-model-fields","title":"Bagaimana membuat bidang model disesuaikan","url":"/id/4.2/howto/custom-model-fields/"},"formats":{"html":"/id/4.2/howto/custom-management-commands/","markdown":"/id/4.2/howto/custom-management-commands.md","json":"/id/4.2/howto/custom-management-commands.json"},"source":"https://github.com/django/django/blob/stable/4.2.x/docs/howto/custom-management-commands.txt","official":"https://docs.djangoproject.com/id/4.2/howto/custom-management-commands/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","zh-hans","fr","ja","id","it","pt-br","ko","es","el","pl"]}