summaryrefslogtreecommitdiff
path: root/docs/topics/files.txt
diff options
context:
space:
mode:
authorCarlton Gibson <carlton.gibson@noumenal.es>2023-02-09 16:48:46 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2023-02-10 19:19:13 +0100
commit534ac4829764f317cf2fbc4a18354fcc998c1425 (patch)
treec85c1df220ea6c3a87f9820106ba5a06e9ec9394 /docs/topics/files.txt
parent7bb741d787ba360a9f0d490db92e22e0d28204ed (diff)
downloaddjango-534ac4829764f317cf2fbc4a18354fcc998c1425.tar.gz
Refs #34140 -- Applied rst code-block to non-Python examples.
Thanks to J.V. Zammit, Paolo Melchiorre, and Mariusz Felisiak for reviews.
Diffstat (limited to 'docs/topics/files.txt')
-rw-r--r--docs/topics/files.txt32
1 files changed, 24 insertions, 8 deletions
diff --git a/docs/topics/files.txt b/docs/topics/files.txt
index ad0dcffdd1..2c31a61dfc 100644
--- a/docs/topics/files.txt
+++ b/docs/topics/files.txt
@@ -36,7 +36,9 @@ store a photo::
specs = models.FileField(upload_to='specs')
Any ``Car`` instance will have a ``photo`` attribute that you can use to get at
-the details of the attached photo::
+the details of the attached photo:
+
+.. code-block:: pycon
>>> car = Car.objects.get(name="57 Chevy")
>>> car.photo
@@ -59,7 +61,9 @@ it has all the methods and attributes described below.
For example, you can change the file name by setting the file's
:attr:`~django.core.files.File.name` to a path relative to the file storage's
location (:setting:`MEDIA_ROOT` if you are using the default
-:class:`~django.core.files.storage.FileSystemStorage`)::
+:class:`~django.core.files.storage.FileSystemStorage`):
+
+.. code-block:: pycon
>>> import os
>>> from django.conf import settings
@@ -74,7 +78,9 @@ location (:setting:`MEDIA_ROOT` if you are using the default
>>> car.photo.path == new_path
True
-To save an existing file on disk to a :class:`~django.db.models.FileField`::
+To save an existing file on disk to a :class:`~django.db.models.FileField`:
+
+.. code-block:: pycon
>>> from pathlib import Path
>>> from django.core.files import File
@@ -89,7 +95,9 @@ To save an existing file on disk to a :class:`~django.db.models.FileField`::
While :class:`~django.db.models.ImageField` non-image data attributes, such
as ``height``, ``width``, and ``size`` are available on the instance, the
underlying image data cannot be used without reopening the image. For
- example::
+ example:
+
+ .. code-block:: pycon
>>> from PIL import Image
>>> car = Car.objects.get(name='57 Chevy')
@@ -115,7 +123,9 @@ Most of the time you'll use a ``File`` that Django's given you (i.e. a file
attached to a model as above, or perhaps an uploaded file).
If you need to construct a ``File`` yourself, the easiest way is to create one
-using a Python built-in ``file`` object::
+using a Python built-in ``file`` object:
+
+.. code-block:: pycon
>>> from django.core.files import File
@@ -127,7 +137,9 @@ Now you can use any of the documented attributes and methods
of the :class:`~django.core.files.File` class.
Be aware that files created in this way are not automatically closed.
-The following approach may be used to close files automatically::
+The following approach may be used to close files automatically:
+
+.. code-block:: pycon
>>> from django.core.files import File
@@ -144,7 +156,9 @@ The following approach may be used to close files automatically::
Closing files is especially important when accessing file fields in a loop
over a large number of objects. If files are not manually closed after
accessing them, the risk of running out of file descriptors may arise. This
-may lead to the following error::
+may lead to the following error:
+
+.. code-block:: pytb
OSError: [Errno 24] Too many open files
@@ -171,7 +185,9 @@ Storage objects
Though most of the time you'll want to use a ``File`` object (which delegates to
the proper storage for that file), you can use file storage systems directly.
You can create an instance of some custom file storage class, or -- often more
-useful -- you can use the global default storage system::
+useful -- you can use the global default storage system:
+
+.. code-block:: pycon
>>> from django.core.files.base import ContentFile
>>> from django.core.files.storage import default_storage