Dokumen ini mengandung semua acuan API dari Field termasuk field options dan field types Django tawarkan.
Argumen berikut tersedia pada semua jenis bidang. Semua adalah pilihan.
\nnullLink to this heading#Jika True, Django akan menyimpan nilai-nilai kosong sebagai NULL di basisdata. Awalan adalah False.
Hindari menggunakan null pada bidang-bidang berdasarkan-string seperti CharField dan TextField. Jika bidang berdasarkan-string mempunyai null=True, itu berarti mempunyai dua kemungkinan nilai untuk "no data": NULL, dan string kosong. Dalam kebanyakan kasus, itu berulang untuk memiliki dua kemungkinan nilai untuk "no data;" Kebiasaan Django adalah menggunakan string kosong, bukan NULL. Satu pengecualian adalah ketika CharField mempunyai unique=True dan blank=True disetel. Dalam keadaan ini, null=True adalah diwajibkan untuk menghindari pelanggaran batasan unik ketika menyimpan banyak obyek dengan nilai kosong.
Untuk kedua bidang berdasarkan-string dan bukan-berdasarkan-string, anda juga akan butuh mensetel blank=True jika anda berharap mengizinkan nilai kosong dalam formulir, sebagai parameter null hanya mempengaruhi penyimpanan basisdata (lihat blank).
blankLink to this heading#Jika True, bidang diizinkan menjadi kosong. Awalan adalah False.
Catat bahwa ini berbeda dari null. null murni hubungan-basisdata, dimana blank adalah hubungan-pengesahan. Jika sebuah bidang mempunyai blank=True, pengesahan formulir akan mengizinkan masukan dari sebuah nilai kosong. Jika sebuah bidang mempunyai blank=False, bidang akan diwajibkan.
choicesLink to this heading#A sequence consisting itself of iterables of exactly two items (e.g.\n[(A, B), (A, B) ...]) to use as choices for this field. If choices are\ngiven, they're enforced by model validation and the\ndefault form widget will be a select box with these choices instead of the\nstandard text field.
Unsur pertama dalam setiap tuple adalah nilai sebenarnya untuk disetel pada model, dan unsur kedua adalah nama dapat-dibaca-manusia. Sebagai contoh:
\nYEAR_IN_SCHOOL_CHOICES = [\n ('FR', 'Freshman'),\n ('SO', 'Sophomore'),\n ('JR', 'Junior'),\n ('SR', 'Senior'),\n ('GR', 'Graduate'),\n]\nUmumnya, itu adalah terbaik menentukan pilihan didalam kelas model, dan menentukan ketetapan bernama-cocok untuk setiap nilai:
\nfrom django.db import models\n\nclass Student(models.Model):\n FRESHMAN = 'FR'\n SOPHOMORE = 'SO'\n JUNIOR = 'JR'\n SENIOR = 'SR'\n GRADUATE = 'GR'\n YEAR_IN_SCHOOL_CHOICES = [\n (FRESHMAN, 'Freshman'),\n (SOPHOMORE, 'Sophomore'),\n (JUNIOR, 'Junior'),\n (SENIOR, 'Senior'),\n (GRADUATE, 'Graduate'),\n ]\n year_in_school = models.CharField(\n max_length=2,\n choices=YEAR_IN_SCHOOL_CHOICES,\n default=FRESHMAN,\n )\n\n def is_upperclass(self):\n return self.year_in_school in {self.JUNIOR, self.SENIOR}\nThough you can define a choices list outside of a model class and then\nrefer to it, defining the choices and names for each choice inside the\nmodel class keeps all of that information with the class that uses it,\nand helps reference the choices (e.g, Student.SOPHOMORE\nwill work anywhere that the Student model has been imported).
Anda dapat juga mengumpulkan pilihan tersedia anda kedalam kelompok bernama yang dapat digunakan untuk tujuan organisasi:
\nMEDIA_CHOICES = [\n ('Audio', (\n ('vinyl', 'Vinyl'),\n ('cd', 'CD'),\n )\n ),\n ('Video', (\n ('vhs', 'VHS Tape'),\n ('dvd', 'DVD'),\n )\n ),\n ('unknown', 'Unknown'),\n]\nThe first element in each tuple is the name to apply to the group. The\nsecond element is an iterable of 2-tuples, with each 2-tuple containing\na value and a human-readable name for an option. Grouped options may be\ncombined with ungrouped options within a single list (such as the\n'unknown' option in this example).
Untuk setiap bidang model yang mempunyai choices tersetel, Djang akan menambah sebuah metode untuk mengambil nama dapat-dibaca-manusia untuk nilai saat ini bidang. Lihat get_FOO_display() dalam dokumentasi API basisdata.
Note that choices can be any sequence object -- not necessarily a list or\ntuple. This lets you construct choices dynamically. But if you find yourself\nhacking choices to be dynamic, you're probably better off using\na proper database table with a ForeignKey. choices is\nmeant for static data that doesn't change much, if ever.
meskipun blank=False disetel pada bidang bersama default kemudian sebuah etiket mengandung "---------" akan dibangun dengan kotak pilihan. Untuk menimpa perilaku ini, tambah sebuah tuple pada choices mengandung None; misalnya (None, 'Your String For Display'). Cara lain, anda dapat menggunakan string kosong daripada None dimana ini masuk akal - sseperti pada CharField.
In addition, Django provides enumeration types that you can subclass to define\nchoices in a concise way:
\nfrom django.utils.translation import gettext_lazy as _\n\nclass Student(models.Model):\n\n class YearInSchool(models.TextChoices):\n FRESHMAN = 'FR', _('Freshman')\n SOPHOMORE = 'SO', _('Sophomore')\n JUNIOR = 'JR', _('Junior')\n SENIOR = 'SR', _('Senior')\n GRADUATE = 'GR', _('Graduate')\n\n year_in_school = models.CharField(\n max_length=2,\n choices=YearInSchool.choices,\n default=YearInSchool.FRESHMAN,\n )\n\n def is_upperclass(self):\n return self.year_in_school in {\n self.YearInSchool.JUNIOR,\n self.YearInSchool.SENIOR,\n }\nThese work similar to enum from Python's standard library, but with some\nmodifications:
Enum member values are a tuple of arguments to use when constructing the\nconcrete data type. Django supports adding an extra string value to the end\nof this tuple to be used as the human-readable name, or label. The\nlabel can be a lazy translatable string. Thus, in most cases, the member\nvalue will be a (value, label) two-tuple. See below for an example\nof subclassing choices using a more complex\ndata type. If a tuple is not provided, or the last item is not a (lazy)\nstring, the label is automatically generated from the member name.
A .label property is added on values, to return the human-readable name.
A number of custom properties are added to the enumeration classes --\n.choices, .labels, .values, and .names -- to make it easier\nto access lists of those separate parts of the enumeration. Use .choices\nas a suitable value to pass to choices in a field definition.
The use of enum.unique() is enforced to ensure that values cannot be\ndefined multiple times. This is unlikely to be expected in choices for a\nfield.
Note that using YearInSchool.SENIOR, YearInSchool['SENIOR'], or\nYearInSchool('SR') to access or lookup enum members work as expected, as do\nthe .name and .value properties on the members.
If you don't need to have the human-readable names translated, you can have\nthem inferred from the member name (replacing underscores with spaces and using\ntitle-case):
\n>>> class Vehicle(models.TextChoices):\n... CAR = 'C'\n... TRUCK = 'T'\n... JET_SKI = 'J'\n...\n>>> Vehicle.JET_SKI.label\n'Jet Ski'\nSince the case where the enum values need to be integers is extremely common,\nDjango provides an IntegerChoices class. For example:
class Card(models.Model):\n\n class Suit(models.IntegerChoices):\n DIAMOND = 1\n SPADE = 2\n HEART = 3\n CLUB = 4\n\n suit = models.IntegerField(choices=Suit.choices)\nIt is also possible to make use of the Enum Functional API with the caveat\nthat labels are automatically generated as highlighted above:
\n>>> MedalType = models.TextChoices('MedalType', 'GOLD SILVER BRONZE')\n>>> MedalType.choices\n[('GOLD', 'Gold'), ('SILVER', 'Silver'), ('BRONZE', 'Bronze')]\n>>> Place = models.IntegerChoices('Place', 'FIRST SECOND THIRD')\n>>> Place.choices\n[(1, 'First'), (2, 'Second'), (3, 'Third')]\nIf you require support for a concrete data type other than int or str,\nyou can subclass Choices and the required concrete data type, e.g.\ndate for use with DateField:
class MoonLandings(datetime.date, models.Choices):\n APOLLO_11 = 1969, 7, 20, 'Apollo 11 (Eagle)'\n APOLLO_12 = 1969, 11, 19, 'Apollo 12 (Intrepid)'\n APOLLO_14 = 1971, 2, 5, 'Apollo 14 (Antares)'\n APOLLO_15 = 1971, 7, 30, 'Apollo 15 (Falcon)'\n APOLLO_16 = 1972, 4, 21, 'Apollo 16 (Orion)'\n APOLLO_17 = 1972, 12, 11, 'Apollo 17 (Challenger)'\nThere are some additional caveats to be aware of:
\nEnumeration types do not support named groups.
Because an enumeration with a concrete data type requires all values to match\nthe type, overriding the blank label\ncannot be achieved by creating a member with a value of None. Instead,\nset the __empty__ attribute on the class:
class Answer(models.IntegerChoices):\n NO = 0, _('No')\n YES = 1, _('Yes')\n\n __empty__ = _('(Unknown)')\ndb_columnLink to this heading#Nama dari kolom basisdata untuk digunakan pada bidang ini. jika tidak diberikan, Django akan menggunakan nama bidang.
\nJika nama kolom basisdata anda adalah kata disiapkan SQL, atau mengandung karakter yang tidak diizinkan dalam nama variabel Python -- terutama, tanda penghubung -- itu juga OK. Django mengutip nama kolom dan tabel dinelakang layar.
\ndb_indexLink to this heading#Jika``True``, indeks basisdata akan dibuat untuk bidang ini.
\ndb_tablespaceLink to this heading#Nama dari database tablespace untuk digunakan untuk indeks bidang ini, jika bidang ini diindeks. Awalan adalah pengaturan DEFAULT_INDEX_TABLESPACE proyek, jika disetel, atau db_tablespace dari model, jika ada. Jika backendtidak mendukung tablespace untuk pengindeksan, pilihan ini diabaikan.
defaultLink to this heading#Nilai awalan untuk bidang. Ini dapat berupa nilai atau obyek callable. Jika callable itu akan dipanggil setiap waktu obyek baru dibuat.
\nThe default can't be a mutable object (model instance, list, set, etc.),\nas a reference to the same instance of that object would be used as the default\nvalue in all new model instances. Instead, wrap the desired default in a\ncallable. For example, if you want to specify a default dict for\nJSONField, use a function:
def contact_default():\n return {"email": "to1@example.com"}\n\ncontact_info = JSONField("ContactInfo", default=contact_default)\nlambdas can't be used for field options like default because they\ncan't be serialized by migrations. See that\ndocumentation for other caveats.
For fields like ForeignKey that map to model instances, defaults\nshould be the value of the field they reference (pk unless\nto_field is set) instead of model instances.
The default value is used when new model instances are created and a value\nisn't provided for the field. When the field is a primary key, the default is\nalso used when the field is set to None.
editableLink to this heading#Jika False, bidang tidak ditampilan dalam admin atau ModelForm lain apapun. Mereka juga dilewati selama model validation. Awalan adalah True.
error_messagesLink to this heading#The error_messages argument lets you override the default messages that the\nfield will raise. Pass in a dictionary with keys matching the error messages you\nwant to override.
Kunci-kunci pesan kesalahan termasuk null, blank, invalid, invalid_choice, unique, dan unique_for_date. Kunci-kunci pesan kesalahan tambahan ditentukan untuk setiap bidang dalam bagian Field types dibawah.
Pesan-pesan kesalahan ini sering tidak menyebarkan ke formulir. Lihat Pertimbangan mengenai error_messages model.
\nhelp_textLink to this heading#Teks "help" tambahan untuk ditampilkan dengan widget formulir. Itu sangat berguna untuk dokumentasi bahkan jika bidang anda tidak digunakan pada formulir.
\nNote that this value is not HTML-escaped in automatically-generated\nforms. This lets you include HTML in help_text if you so\ndesire. For example:
help_text="Please use the following format: <em>YYYY-MM-DD</em>."\nAlternatively you can use plain text and\ndjango.utils.html.escape() to escape any HTML special characters. Ensure\nthat you escape any help text that may come from untrusted users to avoid a\ncross-site scripting attack.
primary_keyLink to this heading#Jika True, bidang ini adalah primary key untuk model.
If you don't specify primary_key=True for any field in your model, Django\nwill automatically add an AutoField to hold the primary key, so you\ndon't need to set primary_key=True on any of your fields unless you want to\noverride the default primary-key behavior. For more, see\nBidang primary key otomatis.
primary_key=True berarti null=False dan unique=True. Hanya satu primary key diizinkan pada sebuah obyek.
The primary key field is read-only. If you change the value of the primary\nkey on an existing object and then save it, a new object will be created\nalongside the old one.
\nunikLink to this heading#Jika True, bidang ini harus unik diseluruh tabel.
This is enforced at the database level and by model validation. If\nyou try to save a model with a duplicate value in a unique\nfield, a django.db.IntegrityError will be raised by the model's\nsave() method.
Pilihan ini adalah adalah sah pada semua jenis bidang kecuali ManyToManyField dan OneToOneField.
Catat bahwa ketika unique adalah True, anda tidak butuh menentukan db_index, karena unique menyiratkan pembuatan dari sebuah indeks.
unique_for_dateLink to this heading#Setel ini ke nama dari DateField atau DateTimeField untuk membutuhkan dimana bidang ini unik untuk nilai dari bidang tanggal.
For example, if you have a field title that has\nunique_for_date="pub_date", then Django wouldn't allow the entry of two\nrecords with the same title and pub_date.
Note that if you set this to point to a DateTimeField, only the date\nportion of the field will be considered. Besides, when USE_TZ is\nTrue, the check will be performed in the current time zone at the time the object gets saved.
This is enforced by Model.validate_unique() during model validation\nbut not at the database level. If any unique_for_date constraint\ninvolves fields that are not part of a ModelForm (for\nexample, if one of the fields is listed in exclude or has\neditable=False), Model.validate_unique() will\nskip validation for that particular constraint.
unique_for_monthLink to this heading#Seperti unique_for_date, tetapi membutuhkan bidang unik dengan mematuhi pada bulan.
unique_for_yearLink to this heading#Seperti unique_for_date dan unique_for_month.
verbose_nameLink to this heading#A human-readable name for the field. If the verbose name isn't given, Django\nwill automatically create it using the field's attribute name, converting\nunderscores to spaces. See Verbose field names.
\nvalidatorsLink to this heading#Sebuah list dari pengesah untuk berjalan untuk bidang ini. Lihat validators documentation untuk informasi lebih.
\nField menerapkan lookup registration API. API dapat digunakan untuk menyesuaikan pencarian mana tersedia untuk semua kelas bidang, dan bagaimana pencarian diambil dari bidang.
AutoFieldLink to this heading#An IntegerField that automatically increments\naccording to available IDs. You usually won't need to use this directly; a\nprimary key field will automatically be added to your model if you don't specify\notherwise. See Bidang primary key otomatis.
BigAutoFieldLink to this heading#Integer 64-bit, seperti AutoField kecuali itu dijamin untuk cocok nomor dari 1 sampai 9223372036854775807.
BigIntegerFieldLink to this heading#A 64-bit integer, much like an IntegerField except that it is\nguaranteed to fit numbers from -9223372036854775808 to\n9223372036854775807. The default form widget for this field is a\nNumberInput.
BinaryFieldLink to this heading#Sebuah bidang untuk menyimpan data binder mentah. Itu dapat diberikan bytes, bytearray, atau memoryview.
Secara awalan, BinaryField menyetel editable menjadi False, dalam kasus itu tidak dapat disertakan dalam ModelForm.
BinaryField mempunyai satu argumen pilihan tambahan:
Panjang maksimal (dalam karakter) dari bidang. Panjang maksimal dipaksa dalam pengesahan Django menggunakan MaxLengthValidator.
BooleanFieldLink to this heading#Sebuah bidang true/false.
\nWidget formulir awalan untuk bidang ini adalah CheckboxInput, atau NullBooleanSelect jika null=True.
Nilai awal dari BooleanField adalah None ketika Field.default belum ditentukan.
CharFieldLink to this heading#Bidang string, untuk string ukuran-kecil- sampai-besar.
\nUntuk teks besar, gunakan TextField.
Widget formulir awalan untuk bidang ini adalah TextInput.
CharField mempunyai satu argumen tambahan diwajibkan:
Panjang maksimal (dalam akrakter) dari bidang. max_length dilaksanakan pada tingkat basisdata dan dalam pengesahan Django menggunakan MaxLengthValidator.
DateFieldLink to this heading#Tanggal, diwakilkan dalam Python oleh instance datetime.date. mempunyai beberapa tambahan, argumen pilihan:
Automatically set the field to now every time the object is saved. Useful\nfor "last-modified" timestamps. Note that the current date is always\nused; it's not just a default value that you can override.
\nThe field is only automatically updated when calling Model.save(). The field isn't updated when making updates\nto other fields in other ways such as QuerySet.update(), though you can specify a custom\nvalue for the field in an update like that.
Automatically set the field to now when the object is first created. Useful\nfor creation of timestamps. Note that the current date is always used;\nit's not just a default value that you can override. So even if you\nset a value for this field when creating the object, it will be ignored.\nIf you want to be able to modify this field, set the following instead of\nauto_now_add=True:
Untuk DateField: default=date.today - dari datetime.date.today()
Untuk DateTimeField: default=timezone.now - dari django.utils.timezone.now()
The default form widget for this field is a\nDateInput. The admin adds a JavaScript calendar,\nand a shortcut for "Today". Includes an additional invalid_date error\nmessage key.
Pilihan auto_now_add, auto_now, dan default saling ekslusif. Perpaduan apapun dari pilihan ini akan menghasilkan sebuah kesalahan.
DateTimeFieldLink to this heading#Sebuah tanggal dan waktu, diwakili dalam Python oleh sebuah contoh datetime.datetime. Mengambil tambahan argumen sama sebagai DateField.
The default form widget for this field is a single\nDateTimeInput. The admin uses two separate\nTextInput widgets with JavaScript shortcuts.
DecimalFieldLink to this heading#A fixed-precision decimal number, represented in Python by a\nDecimal instance. It validates the input using\nDecimalValidator.
Memiliki dua argumen diwajibkan:
\nAngka maksimal dari bilangan diizinkan dalam angka. Catat bahwa angka ini harus lebih besar dari atau setara pada decimal_places.
Sejumlah tempat desiman untuk menyimpan dengan nomor.
\nSebagai contoh, menyimpan angka sampai 999 dengan resolusi 2 penempatan desimal, anda akan menggunakan:
models.DecimalField(..., max_digits=5, decimal_places=2)\nDan untuk menyimpan angka sampai pada sekitar satu milyar dengan sebuah keputusan dari 10 tempat desimal:
\nmodels.DecimalField(..., max_digits=19, decimal_places=10)\nWidget formulir awalan untuk bidang ini adalah sebuah NumberInput ketika localize adalah False atau TextInput sebaliknya.
DurationFieldLink to this heading#A field for storing periods of time - modeled in Python by\ntimedelta. When used on PostgreSQL, the data type\nused is an interval and on Oracle the data type is INTERVAL DAY(9) TO\nSECOND(6). Otherwise a bigint of microseconds is used.
EmailFieldLink to this heading#A CharField that checks that the value is a valid email address using\nEmailValidator.
FileFieldLink to this heading#Sebuah bidang berkas-unggah
\n\nMempunyai dua argumen pilihan:
\nThis attribute provides a way of setting the upload directory and file name,\nand can be set in two ways. In both cases, the value is passed to the\nStorage.save() method.
If you specify a string value or a Path, it may contain\nstrftime() formatting, which will be replaced by the date/time\nof the file upload (so that uploaded files don't fill up the given\ndirectory). For example:
class MyModel(models.Model):\n # file will be uploaded to MEDIA_ROOT/uploads\n upload = models.FileField(upload_to='uploads/')\n # or...\n # file will be saved to MEDIA_ROOT/uploads/2015/01/30\n upload = models.FileField(upload_to='uploads/%Y/%m/%d/')\nIf you are using the default\nFileSystemStorage, the string value\nwill be appended to your MEDIA_ROOT path to form the location on\nthe local filesystem where uploaded files will be stored. If you are using\na different storage, check that storage's documentation to see how it\nhandles upload_to.
upload_to mungkin juga dapat dipanggil, seperti sebuah fungsi. Ini akan dipanggil untuk mendapatkan jalur unggahan, termasuk nama berkas. Panggilan iniharus menerima dua argumen dan mengembalikan jalur gaya-Unix (dengan garis miring didepan) untuk dilewatkan bersama ke sistem penyimpanan. Dua argumen adalah:
Argument | \nDeskripsi | \n
|---|---|
| \nAn instance of the model where the\n Di kebanyakan kasus, obyek ini tidak akan disimpan ke basisdata dulu, jadi jika itu menggunakan | \n
| \nThe filename that was originally given to the\nfile. This may or may not be taken into account\nwhen determining the final destination path. | \n
Sebagai contoh:
\ndef user_directory_path(instance, filename):\n # file will be uploaded to MEDIA_ROOT/user_<id>/<filename>\n return 'user_{0}/{1}'.format(instance.user.id, filename)\n\nclass MyModel(models.Model):\n upload = models.FileField(upload_to=user_directory_path)\nSebuah obyek penyimpanan, yang menangani penyimpanan dan pengambilan berkas anda. Lihat Mengelola berkas untuk rincian pada bagaimana menyediakan obyek ini.
\nWidget formulir awalan untuk bidang ini adalah ClearableFileInput.
Menggunakan sebuah FileField atau sebuah ImageField (lihat dibawah) dalam sebuah model mengambil beberapa langkah:
Dalam berkas pengaturan anda, anda akan butuh menentukan MEDIA_ROOT sebagai jalur penuh ke direktori dimana anda ingin menyimpan berkas terunggah. (Untuk penampilan, berkas-berkas ini tidak disimpan di basisdata.) Tentukan MEDIA_URL sebagai dasar URL umum dari direktori itu. pastikan bahwa direktori ini dapat ditulis oleh Jaringan akun pengguna peladen.
Tambah FileField or ImageField ke model anda, menentukan pilihan upload_to untuk menentukan subdirectori dari MEDIA_ROOT untuk digunakan pada berkas-berkas terunggah.
All that will be stored in your database is a path to the file\n(relative to MEDIA_ROOT). You'll most likely want to use the\nconvenience url attribute\nprovided by Django. For example, if your ImageField is called\nmug_shot, you can get the absolute path to your image in a template with\n{{ object.mug_shot.url }}.
For example, say your MEDIA_ROOT is set to '/home/media', and\nupload_to is set to 'photos/%Y/%m/%d'. The '%Y/%m/%d'\npart of upload_to is strftime() formatting;\n'%Y' is the four-digit year, '%m' is the two-digit month and '%d' is\nthe two-digit day. If you upload a file on Jan. 15, 2007, it will be saved in\nthe directory /home/media/photos/2007/01/15.
If you wanted to retrieve the uploaded file's on-disk filename, or the file's\nsize, you could use the name and\nsize attributes respectively; for more\ninformation on the available attributes and methods, see the\nFile class reference and the Mengelola berkas\ntopic guide.
The uploaded file's relative URL can be obtained using the\nurl attribute. Internally,\nthis calls the url() method of the\nunderlying Storage class.
Note that whenever you deal with uploaded files, you should pay close attention\nto where you're uploading them and what type of files they are, to avoid\nsecurity holes. Validate all uploaded files so that you're sure the files are\nwhat you think they are. For example, if you blindly let somebody upload files,\nwithout validation, to a directory that's within your Web server's document\nroot, then somebody could upload a CGI or PHP script and execute that script by\nvisiting its URL on your site. Don't allow that.
\nAlso note that even an uploaded HTML file, since it can be executed by the\nbrowser (though not by the server), can pose security threats that are\nequivalent to XSS or CSRF attacks.
\nFileField instances are created in your database as varchar\ncolumns with a default max length of 100 characters. As with other fields, you\ncan change the maximum length using the max_length argument.
FileField dan FieldFileLink to this heading#Ketika anda mengakses FileField pada model, anda diberikan sebah contoh dari FieldFile sebagai sebuah proxy untuk mengakses berkas pokok.
The API of FieldFile mirrors that of File,\nwith one key difference: The object wrapped by the class is not necessarily a\nwrapper around Python's built-in file object. Instead, it is a wrapper around\nthe result of the Storage.open()\nmethod, which may be a File object, or it may be a\ncustom storage's implementation of the File API.
In addition to the API inherited from File such as\nread() and write(), FieldFile includes several methods that\ncan be used to interact with the underlying file:
Nama dari berkas termasuk jalur relatif dari akar dari Storage dari FileField terkait.
Hasil dari metode pokok Storage.size().
A read-only property to access the file's relative URL by calling the\nurl() method of the underlying\nStorage class.
Opens or reopens the file associated with this instance in the specified\nmode. Unlike the standard Python open() method, it doesn't return a\nfile descriptor.
Since the underlying file is opened implicitly when accessing it, it may be\nunnecessary to call this method except to reset the pointer to the underlying\nfile or to change the mode.
Berperilaku seperti metode file.close() Python standar dan menutup berkas berkaitan dengan contoh ini.
This method takes a filename and file contents and passes them to the storage\nclass for the field, then associates the stored file with the model field.\nIf you want to manually associate file data with\nFileField instances on your model, the save()\nmethod is used to persist that file data.
Takes two required arguments: name which is the name of the file, and\ncontent which is an object containing the file's contents. The\noptional save argument controls whether or not the model instance is\nsaved after the file associated with this field has been altered. Defaults to\nTrue.
Note that the content argument should be an instance of\ndjango.core.files.File, not Python's built-in file object.\nYou can construct a File from an existing\nPython file object like this:
from django.core.files import File\n# Open an existing file using Python's built-in open()\nf = open('/path/to/hello.world')\nmyfile = File(f)\nAtau anda dapat membangun satu dari sebush string Python seperti ini:
\nfrom django.core.files.base import ContentFile\nmyfile = ContentFile("hello world")\nUntuk informasi lebih, lihat Mengelola berkas.
\nDeletes the file associated with this instance and clears all attributes on\nthe field. Note: This method will close the file if it happens to be open when\ndelete() is called.
The optional save argument controls whether or not the model instance is\nsaved after the file associated with this field has been deleted. Defaults to\nTrue.
Note that when a model is deleted, related files are not deleted. If you need\nto cleanup orphaned files, you'll need to handle it yourself (for instance,\nwith a custom management command that can be run manually or scheduled to run\nperiodically via e.g. cron).
\nFilePathFieldLink to this heading#A CharField whose choices are limited to the filenames in a certain\ndirectory on the filesystem. Has some special arguments, of which the first is\nrequired:
Required. The absolute filesystem path to a directory from which this\nFilePathField should get its choices. Example: "/home/images".
path may also be a callable, such as a function to dynamically set the\npath at runtime. Example:
import os\nfrom django.conf import settings\nfrom django.db import models\n\ndef images_path():\n return os.path.join(settings.LOCAL_FILE_DIR, 'images')\n\nclass MyModel(models.Model):\n file = models.FilePathField(path=images_path)\nOptional. A regular expression, as a string, that FilePathField\nwill use to filter filenames. Note that the regex will be applied to the\nbase filename, not the full path. Example: "foo.*\\.txt$", which will\nmatch a file called foo23.txt but not bar.txt or foo23.png.
Optional. Either True or False. Default is False. Specifies\nwhether all subdirectories of path should be included
Optional. Either True or False. Default is True. Specifies\nwhether files in the specified location should be included. Either this or\nallow_folders must be True.
Optional. Either True or False. Default is False. Specifies\nwhether folders in the specified location should be included. Either this\nor allow_files must be True.
Tentu saja, argumen ini dapat digunakan bersama-sama.
\nThe one potential gotcha is that match applies to the\nbase filename, not the full path. So, this example:
FilePathField(path="/home/images", match="foo.*", recursive=True)\n...will match /home/images/foo.png but not /home/images/foo/bar.png\nbecause the match applies to the base filename\n(foo.png and bar.png).
FilePathField instances are created in your database as varchar\ncolumns with a default max length of 100 characters. As with other fields, you\ncan change the maximum length using the max_length argument.
FloatFieldLink to this heading#Angka floating-point diwakilkan oleh Python oleh instance float.
Widget formulir awalan untuk bidang ini adalah sebuah NumberInput ketika localize adalah False atau TextInput sebaliknya.
ImageFieldLink to this heading#Inherits all attributes and methods from FileField, but also\nvalidates that the uploaded object is a valid image.
In addition to the special attributes that are available for FileField,\nan ImageField also has height and width attributes.
Untuk memfasilitasi permintaan pada atribut tersebut, ImageField mempunyai dua argumen pilihan tambahan:
Name of a model field which will be auto-populated with the height of the\nimage each time the model instance is saved.
\nName of a model field which will be auto-populated with the width of the\nimage each time the model instance is saved.
\nMembutuhkan pustaka Pillow
\nImageField instances are created in your database as varchar\ncolumns with a default max length of 100 characters. As with other fields, you\ncan change the maximum length using the max_length argument.
Widget formulir awalan untuk bidang ini adalah ClearableFileInput.
IntegerFieldLink to this heading#Sebuah integer. Nilai dari -2147483648 sampai 2147483647 aman dalam semua basisdata didukung oleh Django.
Itu menggunakan MinValueValidator dan MaxValueValidator untuk mensahkan masukan berdasarkan pada nilai yang didukung basisdata awalan.
Widget formulir awalan untuk bidang ini adalah sebuah NumberInput ketika localize adalah False atau TextInput sebaliknya.
GenericIPAddressFieldLink to this heading#An IPv4 or IPv6 address, in string format (e.g. 192.0.2.30 or\n2a02:42fe::4). The default form widget for this field is a\nTextInput.
Normalisasi alamat IPv6 mengikuti RFC 4291 Section 2.2 bagian 2.2, termasuk menggunakan bentuk IPv4 disarankan dalam paragraf 3 dari bagian itu, seperti ::ffff:192.0.2.0. Sebagai contoh, 2001:0::0:01 akan dinormalkan menjadi 2001::1, dan ::ffff:0a0a:0a0a menjadi ::ffff:10.10.10.10. Semau karakter dirubah menjadi huruf kecil.
Limits valid inputs to the specified protocol.\nAccepted values are 'both' (default), 'IPv4'\nor 'IPv6'. Matching is case insensitive.
Unpacks IPv4 mapped addresses like ::ffff:192.0.2.1.\nIf this option is enabled that address would be unpacked to\n192.0.2.1. Default is disabled. Can only be used\nwhen protocol is set to 'both'.
Jika anda mengizinkan nilai kosong, anda harus mengizinkan nilai null karena nilai kosong disimpan sebagai null.
\nNullBooleanFieldLink to this heading#Like BooleanField with null=True. Use that instead of this field\nas it's likely to be deprecated in a future version of Django.
PositiveIntegerFieldLink to this heading#Like an IntegerField, but must be either positive or zero (0).\nValues from 0 to 2147483647 are safe in all databases supported by\nDjango. The value 0 is accepted for backward compatibility reasons.
PositiveSmallIntegerFieldLink to this heading#Like a PositiveIntegerField, but only allows values under a certain\n(database-dependent) point. Values from 0 to 32767 are safe in all\ndatabases supported by Django.
SlugFieldLink to this heading#Slug is a newspaper term. A slug is a short label for something,\ncontaining only letters, numbers, underscores or hyphens. They're generally used\nin URLs.
\nLike a CharField, you can specify max_length (read the note\nabout database portability and max_length in that section,\ntoo). If max_length is not specified, Django will use a\ndefault length of 50.
menunjuk pengaturan Field.db_index ke True.
Itu sering berguna untuk otomatis mengisi dimuka sebuah SlugField berdasarkan pada nilai dari beberapa nilai lain. Anda dapat melakukan ini otomatis di admin menggunakan prepopulated_fields.
Itu menggunakan validate_slug atau validate_unicode_slug for validation.
Jika True, bidang menerima huruf Unicode ebagai tambahan pada huruf ASCII. Awalan menjadi False.
SmallAutoFieldLink to this heading#Like an AutoField, but only allows values under a certain\n(database-dependent) limit. Values from 1 to 32767 are safe in all\ndatabases supported by Django.
SmallIntegerFieldLink to this heading#Like an IntegerField, but only allows values under a certain\n(database-dependent) point. Values from -32768 to 32767 are safe in all\ndatabases supported by Django.
TextFieldLink to this heading#A large text field. The default form widget for this field is a\nTextarea.
Jika anda menentukan atribut max_length, itu akan dipantulkan di widget Textarea dari bidang formulir dibangkitkan-otomatis. Bagaimanapun itu tidak dipaksa pada model atau tingkatan basisdata. Gunakan CharField untuk itu.
TimeFieldLink to this heading#A time, represented in Python by a datetime.time instance. Accepts the same\nauto-population options as DateField.
The default form widget for this field is a TimeInput.\nThe admin adds some JavaScript shortcuts.
URLFieldLink to this heading#Sebuah CharField untuk URL, disahkan oleh URLValidator.
The default form widget for this field is a URLInput.
Seperti semua CharField subclasses, URLField mengambil pilihan argumen max_length. Jika anda tidak menentukan max_length, sebuah awalan 200 digunakan.
UUIDFieldLink to this heading#A field for storing universally unique identifiers. Uses Python's\nUUID class. When used on PostgreSQL, this stores in a\nuuid datatype, otherwise in a char(32).
Universally unique identifiers are a good alternative to AutoField for\nprimary_key. The database will not generate the UUID for you, so\nit is recommended to use default:
import uuid\nfrom django.db import models\n\nclass MyUUIDModel(models.Model):\n id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)\n # other fields\nCatata bahwa sebuah callable (dengan tanda kurung dihapus) dilewatkan pada default, bukan sebuah instance dari UUID.
Field is an abstract class that represents a database table column.\nDjango uses fields to create the database table (db_type()), to map\nPython types to database (get_prep_value()) and vice-versa\n(from_db_value()).
A field is thus a fundamental piece in different Django APIs, notably,\nmodels and querysets.
In models, a field is instantiated as a class attribute and represents a\nparticular table column, see Model. It has attributes\nsuch as null and unique, and methods that Django uses to\nmap the field value to database-specific values.
Sebuah Field adalah subkelas dari RegisterLookupMixin dan dengan demikian kedua Transform dan Lookup dapat didaftarkan pada itu untuk digunakan dalam (misalnya field_name__exact="foo") QuerySet. Semua built-in lookups didaftarkan secara awalan.
All of Django's built-in fields, such as CharField, are particular\nimplementations of Field. If you need a custom field, you can either\nsubclass any of the built-in fields or write a Field from scratch. In\neither case, see Menulis bidang model penyesuaian.
Gambaran bertele-tele dari bidang, misalnya aplikasi django.contrib.admindocs.
Gambaran dapat berupa dari bentuk
\ndescription = _("String (up to %(max_length)s)")\ndimana argumen-argumen ditambahkan dari __dict__ bidang-bidang.
A class implementing the descriptor protocol\nthat is instantiated and assigned to the model instance attribute. The\nconstructor must accept a single argument, the Field instance.\nOverriding this class attribute allows for customizing the get and set\nbehavior.
Untuk memetakan sebuah Field pada jenis khusus-basisdata, Django membuka beberapa metode-metode:
Mengembalikan sebuah string menamakan bidang ini untuk tujuan khusus backend. Secara awalan, itu mengembalikan nama kelas.
\nLihat Menyamai jenis bidang siap pakai untuk penggunaan dalam bidang penyesuaian.
\nMengembalikan jenis data kolom basisdata untuk Field, dimasukkan kedalam akun connection.
Lihat Jenis basisdata penyesuaian untuk penggunaan dalam bidang penyesuaian.
\nReturns the database column data type for fields such as ForeignKey\nand OneToOneField that point to the Field, taking\ninto account the connection.
Lihat Jenis basisdata penyesuaian untuk penggunaan dalam bidang penyesuaian.
\nAda tiga keadaan utama dimana Django butuh berinteraksi dengan backend basisdata dan bidang-bidang:
\nketika itu meminta basisdata (nilai Python -> nilai backend basisdata)
ketika itu memuat data dari basisdata (nilai backend basisdata -> nilai Python)
ketika itu menyimpan ke basisdata (nilai Python -> nilai backend basisdata)
Ketika meminta, get_db_prep_value() dan get_prep_value() digunakan:
value adalah nilai saat ini dari atribut model, dan metode harus mengembalikan data dalam bentuk yang telah dipersiapkan untuk digunakan sebagai sebuah parameter dalam sebuah permintaan.
Lihat Mengubah obyek Python ke nilai pencarian untuk penggunaan.
\nMerubah value pada nilai khusus-backend. Secara awalan itu mengembalikan value jika prepared=True dan get_prep_value() jika adalah False.
Lihat Mengubah nilai pencarian ke nilai basisdata untuk penggunaan.
\nKetika memuat data, from_db_value() digunakan:
Merubah nilai ketika dikembalikan oleh basisdata ke obyek Python. Itu adalah balikan dari get_prep_value().
Metode ini tidak digunakan untuk kebanyakan bidang-bidang siap-pakai ketika backend basisdata sudah mengembalikan jenis Python yang benar, atau backend itu sendiri melakukan perubahan.
\nexpression is the same as self.
Lihat Mengubah nilai menjadi obyek Python untuk penggunaan.
\n\nKetika menyimpan, pre_save() dan get_db_prep_save() digunakan:
Same as the get_db_prep_value(), but called when the field value\nmust be saved to the database. By default returns\nget_db_prep_value().
Method called prior to get_db_prep_save() to prepare the value\nbefore being saved (e.g. for DateField.auto_now).
model_instance is the instance this field belongs to and add\nis whether the instance is being saved to the database for the first\ntime.
It should return the value of the appropriate attribute from\nmodel_instance for this field. The attribute name is in\nself.attname (this is set up by Field).
Lihat Mengolah nilai sebelum menyimpan untuk penggunaan.
\nFields often receive their values as a different type, either from\nserialization or from forms.
\nConverts the value into the correct Python object. It acts as the\nreverse of value_to_string(), and is also called in\nclean().
Lihat Mengubah nilai menjadi obyek Python untuk penggunaan.
\nBesides saving to the database, the field also needs to know how to\nserialize its value:
\nReturns the field's value for the given model instance.
\nMetode ini sering digunakan oleh value_to_string().
Merubah obj menjadi sebuah string. Digunakan untuk menserialisasikan nilai dari bidang.
Lihat Mengubah data field untuk serialisasi untuk penggunaan.
\nKetika menggunakan model forms, Field butuh mengetahui bidang formulir mana itu harus diwakili:
Mengembalikan django.forms.Field awalan dari bidang ini untuk ModelForm.
Secara awalan, jika kedua form_class dan choices_form_class adalah None, itu menggunakan CharField. Jika bidang mempunyai choices dan choices_form_class tidak ditentukan, itu menggunakan TypedChoiceField.
Lihat Menentukan bidang formulir untuk sebuah bidang model untuk penggunaan.
\nMengembalikan 4-tuple dengan informasi cukup untuk membuat kembali bidang:
\nNama dari bidang pada model.
Jalur impor dari bidang (misalnya "django.db.models.IntegerField"). Ini harus versi paling ringan, jadi kurang spesifik mungkin lebih baik.
Daftar dari argumen penempatan.
Sebuah dict dari argumen kata kunci.
Metode ini harus ditambahkan pada bidang sebekum 1.7 untuk memindahkan datanya menggunakan Perpindahan.
\nEvery Field instance contains several attributes that allow\nintrospecting its behavior. Use these attributes instead of isinstance\nchecks when you need to write code that depends on a field's functionality.\nThese attributes can be used together with the Model._meta API to narrow down a search for specific field types.\nCustom model fields should implement these flags.
Bendera Boolean yang menunjukkan jika bidang otomatis dibuat, seperti OneToOneField digunakan oleh warisan model.
Bendera Boolean mengindikasikan jika bidang mempunyai kolom terkait dengan itu.
\nBoolean flag that indicates if a field is used to back another non-hidden\nfield's functionality (e.g. the content_type and object_id fields\nthat make up a GenericForeignKey). The hidden flag is used to\ndistinguish what constitutes the public subset of fields on the model from\nall the fields on the model.
Bendera Boolean yang menunjukkan jika sebuah bidang mengandung acuan ke satu atau lebih model untuk kegunaannya (misalnya ForeignKey, ManyToManyField, OneToOneField, dll.).
Returns the model on which the field is defined. If a field is defined on\na superclass of a model, model will refer to the superclass, not the\nclass of the instance.
These attributes are used to query for the cardinality and other details of a\nrelation. These attribute are present on all fields; however, they will only\nhave boolean values (rather than None) if the field is a relation type\n(Field.is_relation=True).
Bendera Boolean adalah True jika bidang mempunyai hubungan many-to-many; False sebaliknya. Hanya bidang disertakan dengan Django dimana ini adalah True adalah ManyToManyField.
Bendera Boolean adalah True jika bidang mempunyai hubungan many-to-one, seperti ForeignKey; False sebaliknya.
Bendera Boolean adalah True jika bidang mempunyai hubungan one-to-many, seperti GenericRelation atau kebalikan dari ForeignKey; False sebaliknya.
Bendera Boolean adalah True jika bidang mempunyai hubungan one-to-one, seperti OneToOneField; False sebaliknya.
Points to the model the field relates to. For example, Author in\nForeignKey(Author, on_delete=models.CASCADE). The related_model for\na GenericForeignKey is always None.