{"title":"Menulis perintah django-admin penyesuaian","version":"1.9","locale":"id","docname":"howto/custom-management-commands","url":"/id/1.9/howto/custom-management-commands/","canonical":"https://djangodocs.dev/id/1.9/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":"

Menulis perintah django-admin penyesuaianLink 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

Untuk melakukan ini, tambahkan direktori management/commands ke aplikasi. Django akan mendaftarkan sebuah perintah manage.py untuk setiap modul Python dalam direktori tersebut yang namanya tidak dimulai dengan garis bawah. Sebagai contoh:

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

Pada Python 2, pastika menyertakan berkas __init__.py dalam kedua direktori management dan management/commands seperti yang dilakukan diatas atau perintah anda tidak akan ditemukan.

\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\nclass Command(BaseCommand):\n    help = 'Closes the specified poll for voting'\n\n    def add_arguments(self, parser):\n        parser.add_argument('poll_id', nargs='+', type=int)\n\n    def handle(self, *args, **options):\n        for poll_id in options['poll_id']:\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))\n
\n\n\n

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

\n

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.

\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_id', nargs='+', type=int)\n\n        # Named (optional) arguments\n        parser.add_argument(\n            '--delete',\n            action='store_true',\n            dest='delete',\n            default=False,\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\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 pengelolaan perintah dapat menerima beberapa pilihan awal seperti --verbosity dan --traceback.

\n
\n
\n

Pengelolaan perintah dan lokalLink to this heading#

\n

Secara awal, cara BaseCommand.execute() menonaktifkan terjemahan karena beberapa perintah dikemas dengan Django melakukan beberapa tugas (sebagai contoh, membangun isi pengguna muka dan mengumpulkan basisdata) yang membutuhkan bahasa deretan karakter proyek-netral.

\n\n

Jika, untuk beberapa alasan, penyesuaian pengelolaan perintah anda butuh menggunakan lokal yang tetap, anda harus secara manual mengaktif dan menonaktifkannya dalam cara handle() anda menggunakan fungsi disediakan oleh dukungan kode I18N:

\n
Code
from django.core.management.base import BaseCommand, CommandError\nfrom django.utils import translation\n\nclass Command(BaseCommand):\n    ...\n    can_import_settings = True\n\n    def handle(self, *args, **options):\n\n        # Activate a fixed locale, e.g. Russian\n        translation.activate('ru')\n\n        # Or you can activate the LANGUAGE_CODE # chosen in the settings:\n        from django.conf import settings\n        translation.activate(settings.LANGUAGE_CODE)\n\n        # Your command logic here\n        ...\n\n        translation.deactivate()\n
\n

Kebutuhan lainnya mungkin bahwa perintah anda dengan mudah harus menggunakan kumpulan lokal dalam pengaturan dan Django harus dijaga dari penonaktifannya. Anda dapat mencapainya dengan menggunakan pilihan BaseCommand.leave_locale_alone.

\n

Ketika bekerja pada skenario yang digambarkan diatas, perhatikan akun yang sistem pengelolaan perintah khususnya harus sangat waspada tentang berjalan dalam lokal yang tidak seragam, jadi anda mungkin butuh untuk:

\n\n
\n
\n

PengujianLink to this heading#

\n

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

\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.argsLink to this definition#
\n

Daftar deretan karakter argumen yang diterima oleh perintah, cocok untuk digunakan dalam pesan bantuan; sebagai contoh, sebuah perintah yang mengambil daftar nama aplikasi mungkin disetel ini menjadi '<app_label app_label ...>'.

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

Sebuah boolean menunjukkan apakah perintah butuh dapat mengimpor pengaturan Django; jika True, execute() akan memeriksa bahwa ini dimungkinkan sebelum dilanjutkan. Nilai awal adalah True.

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

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

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

Ini adalah daftar dari pilihan optparse yang akan diberi makan kedalam perintah OptionParser untuk mengurai argumen.

\n\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_system_checksLink to this definition#
\n

Sebuah boolean; jika True, seluruh proyek Django akan diperiksa untuk masalah potensial sebelum menjalankan perintah. Nilai awal adalah True.

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

Sebuah boolean menunjukkan apakah kumpulan lokal dalam pengaturan harus dipertahankan selama menjalankan dari program daripada dipaksa disetel menjadi 'en-us'.

\n

Nilai awal adalah False.

\n

Pastikan anda mengetahui apa yang anda sedang mengerjakan jika anda memutuskan nilai dari pilihan ini dalam penyesuaian perintah anda jika dia dibuat basisdata yang bersifat sensitif-lokal dan isi seperti itu tidak harus mengandung terjemahan apapun (seperti itu terjadi sebagai contoh dengan django.contrib.auth permissions) ketika membuat perbedaan lokal dari standar sebenarnya 'en-us' mungkin menyebabkan efek yang tidak diinginkan. Lihat bagian Management commands and locales diatas untuk lebih lanjut.

\n

Pilihan ini tidak dapat False ketika pilihan can_import_settings disetel menjadi False juga karena mencoba menyetel lokal butuh akses ke pengaturan. Kondisi ini akan membangkitkan sebuah CommandError.

\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 Syntax coloring 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
\n

CaraLink to this heading#

\n

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

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

Titik masukan untuk menambahkan pengurai argumen untuk menangani argumen baris perintah dilewati ke perintah. Penyesuaian perintah harus mengesampingkan cara 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 mengesampingkan cara ini untuk mengembalikan versi mereka sendiri.

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

Coba untuk menjalankan perintah ini, melakukan pemeriksaan sistem jika dibutuhkan (sebagai pengendalian oleh requires_system_checks attribute). Jika perintah muncul sebuah CommandError, Dia 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

Dia mungkin mengembalikan sebuah deretan karakter Unicode yang akan dicetak ke 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

Gunakan kerangka pemeriksaan sistem untuk memeriksa keseluruhan proyek Django untuk masalah potensial. Masalah serius muncul seperti sebuah CommandError; peringatan dikeluarkan ke stderr; pemberitahuan kecil dikeluarkan pada 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.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
\nclass NoArgsCommandLink to this definition#
\n
\n\n\n

Sebuah perintah yang tidak mengambil argumen dalam baris perintah.

\n

Daripada menerapkan handle(), subkelas harus menerapkan handle_noargs(); handle() itu sendiri dikesampingkan untuk memastikan tidak ada argumen dilewatkan ke perintah.

\n
\n
\nNoArgsCommand.handle_noargs(**options)Link to this definition#
\n

Melakukan tindakan perintah ini

\n
\n\n
\n
\n

Perintah pengecualianLink to this heading#

\n
\n
\nexception CommandErrorLink to this definition#
\n
\n\n

Kelas pengecualian mengindikasikan sebuah masalah selama menjalankan perintah pengelolaan.

\n

Jika pengecualian ini muncul selama peerjalanan dari pengelolaan perintah dari sebuah perintah baris tempat tuts, dia akan ditangkap dan dirubah menjadi pesan kesalahan tercetak yang bagus ke aliran keluaran yang sesuai (yaitu, stderr); sebagai sebuah hasil, memunculkan pengecualian ini (dengan sebuah gambaran yang mudah dimengerti dari kesalahan) adalah jalan yang dipilih untuk menunjukkan bahwa sesuatu telah salah dalam menjalankan sebuah perintah.

\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":"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/1.9/howto/"}],"prev":{"docname":"howto/auth-remote-user","title":"Otentikasi menggunakan REMOTE_USER","url":"/id/1.9/howto/auth-remote-user/"},"next":{"docname":"howto/custom-model-fields","title":"Menulis bidang model penyesuaian","url":"/id/1.9/howto/custom-model-fields/"},"formats":{"html":"/id/1.9/howto/custom-management-commands/","markdown":"/id/1.9/howto/custom-management-commands.md","json":"/id/1.9/howto/custom-management-commands.json"},"source":"https://github.com/django/django/blob/stable/1.9.x/docs/howto/custom-management-commands.txt","official":"https://docs.djangoproject.com/id/1.9/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","fr","ja","id","pt-br","es"]}