درس ۰۳: چگونگی ایجاد و اجرای یک پروژه پایتون¶

تعاریف¶

سورس کد یک پروژه به زبان پایتون در قالب یک یا چند «ماژول» (Module) توسعه می‌یابد که در سورس کدهایی با بیش از یک ماژول بهتر است ماژول‌هایی که از نظر منطقی با یکدیگر مرتبط هستند را درون دایرکتوری‌هایی مجزا قرار دهیم که به این نوع دایرکتوری‌ها در زبان پایتون «بسته» (Package) گفته می‌شود.

در تعریف زبان پایتون دو نوع ماژول وجود دارد:

۱- Pure Module (ماژول عادی)، همان تعریف عادی از ماژول پایتون است؛ فایل‌هایی با پسوند py که کد (تعاریف و دستورات) به زبان پایتون در آن‌ها نوشته می‌شود.

۲- Extension Module (ماژول توسعه)، ماژول‌هایی که توسط زبان‌های برنامه‌نویسی دیگری به غیر از پایتون تهیه شده‌اند. از درس یکم به خاطر داریم که پایتون یک زبان توسعه‌پذیر است و در کنار آن می‌توان از کد‌های نوشته شده با دیگر زبان‌های برنامه‌نویسی استفاده نمود: به مانند C و ++C در پیاده‌سازی CPython یا Java در پیاده‌سازی Jython یا #C در پیاده‌سازی IronPython - بررسی این نوع ماژول خارج از حوزه این کتاب است. در صورت علاقه برای مطالعه بیشتر می‌توانید به مستندات پایتون مراجعه (Python/C API Reference) یا کتاب Python 3.6 Extending and Embedding Python نوشته Guido Van Rossum را تهیه نمایید.

در ایجاد یک پروژه از پایتون هیچ اجباری به رعایت ساختار خاصی نیست و سورس کد یک پروژه می‌تواند تنها شامل یک ماژول (فایل با پسوند py.) باشد. به عنوان نمونه، شمای پایین از پروژه فرضی SampleProject را در نظر بگیرید:

SampleProject
.
└── sample_project.py

یا کمی پیچیده‌تر:

SampleProject
.
├── sample_project.py
└── pakage/
    ├── __init__.py
    ├── module_two.py
    └── module_one.py

در ایجاد سورس کد باید به صورتی عمل شود که با اجرای یک ماژول‌ مشخص تمام برنامه اجرا گردد. این ماژول معمولا هم نام پروژه در نظر گرفته و با عنوان «اسکریپت» (Script) از آن یاد می‌شود (اینجا:‌ sample_project.py). در واقع اسکریپت، ماژولی است که با هدف اجرای برنامه توسعه می‌یابد و ایجاد سورس کد نیز از آن شروع می‌گردد.

ایجاد سورس کد¶

برای ایجاد فایل‌های سورس کد (ماژول‌ها و اسکریپت) نیاز به هیچ برنامه یا ابزار خاصی نیست و تنها با استفاده از یک ویرایشگر ساده متن (مانند برنامه Notepad در ویندوز) می‌توانید آن‌ها را ایجاد و ویرایش نمایید.

در ادامه پروژه‌ای (یا در واقع یک فولدر) به نام FirstProject که تنها حاوی یک فایل اسکریپت (first_project.py) خواهد بود را ایجاد می‌نماییم. وظیفه این اسکریپت فرستادن حاصل عبارت 4÷(6×5-50) به خروجی (Output) خواهد بود.

FirstProject
.
└── first_project.py

داخل فولدر پروژه فایل first_project.py را ایجاد و سپس به کمک یک برنامه‌ ویرایشگر متن آن را ویرایش و کد پایین را در آن درج و سپس ذخیره می‌نماییم.

# This script prints a value to the screen.

print("(50-5×6)÷4 =", (50-5*6)/4)

در بخش بعدی به اجرای پروژه FirstProject خواهیم پرداخت؛ در این بخش بهتر است کمی به بررسی کدهای آن بپردازیم:

در زبان پایتون هر متنی که بعد از کاراکتر ”Number sign“ یا # (در همان سطر) قرار بگیرد توسط مفسر پایتون نادیده گرفته می‌شود و تاثیری در روند ترجمه و اجرای کدها ندارد، به این نوع متن‌ «توضیح» (کامنت Comment) گفته می‌شود و از آن برای مستندسازی (Documentation) ماژول، یعنی ارایه توضیح در مورد بخشی از کد استفاده می‌گردد. ارایه توضیح نقش زیادی در خوانایی ماژول دارد و کمک می‌کند تا افراد دیگر - حتی خودتان - بتوانند عملکرد کدهای ماژول (یا اسکریپت) را بفهمند.

سطرهای خالی (Blank Lines) نیز توسط مفسر پایتون نادیده گرفته می‌شوند و تاثیری در روند ترجمه و اجرای کدها ندارند. استفاده درست از سطرهای خالی بر خوانایی کدهای ماژول می‌افزاید.

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

تابع print توانایی دریافت هر تعداد داده و از هر نوع را دارد و در صورت دریافت یک عبارت محاسباتی (Arithmetic) یا منطقی (Logical) ابتدا حاصل آن را محاسبه یا ارزیابی کرده و پس از تبدیل به نوع داده string در خروجی قرار می‌دهد. در هنگام فرستادن چندین داده گوناگون به خروجی می‌بایست آن‌ها را توسط کاما (Comma) از یکدیگر جدا نماییم. در اینجا نیز print دو داده برای فرستادن به خروجی دریافت کرده است؛ یک نوع داده string و یک عبارت محاسباتی.

به دنباله‌ای از کاراکترها که بین دو نماد نقل قول (Quotation): " " یا ' ' محصور شده‌ باشند، نوع داده string گفته می‌شود.

اجرای سورس کد¶

در حالت کلی به دو شیوه می‌توان به زبان پایتون کد نوشت و اجرا نمود: ۱- به حالت تعاملی (Interactive) با مفسر پایتون ۲- با ایجاد اسکریپت پایتون.

شیوه تعاملی: در این روش می‌بایست ابتدا دستور فراخوانی مفسر پایتون (حالت عمومی دستور: python) را در رابط خط فرمان سیستم عامل وارد نمایید؛ توسط این دستور خط فرمان وارد حالت تعاملی پایتون می‌شود و اکنون به سادگی می‌توانید شروع به کد‌نویسی نمایید. در این حالت هر کدی که وارد شود بلافاصله اجرا شده و در صورت لزوم نتیجه آن نیز نمایش داده می‌شود. از آنجا که در این روش امکان برگشت و ویرایش کدهای وارد شده وجود ندارد، در عمل زیاد کارآمد نبوده و از آن بیشتر در مواردی مانند گرفتن نتیجه‌ قطعه کدهای کوچک، اهداف آموزشی، دریافت راهنمایی یا ماشین حساب! استفاده می‌گردد. چگونگی کار با حالت تعاملی پایتون در درس بعدی بررسی می‌شود.

> python
Python 3.10.5 (main, Jul 22 2022, 17:09:35) [GCC 9.4.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>
>>>
>>> a = 3
>>> b = 2
>>> a * b
6
>>>

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

برای اجرای اسکریپت می‌بایست در خط فرمان سیستم عامل دستور فراخوانی مفسر پایتون را به همراه نام کامل اسکریپت (نشانی + نام + پسوند) وارد نمایید.

نمونه‌های پایین،‌ نتیجه اجرای اسکریپت بخش پیش را از طریق رابط خط فرمان گنولینوکس نمایش می‌دهد:

user> python /home/user/Documents/FirstProject/first_project.py
(50-5×6)÷4 = 5.0

یا:

user> cd /home/user/Documents/FirstProject
user> python first_project.py
(50-5×6)÷4 = 5.0

چنانچه کاربر سیستم عامل ویندوز هستید به این نکته توجه داشته باشید که به دلیل وجود کاراکترهای خاصی (÷ و ×) که قرار است توسط print بر روی خط فرمان نمایش داده شوند و همچنین امکان عدم پشتیبانی پیش‌فرض خط فرمان ویندوز از کدگذاری UTF-8، به هنگام اجرای اسکریپت خطایی گزارش می‌شود که ارتباطی با کد پایتون ندارد. در این مواقع پیشنهاد می‌شود از برنامه PowerShell استفاده نموده و پیش از اجرای اسکریپت دستور chcp 65001 را وارد نمایید - به صورت پایین:

PS > chcp 65001
Active code page: 65001

PS > python C:\Users\user\Documents\FirstProject\first_script.py
(50-5×6)÷4 = 5.0

چگونگی اجرای اسکریپت‌های پایتون چیزی بیش از این نیست، البته می‌توان در هنگام اجرای اسکریپت داده‌هایی را نیز به عنوان آرگومان به آن ارسال نمود که این مورد در درس بعدی بررسی می‌شود.

معمولا در گنولینوکس سطری به مانند پایین به ابتدای اسکریپت‌های پایتون (فقط در سطر یکم) اضافه می‌کنند، در این صورت به هنگام اجرا دیگر نیازی به فراخوانی مفسر پایتون نبوده و تنها می‌بایست پس از تغییر حالت (Mode) اسکریپت مورد نظر به حالت قابل اجرا (توسط دستور chmod)، آن را به روش معمول در یونیکس اجرا نماییم:

#!/usr/bin/env python

env یک دستور شل (Shell) یونیکس است که در زمان اجرای اسکریپت مفسر پایتون را می‌یابد و نشانی آن را جایگزین می‌کند. به جای استفاده از env می‌توان نشانی مفسر پایتون مورد نظر را به صورت صریح مانند usr/bin/python/!# نوشت که البته در مواردی که پایتون به صورت جداگانه نصب شده باشد (نشانی مفسر در این حالت: usr/local/bin/python/)، کارایی ندارد و موجب شکست در اجرا می‌گردد.

اکنون برای نمونه اگر اسکریپت first_script.py را برای اجرا در گنولینوکس کامل‌تر سازیم:

#!/usr/bin/env python

# This script prints a value to the screen.
print "(50-5×6)÷4 =", (50-5*6)/4

پس از تغییر حالت، می‌توان آن را به صورت زیر در توزیع‌های گنولینوکس اجرا نمود:

user> cd /home/user/Documents/FirstProject

user> chmod +x first_project.py

user> ./first_project.py
(50-5×6)÷4 = 5

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

• PyCharm: محصولی از شرکت فوق‌العاده JetBrains است که البته نسخه کامل آن فروشی است ولی نسخه کامیونیتی (Community) آن رایگان و متن باز می‌باشد که از بسیاری ویژگی‌ها و امکانات ویژه برخوردار است. (مقایسه نسخه‌ها)

• PyDev: یک IDE کامل، متن باز و رایگان است که برای پلتفرم Eclipse ارایه می‌شود.

• NetBeans: یک IDE کامل، متن باز و رایگان است که طرفداران بسیاری دارد. NetBeans به صورت پیش‌فرض از پایتون پشتیبانی نمی‌کند و باید پلاگین مربوط به آن نصب گردد. (پلاگین nbPython)

Name: Hideyoshi Nagachika - Age: 19

برنامه‌نویسی ماژولار¶

یک الگوی توصیه شده در برنامه‌نویسی، توسعه برنامه در واحدهایی کوچک از کد است. به گونه‌ای که هر واحد یک نقش مشخص و مستقل از دیگر واحدها داشته باشد. مستقل به این معنی که تغییر یا جایگزینی یک واحد نباید بر روی عملکرد دیگر واحدها تاثیرگذار باشد. به این ترتیب فرآیند خطایابی، نگهداری و توسعه برنامه به مراتب بهبود می‌یابد. یکی از امکانات پایتون در رسیدن به این اصل، استفاده درست از مفاهیم بسته و ماژول است. [برای مطالعه بیشتر: Modular programming و Loose coupling]

پروژه پایین که تنها شامل یک اسکریپت است را در نظر بگیرید:

TokyoGhoul
.
└── tokyo_ghoul.py

 1print("Name:")
 2print("Actor_1:", "Hideyoshi Nagachika")
 3
 4print("Name:")
 5print("Actor_2:", "Ken Kaneki")
 6
 7print("Age:")
 8print("Actor_1:", 19)
 9
10print("Age:")
11print("Actor_2:", 18)

می‌توان این پروژه را با ساختاری به شکل پایین نیز توسعه داد:

TokyoGhoul
.
├── tokyo_ghoul.py
│
└── actors/
    │
    ├── __init__.py
    │
    ├── ages/
    │   ├── __init__.py
    │   ├── actor1.py
    │   └── actor2.py
    │
    └── names/
        ├── __init__.py
        ├── actor1.py
        └── actor2.py

1print("Age:")
2print("Actor_1:", 19)

1print("Age:")
2print("Actor_2:", 18)

1print("Name:")
2print("Actor_1:", "Hideyoshi Nagachika")

1print("Name:")
2print("Actor_2:", "Ken Kaneki")

1import actors.names.actor1
2
3from actors.names import actor2
4
5import actors.ages.actor1
6
7from actors.ages import actor2

خروجی اجرای tokyo_ghoul.py در هر دو حالت یکی است:

Name:
Actor_1: Hideyoshi Nagachika
Name:
Actor_2: Ken Kaneki
Age:
Actor_1: 19
Age:
Actor_2: 18

اما در حالت دوم امکان توسعه بیشتر بوده و به راحتی می‌توان اطلاعات (نام و سن) جدید را به برنامه افزود. همچنین موارد سن و نام را می‌توان به دفعات در برنامه استفاده نمود بدون آنکه مجبور به نوشتن کدهای تکراری شویم (DRY - Don't repeat yourself). البته این مثال با توجه به اطلاعات پایتونی جاری ارایه شده است و دارای ضعفی است که در آینده خود متوجه آن خواهید شد :)

همانطور که مشاهده می‌شود در پایتون برای ایجاد دسترسی به دیگر ماژول‌ها می‌بایست ابتدا آن‌ها را import کرد و این عمل در هر جایی از بدنه ماژول یا اسکریپت جاری ممکن است. البته باید توجه داشت که اجرای کدهای پایتون سطر به سطر از بالا به پایین می‌باشد و در صورت نیاز به هر ماژول می‌بایست پیش‌تر آن را import نمایید.

برای import هر ماژول می‌بایست نام تمام بسته‌های موجود از ابتدا تا ماژول مورد نظر به ترتیب ذکر گردد به صورتی که همگی با یک کاراکتر . به یکدیگر متصل شده باشند. در پایان نیز نام ماژول مورد نظر ذکر می‌گردد:

import actors.names.actor1

ماژول‌های داخل هر بسته را می‌توان به صورت زیر نیز import کرد:

from actors.names import actor1

استفاده از روش دوم مزایایی دارد که در کامیونیتی پایتون آن را به مراتب پر استفاده‌تر ساخته است. برای مثال فراخوانی اجزای داخلی ماژول را ساده‌تر می‌سازد و دیگر نیازی به ذکر نام بسته ها نخواهد بود. این مورد را به همراه نکات دیگر پیرامون import کردن ماژول‌ها طی دروس آتی خواهید دید. ذکر تمام ویژگی‌ها و کاربردهای موجود بدون آشنایی با دیگر اجزای زبان برنامه‌نویسی پایتون بیهوده است و در ادامه این کتاب به ترتیب با این اجزا آشنا خواهید شد.

پشت صحنه اجرا¶

زمانی که اقدام به اجرای یک اسکریپت می‌کنید؛ ابتدا، اسکریپت و تمام ماژول‌های import شده در آن به بایت‌کد کامپایل و سپس بایت‌کد‌های حاصل جهت تفسیر به زبان ماشین و اجرا، به ماشین مجازی فرستاده می‌شوند. آنچه ما از آن به عنوان مفسر پایتون (پیاده‌سازی CPython) یاد می‌کنیم در واقع ترکیبی از یک کامپایلر و یک ماشین مجازی است. تصویر پایین به خوبی روند اجرای کدهای پایتون را نمایش می‌دهد.

بایت‌کد هر ماژول‌ پایتون در قالب فایلی با پسوند pyc که یاد‌آور py Compiled است، ذخیره می‌گردد. این فایل در یک زیردایرکتوری با نام __pycache__ داخل همان دایرکتوری ماژول ذخیره می‌شود و نام‌گذاری آن نیز با توجه به نام ماژول و نسخه‌ مفسر پایتون مورد استفاده، انجام می‌گیرد (نمونه: module.cpython-34.pyc). مفسر پایتون از این فایل ذخیره شده جهت افزایش سرعت اجرا در آینده بهره خواهد برد؛ به این صورت که در نوبت‌های بعدی اجرا چنانچه تغییری در کدهای ماژول یا نسخه‌ مفسر پایتون صورت نگرفته باشد، مفسر با بارگذاری فایل بایت‌کد موجود از کامپایل مجدد صرف نظر می‌کند.

کدنویسی در حالت تعاملی را در درس بعدی خواهید آموخت ولی به یاد داشته باشید که مفسر پایتون محیط کدنویسی در این حالت را به مانند یک اسکریپت در نظر می‌گیرد.

ایجاد محیط مجازی¶

حالتی را در نظر بگیرید که در ایجاد پروژه‌های مختلف به نسخه‌های متفاوتی از برخی کتابخانه‌ها نیاز دارید؛ در این صورت چگونه می‌توانید چندین نسخه‌ متفاوت از یک کتابخانه‌ را در پایتون نصب نمایید؟ برای نمونه، فرض نمایید می‌خواهیم بر روی توسعه دو وب‌سایت؛ یکی توسط نسخه جدید (1.8) وب فریم‌ورک جنگو (Django) و دیگری بر روی یک نسخه قدیمی (0.96) از آن کار کنیم، ولی نمی‌توانیم!؛ زیرا که نمی‌شود هر دوی این نسخه‌ها را با هم در پایتون (دایرکتوری site-packages) نصب داشت. در این وضعیت راه حل ایجاد محیط‌هایی مجازی (Virtual Environments) برای توسعه پروژه‌های مورد نظر است؛ محیطی که توسعه و اجرای هر پروژه پایتون را به همراه تمام وابستگی‌های (Dependencies) آن از پروژه‌های دیگر جدا یا ایزوله (isolate) می‌کند. در ادامه به بررسی دو ابزار رایج در این رابطه می‌پردازیم.

user> sudo pip install -U pip

[...]
Successfully installed pip[...]

user>

user> sudo pip install virtualenv

[...]
Successfully installed virtualenv[...]

user>

user> virtualenv Documents/SampleENV/

user> virtualenv --python=python2 ENV

user> virtualenv --python=python3 ENV

user> virtualenv --python=/opt/python3.3/bin/python ENV

> virtualenv --python=C:\Python25\python.exe Documents\SampleENV\

user> cd Documents/SampleENV/
user> source bin/activate
(SampleENV)$

(SampleENV)$ deactivate
user>

> cd Documents\SampleENV\
> Scripts\activate.bat
(SampleENV)>

(SampleENV)> deactivate.bat
>

user> pyvenv Documents/SampleENV/

user> cd Documents/SampleENV/
user> source bin/activate
(SampleENV)$

(SampleENV)$ deactivate
user>

> C:\Python34\python C:\Python34\Tools\Scripts\pyvenv.py Documents\SampleENV\

> C:\Python34\python -m venv Documents\SampleENV\

> cd Documents\SampleENV\
> Scripts\activate.bat
(SampleENV)>

(SampleENV)> deactivate.bat
>

انتشار پروژه¶

اکنون اطلاعات کافی برای شروع یک پروژه از پایتون را دارید ولی چنانچه می‌خواهید با ساختار مناسب پروژه‌ای که قرار است برای استفاده افراد دیگر از طریق PyPI یا سرویس‌هایی نظیر github.com منتشر شود (مانند یک کتابخانه کاربردی) آشنا شوید، ادامه این بخش را نیز مطالعه نمایید.

در یک پروژه کامل که میخواهیم آن را در کامیونیتی پایتون منتشر سازیم، جدا از سورس کد لازم است موارد دیگری نیز در ساختار آن در نظر گرفته شود؛ به ساختار پایین توجه نمایید:

my_project
.
├── pyproject.toml
│
├── LICENSE.txt
├── README.rst
├── requirements.txt
│
├── src/
│   └── unique_pakage_name/
│       ├── __init__.py
│       └── main.py
│
├── docs/
└── test/

ساختار ابتدایی تنها شامل سورس کد می‌بود ولی در این ساختار تمام سورس کد در قالب یک بسته پایتون بخشی از مجموعه بزرگتری است که در آن یک سری فایل به مانند requirements.txt ،README.rst و pyproject.toml افزوده شده است. تاکید می‌شود که در حال حاضر نیازی به رعایت این ساختار و ایجاد تمامی این فایل‌ها نیست.

pyproject.toml: تمام اطلاعات مورد نیاز برای فرآیند تولید (Build) یک Distribution یا یک بسته قابل انتشار از پروژه مورد نظر توسط این فایل تعریف می‌گردد. [اسناد پایتون]

README.rst: تمام پروژه‌ها می‌بایست شامل سندی برای توصیف خود باشند. در پایتون برای ایجاد اسناد معمولا از زبان نشانه‌گذاری reStructuredText استفاده می‌گردد و به همین دلیل این اسناد پسوند rst دارند که البته اجباری به این مورد نیست و می‌توانید برای ایجاد این فایل از Markdown (پسوند md) نیز استفاده نمایید.

requirements.txt: از این فایل برای معرفی کتابخانه‌های خاصی که در پروژه استفاده شده‌اند و در زمان نصب یا اجرای سورس کد، وجود یا نصب بودن آن‌ها نیز ضروری است، استفاده می‌گردد.

LICENSE.txt: این فایل پروانه‌ انتشار پروژه را مشخص می‌کند و اغلب حاوی یک کپی از متن پروانه‌های متن باز رایج به مانند MIT ،GPL یا BSD می‌باشد.

docs: در این دایرکتوری اسناد (راهنما، آموزش و...) پروژه قرار داده می‌شوند. ایجاد این اسناد در کامیونیتی پایتون معمولا توسط Sphinx انجام می‌شود. قابل ذکر است که در تولید این کتاب نیز از همین ابزار استفاده شده است.

test: این دایرکتوری محل نگهداری کدهای مربوط به تست پروژه می‌باشد. تست‌نویسی یک امر ضروری در روند توسعه هر پروژه برنامه‌نویسی است. این دایرکتوری می‌تواند هم در بالا ترین شاخه از پروژه و هم در داخل دایرکتوری سورس کد قرار داده شود.

اکنون می توان از روی این پروژه یک توزیع (Distribution) ایجاد و آن را با استفاده از ابزارهایی به مانند Twine یا Poetry بر روی PyPI منتشر ساخت. [برای کسب اطلاعات بیشتر می‌توانید از اسناد پایتون استفاده نمایید]

در صورت علاقه می‌توانید نگاهی نیز به پروژه saeiddrv/PackagingPythonProjects بیاندازید که تمامی مراحل را به صورت کاربردی بر پایه Poetry پیاده‌سازی کرده است.

😊 امیدوارم مفید بوده باشه