فایل requirements.txt چیست؟

مقدمه

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

فایل requirements.txt در پایتون به توسعه‌دهندگان امکان می‌دهد تمامی کتابخانه‌ها و پکیج‌های موردنیاز پروژه را در قالبی استاندارد ذخیره کنند. این فایل به‌راحتی توسط ابزار مدیریت پکیج پایتون (Pip) شناسایی می‌شود و به نصب سریع و دقیق این وابستگی‌ها کمک می‌کند. در این مقاله، ابتدا با مفهوم و اهمیت فایل requirements.txt در پایتون آشنا می‌شویم و سپس به جزئیات نحوه ایجاد، استفاده، و مدیریت این فایل می‌پردازیم.

فایل requirements.txt چیست؟

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

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

اهمیت استفاده از فایل requirements.txt در پروژه‌های پایتون

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

نحوه ایجاد فایل requirements.txt

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

pip freeze > requirements.txt

این دستور، لیست کاملی از تمام کتابخانه‌ها و نسخه‌های آن‌ها را که در محیط فعلی نصب شده‌اند، تولید می‌کند و در فایل requirements.txt ذخیره می‌کند. این فایل می‌تواند در هر زمان برای نصب سریع و دقیق این وابستگی‌ها در دسترس باشد.

نحوه نوشتن پکیج‌ها و نسخه‌ها در فایل requirements.txt

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

<pre class="wp-block-syntaxhighlighter-code">Django==3.2
requests==2.26.0
numpy>=1.21.0<br />
</pre>

• == به معنی نسخه دقیق است؛
• >= به این معنی است که نسخه مشخص‌شده و نسخه‌های جدیدتر از آن معتبر هستند.

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

نصب وابستگی‌ها از فایل requirements.txt

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

pip install -r requirements.txt

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

چگونگی مدیریت تغییرات در فایل requirements.txt

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

pip install --upgrade <package-name>

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

pip freeze > requirements.txt

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

بروزرسانی و مدیریت وابستگی‌ها در requirements.txt

در زمان توسعه، ممکن است نیاز به بروزرسانی یک یا چند پکیج داشته باشید. برای این کار می‌توانید از دستور pip install –upgrade [package-name]  استفاده کنید و سپس فایل requirements.txt  را به‌روزرسانی کنید. برای بروزرسانی کامل، می‌توانید دوباره دستور pip freeze  > requirements.txt را اجرا کنید.

کار با محیط‌های مجازی و requirements.txt

محیط‌های مجازی یا Virtual Environments  برای جلوگیری از تداخل پکیج‌های مختلف در پروژه‌های جداگانه استفاده می‌شوند. استفاده از محیط‌های مجازی به شما کمک می‌کند که وابستگی‌های خاص هر پروژه را به‌طور مجزا مدیریت کنید.
ابتدا یک محیط مجازی ایجاد و فعال کنید، سپس کتابخانه‌ها را نصب کرده و در نهایت فایل requirements.txt  را ایجاد کنید تا همه وابستگی‌ها به صورت ایزوله برای همان پروژه ذخیره شود.

تفاوت requirements.txt  و Pipfile/Pipenv

فایل requirements.txt یک روش سنتی برای مدیریت وابستگی‌هاست. در مقابل، ابزارهایی مانند Pipfile  و Pipenv  جدیدتر هستند و امکانات پیشرفته‌تری برای مدیریت وابستگی‌ها و محیط‌ها فراهم می‌کنند. در برخی پروژه‌های بزرگ یا مواردی که به دقت بیشتری در نسخه‌های پکیج‌ها نیاز است، ممکن است ترجیح دهید از Pipfile  استفاده کنید.

مدیریت نسخه‌های ناسازگار با استفاده از requirements.txt

ممکن است نسخه‌های پکیج‌ها با هم ناسازگار باشند. برای بررسی این موضوع می‌توانید از ابزارهایی مانند pip check استفاده کنید. همچنین، pipdeptree  نیز ابزاری مفید برای مشاهده و تحلیل وابستگی‌های غیرمستقیم است.

نکات و ترفندهای پیشرفته در استفاده از requirements.txt

برای جداسازی وابستگی‌های مختلف می‌توانید از فایل‌های requirements  اضافی مانند dev-requirements.txt  استفاده کنید. این فایل می‌تواند وابستگی‌های مربوط به توسعه و آزمایش را به صورت جداگانه ذخیره کند.

خطرات و چالش‌های مرتبط با requirements.txt

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

ابزارهای کمکی برای مدیریت بهتر requirements.txt

ابزارهایی مانند pip-tools  و pipreqs  به شما امکان می‌دهند که مدیریت وابستگی‌ها را به صورت خودکار انجام دهید و به سادگی فایل requirements.txt را ایجاد یا به‌روز کنید.

سؤالات متداول فایل requirements.txt

• فایل requirements.txt در پایتون چه وظیفه‌ای دارد؟
  فایل requirements.txt برای مدیریت و نگهداری فهرست پکیج‌های مورد نیاز پروژه در پایتون استفاده می‌شود. این فایل امکان نصب سریع و دقیق وابستگی‌های پروژه را فراهم می‌کند تا پروژه با همان نسخه‌های مشخص‌شده اجرا شود.
• آیا نیاز است که در همه پروژه‌های پایتون از فایل requirements.txt استفاده شود؟
  اگرچه فایل requirements.txt بیشتر برای پروژه‌های بزرگ یا گروهی اهمیت دارد، اما استفاده از آن حتی در پروژه‌های کوچک نیز کمک می‌کند تا وابستگی‌های پروژه به طور دقیق مدیریت شوند و در هر محیطی قابل اجرا باشند.
• چگونه می‌توان یک پکیج را از فایل requirements.txt حذف کرد؟
  برای حذف یک پکیج از فایل requirements.txt، ابتدا پکیج مورد نظر را از محیط پروژه پاک کنید، سپس با استفاده از دستور pip freeze > requirements.txt فایل را به‌روز کنید تا فهرست وابستگی‌ها بدون پکیج حذف شده ذخیره شود.
• فایل requirements.txt چه تفاوتی با ابزارهای دیگر مدیریت وابستگی مثل Pipenv دارد؟
  فایل requirements.txt یک روش سنتی و ساده برای مدیریت وابستگی‌هاست، در حالی که ابزارهایی مانند Pipenv و Poetry امکانات پیشرفته‌تری دارند، از جمله مدیریت خودکار نسخه‌ها و محیط‌های مجازی.
• چگونه می‌توان از ناسازگاری نسخه‌های پکیج‌ها در فایل requirements.txt جلوگیری کرد؟
  برای جلوگیری از ناسازگاری، می‌توانید نسخه دقیق پکیج‌ها را در فایل requirements.txt قفل کنید. همچنین، بررسی‌های دوره‌ای با ابزارهایی مانند pip check به اطمینان از سازگاری نسخه‌ها کمک می‌کند.
• آیا می‌توان از چند فایل requirements برای نیازهای مختلف پروژه استفاده کرد؟
  بله، در بسیاری از پروژه‌ها از فایل‌های متعدد مانند dev-requirements.txt برای نیازهای توسعه و prod-requirements.txt برای محیط تولید استفاده می‌شود تا وابستگی‌ها به طور جداگانه مدیریت شوند و محیط‌های مختلف را پشتیبانی کنند.

جمع بندی

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