7. ورودی و خروجی

روش‌های گوناگونی برای نمایش خروجی یک برنامه وجود دارد؛ داده‌ها را می‌توان به‌صورت قابل‌خواندن برای انسان چاپ کرد، یا برای استفاده‌ی بعدی در یک فایل نوشت. این فصل به بررسی برخی از این امکانات می‌پردازد.

7.1. قالب‌بندی پیشرفته‌تر خروجی

تا اینجا با دو روش برای نوشتن مقادیر آشنا شده‌ایم: عبارت‌های دستوری (expression statements) و تابع print(). (روش سوم استفاده از متد write() اشیاء فایل است؛ فایل خروجی استاندارد را می‌توان با sys.stdout ارجاع داد. برای اطلاعات بیشتر به مرجع کتابخانه مراجعه کنید.)

اغلب، کنترل بیشتری بر قالب‌بندی خروجی خود می‌خواهید تا صرفاً چاپ مقادیر با فاصله از هم. روش‌های گوناگونی برای قالب‌بندی خروجی وجود دارد.

  • برای استفاده از لیترال‌های رشته‌ای قالبی، یک رشته را با f یا F قبل از علامت نقل‌قول یا نقل‌قول سه‌گانه آغاز کنید. درون این رشته، می‌توانید یک عبارت پایتون را بین نویسه‌های { و } بنویسید که می‌تواند به متغیرها یا مقادیر لیترال ارجاع دهد.

    >>> year = 2016
    >>> event = 'Referendum'
    >>> f'Results of the {year} {event}'
    'Results of the 2016 Referendum'
    
  • متد str.format() رشته‌ها نیازمند تلاش دستی بیشتری است. هنوز از { و } برای مشخص کردن جایی که یک متغیر جایگزین می‌شود استفاده می‌کنید و می‌توانید دستورالعمل‌های دقیق قالب‌بندی ارائه دهید، اما همچنین نیاز دارید اطلاعاتی که قرار است قالب‌بندی شوند را ارائه دهید. در بلوک کد زیر دو مثال از نحوه‌ی قالب‌بندی متغیرها آورده شده است:

    >>> yes_votes = 42_572_654
    >>> total_votes = 85_705_149
    >>> percentage = yes_votes / total_votes
    >>> '{:-9} YES votes  {:2.2%}'.format(yes_votes, percentage)
    ' 42572654 YES votes  49.67%'
    

    توجه کنید که چگونه yes_votes با فاصله پر می‌شود و علامت منفی فقط برای اعداد منفی است. مثال همچنین percentage را ضرب‌شده در ۱۰۰، با ۲ رقم اعشار و به دنبال آن علامت درصد چاپ می‌کند (برای جزئیات به Format specification mini-language مراجعه کنید).

  • در نهایت، می‌توانید تمام کارهای مربوط به رشته را خودتان با استفاده از برش رشته و عملیات الحاق انجام دهید تا هر چیدمانی که تصور می‌کنید را ایجاد کنید. نوع رشته دارای متدهایی است که عملیات مفیدی برای پر کردن رشته‌ها تا پهنای ستون مشخصی انجام می‌دهند.

وقتی به خروجی پیشرفته‌ای نیاز ندارید و فقط می‌خواهید نمایش سریعی از برخی متغیرها را برای اهداف اشکال‌زدایی داشته باشید، می‌توانید هر مقداری را با توابع repr() یا str() به رشته تبدیل کنید.

تابع str() برای بازگرداندن نمایشی از مقادیر طراحی شده است که تا حدی قابل‌خواندن برای انسان باشد، در حالی که repr() برای تولید نمایشی طراحی شده که توسط مفسر قابل خواندن باشد (یا اگر معادل نحوی وجود نداشته باشد، یک SyntaxError پرتاب می‌کند). برای اشیایی که نمایش خاصی برای مصرف انسان ندارند، str() همان مقدار repr() را بازمی‌گرداند. بسیاری از مقادیر، مانند اعداد یا ساختارهایی مانند فهرست‌ها و دیکشنری‌ها، با استفاده از هر دو تابع نمایش یکسانی دارند. به‌ویژه رشته‌ها، دو نمایش متمایز دارند.

چند مثال:

>>> s = 'Hello, world.'
>>> str(s)
'Hello, world.'
>>> repr(s)
"'Hello, world.'"
>>> str(1/7)
'0.14285714285714285'
>>> x = 10 * 3.25
>>> y = 200 * 200
>>> s = 'The value of x is ' + repr(x) + ', and y is ' + repr(y) + '...'
>>> print(s)
The value of x is 32.5, and y is 40000...
>>> # خروجی repr() برای یک رشته، علامت‌های نقل‌قول و بک‌اسلش‌ها را اضافه می‌کند:
>>> hello = 'hello, world\n'
>>> hellos = repr(hello)
>>> print(hellos)
'hello, world\n'
>>> # آرگومان repr() می‌تواند هر شیء پایتونی باشد:
>>> repr((x, y, ('spam', 'eggs')))
"(32.5, 40000, ('spam', 'eggs'))"closed.

ماژول string شامل پشتیبانی از یک رویکرد ساده‌ی قالب‌بندی (templating) است که بر اساس عبارت‌های منظم (regular expressions) و از طریق string.Template کار می‌کند. این روشی دیگر برای جایگزینی مقادیر در رشته‌ها ارائه می‌دهد، با استفاده از جانشین‌هایی (placeholders) مانند $x و جایگزینی آن‌ها با مقادیر یک دیکشنری. این نحو (سینتکس) آسان است، اگرچه کنترل بسیار کمتری برای قالب‌بندی ارائه می‌دهد.

7.1.1. لیترال‌های رشته‌ای قالبی

لیترال‌های رشته‌ای قالبی (که به‌طور خلاصه f-strings نیز نامیده می‌شوند) به شما اجازه می‌دهند که مقدار عبارت‌های پایتون را درون یک رشته با پیشوندگذاری رشته با f یا F و نوشتن عبارت‌ها به صورت {expression} بگنجانید.

یک مشخص‌کننده‌ی قالب اختیاری می‌تواند پس از عبارت بیاید. این امکان کنترل بیشتری بر نحوه‌ی قالب‌بندی مقدار فراهم می‌کند. مثال زیر، عدد پی (pi) را تا سه رقم اعشار گرد می‌کند:

>>> import math
>>> print(f'The value of pi is approximately {math.pi:.3f}.')
The value of pi is approximately 3.142.

گذراندن یک عدد صحیح بعد از ':' باعث می‌شود که آن فیلد حداقل به آن اندازه نویسه عرض داشته باشد. این برای هم‌تراز کردن ستون‌ها مفید است.

>>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 7678}
>>> for name, phone in table.items():
...     print(f'{name:10} ==> {phone:10d}')
...
Sjoerd     ==>       4127
Jack       ==>       4098
Dcab       ==>       7678

اصلاح‌کننده‌های دیگری را می‌توان برای تبدیل مقدار قبل از قالب‌بندی استفاده کرد. '!a' تابع ascii() را اعمال می‌کند، '!s' تابع str() را، و '!r' تابع repr() را اعمال می‌کند:

>>> animals = 'eels'
>>> print(f'My hovercraft is full of {animals}.')
My hovercraft is full of eels.
>>> print(f'My hovercraft is full of {animals!r}.')
My hovercraft is full of 'eels'.

مشخص‌کننده‌ی = را می‌توان برای گسترش یک عبارت به متن خود عبارت، یک علامت مساوی، و سپس نمایش عبارت ارزیابی‌شده استفاده کرد:

>>> bugs = 'roaches'
>>> count = 13
>>> area = 'living room'
>>> print(f'Debugging {bugs=} {count=} {area=}')
Debugging bugs='roaches' count=13 area='living room'

برای اطلاعات بیشتر درباره‌ی مشخص‌کننده‌ی =، به عبارات خودمستند مراجعه کنید. برای مرجعی در مورد این مشخصات قالب‌بندی، به راهنمای مرجع برای Format specification mini-language مراجعه کنید.

7.1.2. متد قالب‌بندی رشته

استفادهٔ پایه از متد str.format() به این شکل است:

>>> print('We are the {} who say "{}!"'.format('knights', 'Ni'))
We are the knights who say "Ni!"

براکت‌ها و نویسه‌های داخل آن‌ها (که فیلدهای قالب نامیده می‌شوند) با اشیاء ارسال‌شده به متد str.format() جایگزین می‌شوند. از یک عدد درون براکت‌ها می‌توان برای اشاره به جایگاه شیء ارسال‌شده به متد str.format() استفاده کرد.

>>> print('{0} and {1}'.format('spam', 'eggs'))
spam and eggs
>>> print('{1} and {0}'.format('spam', 'eggs'))
eggs and spam

اگر از آرگومان‌های کلیدواژه‌ای در متد str.format() استفاده شود، مقادیر آن‌ها با استفاده از نام آرگومان ارجاع داده می‌شوند.

>>> print('This {food} is {adjective}.'.format(
...       food='spam', adjective='absolutely horrible'))
This spam is absolutely horrible.

آرگومان‌های موقعیتی و کلیدواژه‌ای را می‌توان به‌طور دلخواه ترکیب کرد:

>>> print('The story of {0}, {1}, and {other}.'.format('Bill', 'Manfred',
...                                                    other='Georg'))
The story of Bill, Manfred, and Georg.

اگر یک رشته‌ی قالبی واقعاً طولانی دارید که نمی‌خواهید آن را تقسیم کنید، خوب می‌شد اگر می‌توانستید به متغیرهایی که قرار است قالب‌بندی شوند با نام ارجاع دهید، نه با جایگاه. این کار را می‌توان با ارسال دیکشنری و استفاده از براکت‌های مربعی '[]' برای دسترسی به کلیدها انجام داد.

>>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678}
>>> print('Jack: {0[Jack]:d}; Sjoerd: {0[Sjoerd]:d}; '
...       'Dcab: {0[Dcab]:d}'.format(table))
Jack: 4098; Sjoerd: 4127; Dcab: 8637678

این کار را همچنین می‌توان با ارسال دیکشنری table به‌عنوان آرگومان‌های کلیدواژه‌ای با نماد ** انجام داد.

>>> table = {'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678}
>>> print('Jack: {Jack:d}; Sjoerd: {Sjoerd:d}; Dcab: {Dcab:d}'.format(**table))
Jack: 4098; Sjoerd: 4127; Dcab: 8637678

این به‌ویژه در ترکیب با تابع داخلی vars() مفید است، که یک دیکشنری شامل همه‌ی متغیرهای محلی بازمی‌گرداند:

>>> table = {k: str(v) for k, v in vars().items()}
>>> message = " ".join([f'{k}: ' + '{' + k +'};' for k in table.keys()])
>>> print(message.format(**table))
__name__: __main__; __doc__: None; __package__: None; __loader__: ...

به‌عنوان مثال، خطوط زیر مجموعه‌ای از ستون‌های مرتب و هم‌تراز تولید می‌کنند که اعداد صحیح و مربع و مکعب آن‌ها را نشان می‌دهد:

>>> for x in range(1, 11):
...     print('{0:2d} {1:3d} {2:4d}'.format(x, x*x, x*x*x))
...
 1   1    1
 2   4    8
 3   9   27
 4  16   64
 5  25  125
 6  36  216
 7  49  343
 8  64  512
 9  81  729
10 100 1000

برای دریافت نمای کلی کامل از قالب‌بندی رشته با str.format()، به Format string syntax مراجعه کنید.

7.1.3. قالب‌بندی دستی

در اینجا همان جدول مربع‌ها و مکعب‌ها، به‌صورت دستی قالب‌بندی شده است:

>>> for x in range(1, 11):
...     print(repr(x).rjust(2), repr(x*x).rjust(3), end=' ')
...     # Note use of 'end' on previous line
...     print(repr(x*x*x).rjust(4))
...
 1   1    1
 2   4    8
 3   9   27
 4  16   64
 5  25  125
 6  36  216
 7  49  343
 8  64  512
 9  81  729
10 100 1000

(توجه داشته باشید که یک فاصله بین هر ستون توسط نحوه‌ی کار تابع print() اضافه شده است: این تابع همیشه بین آرگومان‌های خود فاصله اضافه می‌کند.)

متد str.rjust() از اشیاء رشته، یک رشته را در یک فیلد با عرض مشخص، با پر کردن آن با فاصله از سمت چپ، راست‌چین می‌کند. روش‌های مشابهی str.ljust() و str.center() نیز وجود دارند. این متدها هیچ چیزی نمی‌نویسند، فقط یک رشته‌ی جدید بازمی‌گردانند. اگر رشته‌ی ورودی خیلی طولانی باشد، آن را کوتاه نمی‌کنند، بلکه آن را بدون تغییر بازمی‌گردانند؛ این کار چیدمان ستون‌های شما را به هم می‌ریزد، اما این معمولاً بهتر از حالت جایگزین است، که دروغ گفتن درباره‌ی یک مقدار است. (اگر واقعاً کوتاه‌سازی می‌خواهید، همیشه می‌توانید یک عملیات برش اضافه کنید، مانند x.ljust(n)[:n].)

روش دیگری نیز وجود دارد، str.zfill()، که یک رشته‌ی عددی را در سمت چپ با صفر پر می‌کند. این روش، علائم مثبت و منفی را نیز در نظر می‌گیرد:

>>> '12'.zfill(5)
'00012'
>>> '-3.14'.zfill(7)
'-003.14'
>>> '3.14159265359'.zfill(5)
'3.14159265359'

7.1.4. قالب‌بندی قدیمی رشته‌ها

عملگر % (باقیمانده) نیز می‌تواند برای قالب‌بندی رشته استفاده شود. با فرض format % values (که در آن format یک رشته است)، مشخصات تبدیل % در format با صفر یا چند عنصر از values جایگزین می‌شوند. این عملیات معمولاً به عنوان درون‌یابی رشته (string interpolation) شناخته می‌شود. برای مثال:

>>> import math
>>> print('The value of pi is approximately %5.3f.' % math.pi)
The value of pi is approximately 3.142.

اطلاعات بیشتر می‌تواند در بخش printf-style String Formatting پیدا شود.

7.2. خواندن و نوشتن فایلها

open() یک file object بازمی‌گرداند و معمولاً با دو آرگومان موقعیتی و یک آرگومان کلیدواژه‌ای استفاده می‌شود: open(filename, mode, encoding=None)

>>> f = open('workfile', 'w', encoding="utf-8")

آرگومان اول رشته‌ای است که نام فایل را در بر دارد. آرگومان دوم رشته‌ی دیگری است که شامل چند نویسه است و نحوه‌ی استفاده از فایل را توضیح می‌دهد. mode می‌تواند 'r' باشد زمانی که فایل فقط خوانده می‌شود، 'w' برای فقط نوشتن (یک فایل موجود با همان نام حذف خواهد شد)، و 'a' فایل را برای افزودن (append) باز می‌کند؛ هر داده‌ای که در فایل نوشته شود به‌طور خودکار به انتهای آن اضافه می‌شود. 'r+' فایل را هم برای خواندن و هم برای نوشتن باز می‌کند. آرگومان mode اختیاری است؛ اگر حذف شود، 'r' در نظر گرفته می‌شود.

به‌طور معمول، فایل‌ها در text mode باز می‌شوند، یعنی شما رشته‌ها را از فایل می‌خوانید و در فایل می‌نویسید، که با یک encoding (رمزگذاری) خاص کدگذاری شده‌اند. اگر encoding مشخص نشود، مقدار پیش‌فرض به سیستم‌عامل بستگی دارد (به open() مراجعه کنید). از آنجا که UTF-8 استاندارد بالفعل مدرن است، encoding="utf-8" توصیه می‌شود مگر اینکه بدانید باید از رمزگذاری دیگری استفاده کنید. اضافه کردن 'b' به حالت، فایل را در binary mode باز می‌کند. داده‌ها در حالت دودویی به صورت اشیاء bytes خوانده و نوشته می‌شوند. هنگام باز کردن فایل در حالت دودویی نمی‌توانید encoding را مشخص کنید.

در حالت متنی، حالت پیش‌فرض هنگام خواندن، تبدیل پایان‌خط‌های ویژه‌ی هر سیستم‌عامل (\n در یونیکس، \r\n در ویندوز) به فقط \n است. هنگام نوشتن در حالت متنی، حالت پیش‌فرض تبدیل \n به پایان‌خط‌های ویژه‌ی هر سیستم‌عامل است. این تغییرات پشت‌صحنه در داده‌های فایل برای فایل‌های متنی خوب است، اما داده‌های دودویی مانند فایل‌های JPEG یا EXE را خراب می‌کند. هنگام خواندن و نوشتن چنین فایل‌هایی بسیار دقت کنید که از حالت دودویی استفاده کنید.

استفاده از کلیدواژه‌ی with هنگام کار با اشیاء فایل، یک روش خوب است. مزیت آن این است که فایل پس از پایان بلوک خود به‌درستی بسته می‌شود، حتی اگر در جایی استثنا ایجاد شود. استفاده از with همچنین بسیار کوتاه‌تر از نوشتن بلوک‌های معادل try-finally است:

>>> with open('workfile', encoding="utf-8") as f:
...     read_data = f.read()

>>> # می‌توانیم بررسی کنیم که فایل به‌صورت خودکار بسته شده است یا نه
>>> f.closed
True

اگر از کلیدواژه‌ی with استفاده نمی‌کنید، باید f.close() را فراخوانی کنید تا فایل بسته شود و هر گونه منابع سیستمی که توسط آن استفاده می‌شود، بلافاصله آزاد شوند.

هشدار

فراخوانی f.write() بدون استفاده از کلیدواژه‌ی with یا فراخوانی f.close() ممکن است باعث شود که آرگومان‌های f.write() به‌طور کامل روی دیسک نوشته نشوند، حتی اگر برنامه با موفقیت خارج شود.

پس از بسته شدن یک شیء فایل، چه توسط دستور with و چه با فراخوانی f.close()، تلاش برای استفاده از شیء فایل به‌طور خودکار با شکست مواجه می‌شود.

>>> f.close()
>>> f.read()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: I/O operation on closed file.

7.2.1. متدهای اشیاء فایل

بقیه‌ی مثال‌های این بخش فرض می‌کنند که یک شیء فایل به نام f قبلاً ایجاد شده است.

برای خواندن محتویات یک فایل، f.read(size) را فراخوانی کنید، که مقدار مشخصی از داده را خوانده و آن را به صورت یک رشته (در حالت متنی) یا یک شیء bytes (در حالت دودویی) بازمی‌گرداند. size یک آرگومان عددی اختیاری است. وقتی size حذف شود یا منفی باشد، تمام محتویات فایل خوانده شده و بازگردانده می‌شود؛ اگر فایل دو برابر حافظه‌ی دستگاه شما باشد، این مشکل شماست. در غیر این صورت، حداکثر size نویسه (در حالت متنی) یا size بایت (در حالت دودویی) خوانده و بازگردانده می‌شوند. اگر به انتهای فایل رسیده باشد، f.read() یک رشته‌ی خالی ('') بازمی‌گرداند.

>>> f.read()
'This is the entire file.\n'
>>> f.read()
''

f.readline() یک خط از فایل را می‌خواند؛ یک نویسه‌ی خط جدید (\n) در انتهای رشته باقی می‌ماند، و فقط در آخرین خط فایل حذف می‌شود اگر فایل با یک خط جدید پایان نیابد. این باعث می‌شود که مقدار بازگشتی بدون ابهام باشد؛ اگر f.readline() یک رشته‌ی خالی بازگرداند، به انتهای فایل رسیده‌ایم، در حالی که یک خط خالی با '\n'، یعنی یک رشته که فقط شامل یک خط جدید است، نشان داده می‌شود.

>>> f.readline()
'This is the first line of the file.\n'
>>> f.readline()
'Second line of the file\n'
>>> f.readline()
''

برای خواندن خطوط از یک فایل، می‌توانید روی خود شیء فایل حلقه بزنید. این روش کارآمد از نظر حافظه، سریع است و به کد ساده‌ای منجر می‌شود:

>>> for line in f:
...     print(line, end='')
...
This is the first line of the file.
Second line of the file

اگر می‌خواهید تمام خطوط یک فایل را در یک فهرست بخوانید، می‌توانید از list(f) یا f.readlines() نیز استفاده کنید.

f.write(string) محتویات string را در فایل می‌نویسد و تعداد نویسه‌های نوشته‌شده را بازمی‌گرداند.

>>> f.write('This is a test\n')
15

انواع دیگر اشیاء باید تبدیل شوند -- یا به یک رشته (در حالت متنی) یا به یک شیء bytes (در حالت دودویی) -- قبل از نوشتن آن‌ها:

>>> value = ('the answer', 42)
>>> s = str(value)  # convert the tuple to string
>>> f.write(s)
18

f.tell() یک عدد صحیح بازمی‌گرداند که موقعیت جاری شیء فایل را در فایل نشان می‌دهد، که در حالت دودویی به صورت تعداد بایت‌ها از ابتدای فایل و در حالت متنی به صورت یک عدد مبهم (opaque) است.

برای تغییر موقعیت شیء فایل، از f.seek(offset, whence) استفاده کنید. موقعیت با افزودن offset به یک نقطه‌ی مرجع محاسبه می‌شود؛ نقطه‌ی مرجع توسط آرگومان whence انتخاب می‌شود. مقدار whence برابر با 0 از ابتدای فایل اندازه‌گیری می‌کند، 1 از موقعیت جاری فایل استفاده می‌کند، و 2 از انتهای فایل به عنوان نقطه‌ی مرجع استفاده می‌کند. whence را می‌توان حذف کرد و مقدار پیش‌فرض آن 0 است، یعنی از ابتدای فایل به‌عنوان نقطه‌ی مرجع استفاده می‌کند.

>>> f = open('workfile', 'rb+')
>>> f.write(b'0123456789abcdef')
16
>>> f.seek(5)      # رفتن به بایت ششم فایل
5
>>> f.read(1)
b'5'
>>> f.seek(-3, 2)  # رفتن به سومین بایت قبل از انتهای فایل
13
>>> f.read(1)
b'd'

در فایل‌های متنی (آنهایی که بدون b در رشته‌ی حالت باز شده‌اند)، فقط جست‌وجوهای نسبت به ابتدای فایل مجاز هستند (به جز جست‌وجو به انتهای فایل با seek(0, 2)) و تنها مقادیر معتبر offset مقادیری هستند که از f.tell() بازگردانده می‌شوند، یا صفر. هر مقدار offset دیگر رفتار تعریف‌نشده‌ای ایجاد می‌کند.

اشیاء فایل دارای متدهای اضافی دیگری نیز هستند، مانند isatty() و truncate() که کمتر استفاده می‌شوند؛ برای راهنمای کامل اشیاء فایل به مرجع کتابخانه مراجعه کنید.

7.2.2. ذخیره‌سازی داده‌های ساختاریافته با json

رشته‌ها را به‌راحتی می‌توان در فایل نوشت و از آن خواند. اعداد کمی بیشتر تلاش نیاز دارند، زیرا متد read() فقط رشته‌ها را بازمی‌گرداند، که باید به تابعی مانند int() داده شوند، که یک رشته مانند '123' را گرفته و مقدار عددی آن، یعنی 123، را بازمی‌گرداند. وقتی می‌خواهید انواع داده‌ی پیچیده‌تر مانند فهرست‌های تو در تو و دیکشنری‌ها را ذخیره کنید، تجزیه و سریال‌سازی دستی پیچیده می‌شود.

به جای اینکه کاربران دائماً کد بنویسند و دیباگ کنند تا انواع داده‌ی پیچیده را در فایل‌ها ذخیره کنند، پایتون به شما اجازه می‌دهد از فرمت محبوب تبادل داده به نام JSON (JavaScript Object Notation) استفاده کنید. ماژول استاندارد json می‌تواند سلسله‌مراتب داده‌های پایتون را گرفته و آن‌ها را به نمایش‌های رشته‌ای تبدیل کند؛ این فرآیند serializing نامیده می‌شود. بازسازی داده از نمایش رشته‌ای deserializing نامیده می‌شود. بین سریال‌سازی و دسریال‌سازی، رشته‌ای که شیء را نمایش می‌دهد ممکن است در یک فایل یا داده ذخیره شده باشد، یا از طریق اتصال شبکه به ماشینی دور فرستاده شده باشد.

توجه

فرمت JSON معمولاً توسط برنامه‌های مدرن برای تبادل داده استفاده می‌شود. بسیاری از برنامه‌نویسان از قبل با آن آشنا هستند، که این موضوع آن را به انتخابی خوب برای قابلیت‌عملیات‌پذیری (interoperability) تبدیل می‌کند.

اگر یک شیء x دارید، می‌توانید نمایش رشته‌ای JSON آن را با یک خط کد ساده مشاهده کنید:

>>> import json
>>> x = [1, 'simple', 'list']
>>> json.dumps(x)
'[1, "simple", "list"]'

گونه‌ی دیگری از تابع dumps()، به نام dump()، به‌سادگی شیء را در یک text file سریال‌سازی می‌کند. بنابراین اگر f یک شیء text file است که برای نوشتن باز شده، می‌توانیم این کار را انجام دهیم:

json.dump(x, f)

برای رمزگشایی مجدد شیء، اگر f یک شیء binary file یا text file است که برای خواندن باز شده است:

x = json.load(f)

توجه

فایل‌های JSON باید با UTF-8 کدگذاری شوند. هنگام باز کردن فایل JSON به‌عنوان یک text file برای هر دو عمل خواندن و نوشتن، از encoding="utf-8" استفاده کنید.

این تکنیک ساده‌ی سریال‌سازی می‌تواند فهرست‌ها و دیکشنری‌ها را مدیریت کند، اما سریال‌سازی نمونه‌های دلخواه از کلاس‌ها در JSON نیازمند کمی تلاش اضافی است. مرجع ماژول json شامل توضیحاتی در مورد این موضوع است.

همچنین ملاحظه نمائید

pickle - ماژول پیکل

برخلاف JSON، pickle پروتکلی است که امکان سریال‌سازی اشیاء پایتون با پیچیدگی دلخواه را فراهم می‌کند. بنابراین، اختصاصی پایتون است و نمی‌توان از آن برای ارتباط با برنامه‌های نوشته‌شده به زبان‌های دیگر استفاده کرد. همچنین به‌طور پیش‌فرض ناامن است: دسریال‌سازی داده‌های pickle که از یک منبع غیرقابل‌اعتماد می‌آیند، می‌تواند کد دلخواه را اجرا کند، اگر داده توسط یک مهاجم ماهر ساخته شده باشد.