Jinja Filesizeformat: filter function to format file size

n

The Ultimate Guide to the Jinja filesizeformat Filter

nThe Jinja filesizeformat filter is a convenient tool for converting a number representing a file size in bytes into a human-readable format. Instead of displaying a large, hard-to-read number like 1310720, this filter will format it as 1.3 MB, 4.1 GB, or 102 Bytes, making it easier for users to understand. This filter is essential for any application that deals with file sizes, disk usage, or data transfer statistics.nn

---

nn

How the filesizeformat Filter Works

nThe filesizeformat filter takes a number (an integer or a float) representing a size in bytes and returns a formatted string. It automatically determines the most appropriate unit (Bytes, kB, MB, GB, etc.) and rounds the number to a reasonable precision.nnThe syntax is:n

{{ my_file_size | filesizeformat }}

nIt has one optional parameter:n

n
• binary (boolean, default False): This parameter controls whether the filter uses decimal prefixes or binary prefixes.n
  n
  • binary=False (default): Uses decimal prefixes based on powers of 1000 (kilobytes, megabytes, etc.). So, 1 kB equals 1000 bytes. This is the common standard for most operating systems and consumer products.

  n

  • binary=True: Uses binary prefixes based on powers of 1024 (kibibytes, mebibytes, etc.). So, 1 KiB equals 1024 bytes. This is the standard used in computer science and for memory calculations.

  n

  n

n

nn

---

nn

Practical Examples

nLet’s look at some examples to see how the filesizeformat filter simplifies data presentation.n

Example 1: Default Behavior (Decimal Prefixes)

nThis shows the default behavior, which uses powers of 1000.nnJinja Template:n

<p>File size: {{ 12345678 | filesizeformat }}</p>n<p>Small file: {{ 512 | filesizeformat }}</p>

nRendered HTML:n

<p>File size: 12.35 MB</p>n<p>Small file: 512 Bytes</p>

nThe filter automatically selects the appropriate unit and formats the number.n

Example 2: Using Binary Prefixes

nBy setting binary=True, you can display file sizes using powers of 1024.nnJinja Template:n

<p>File size (decimal): {{ 1048576 | filesizeformat }}</p>n<p>File size (binary): {{ 1048576 | filesizeformat(binary=True) }}</p>

nRendered HTML:n

<p>File size (decimal): 1.05 MB</p>n<p>File size (binary): 1 MiB</p>

n1048576 is exactly 1024 * 1024, so with binary prefixes, it’s displayed as 1 MiB. With decimal prefixes, it’s 1.05 MB. This distinction is important for applications where technical accuracy is critical.nn

---

nn

Conclusion

nThe Jinja filesizeformat filter is an indispensable tool for enhancing the user experience. By automatically formatting file sizes into a readable format, it reduces cognitive load and improves the clarity of your templates. Its ability to switch between decimal and binary prefixes provides the flexibility needed for various applications, from consumer-facing dashboards to technical system monitoring tools.nn