تعرف على كيفية إنشاء مكتبة بايثون الأولى الخاصة بك! في سلسلة المقالات هذه، سنرشدك خلال عملية إنشاء ونشر مكتبة بايثون باستخدام الشعر. لنبدأ ببناء تطبيق آلة حاسبة صغير، يغطي كل شيء بدءًا من التكوين الأولي وحتى تنفيذ واختبار الوظائف الأساسية. في نهاية هذه السلسلة، ستكون مكتبتك جاهزة للمشاركة مع العالم على PyPI.

ما هو الشعر؟

الشعر هو أداة لإدارة التبعية والتعبئة لمشاريع بايثون. فهو يبسط عملية إنشاء المكتبات والتطبيقات وصيانتها من خلال أتمتة العديد من المهام التي تتطلب تقليديًا أدوات متعددة. يأتي الشعر مزودًا بجميع الأدوات التي قد تحتاجها لإدارة مشاريعك بشكل حتمي. فيما يلي بعض المزايا الرئيسية للشعر:

• إنشاء المشاريع: يمكنك إنشاء مشاريعك وتجميعها بسهولة باستخدام أمر واحد.
• شارك عملك: اجعل عملك معروفًا من خلال نشره على PyPI.
• التحقق من حالة تبعياتك: احصل على عرض لتبعيات مشروعك بأمر واحد فقط.
• حل التبعية: الشعر يأتي مع محلل التبعية الشامل، والذي سيجد دائمًا حلاً إذا كان موجودًا.
• العزل: يستخدم الشعر بيئات افتراضية تم تكوينها أو ينشئ بيئات خاصة به ليكون معزولًا دائمًا عن نظامك.
• واجهة سطر الأوامر البديهية: أوامر الشعر بديهية وسهلة الاستخدام، وحساسة للافتراضيات ولكنها قابلة للتكوين.

مع هذه المزايا، يبرز الشعر كأداة قوية وفعالة لتطوير مشاريع بايثون.

ماذا نحتاج قبل أن نبدأ مكتبة بايثون الخاصة بنا؟

قبل أن نبدأ في كتابة التعليمات البرمجية، نحتاج إلى إعداد بيئة التطوير الخاصة بنا. فيما يلي الخطوات للتأكد من أن كل شيء جاهز:

تحقق من إصدار بايثون

أولاً، نحتاج إلى التأكد من تثبيت أحدث إصدار من Python. للتحقق من إصدار Python المثبت على نظامك، قم بتشغيل الأمر التالي في الوحدة الطرفية:

python --version

إذا لم يكن لديك بايثون مثبتًا بالفعل أو كنت بحاجة إلى تحديثه، فيمكنك تنزيله وتثبيته من موقع بايثون الرسمي.

تثبيت الشعر

بعد التأكد من تثبيت أحدث إصدار من Python، فإن الخطوة التالية هي تثبيت Poetry. يمكنك تثبيت تطبيق Poetry باتباع التعليمات المفصلة في الوثائق الرسمية. إليك أمر سريع للتثبيت:

curl -sSL https://install.python-poetry.org | python3 -

بدء مكتبتك: الخطوات الأولى

الخطوة 1: إنشاء المشروع بالشعر

الآن بعد أن قمنا بتثبيت Python وPoetry، حان الوقت لبدء مشروع الآلة الحاسبة الخاص بنا. الشعر يجعل من السهل إنشاء مشروع جديد بأمر بسيط.

انتقل إلى الدليل الذي تريد إنشاء مشروعك فيه وقم بتشغيل الأمر التالي في المحطة:

poetry new calculator
cd calculator

يقوم هذا الأمر بإنشاء بنية مشروع جديدة لك، والتي تتضمن المجلدات والملفات الأساسية.

calculator/
├── README.md
├── calculator
│   └── __init__.py
├── pyproject.toml
└── tests
    └── __init__.py

دعونا نفهم البنية التي تم إنشاؤها:

• README.md: ملف توثيقي لوصف مشروعك.
• الآلة الحاسبة/: مجلد يحتوي على الكود المصدري لتطبيقك.
• الاختبارات/: مجلد لاختبارات وحدتك.
• pyproject.toml: ملف التكوين الرئيسي للشعر.

الخطوة الثانية: تنفيذ وظائف الآلة الحاسبة

الآن لنقم بإنشاء وظائف الآلة الحاسبة داخل ملف الآلة الحاسبة/calculator.py.

calculator/
├── calculator.py
├── __init__.py

افتح ملف الآلة الحاسبة.py وقم بتنفيذ وظائف الآلة الحاسبة الأساسية:

def add(a, b):
    return a   b

def subtract(a, b):
    return a - b

def multiply(a, b):
    return a * b

def divide(a, b):
    if b == 0:
        raise ValueError("Não é possível dividir por zero")
    return a / b

الخطوة 3: اختبار وظائف الآلة الحاسبة

يعد الاختبار ضروريًا لضمان جودة البرامج، وتوفير الموثوقية في إصلاحات الأخطاء وتطوير التعليمات البرمجية. في هذا المثال، سوف نستخدم اختبارات الوحدة للتحقق من صحة وظائف الآلة الحاسبة. لنقم بإعداد بيئة الاختبار وكتابة بعض حالات الاختبار للتأكد من أن العمليات الحسابية تعمل بشكل صحيح.

تكوين بيئة الاختبار

ابدأ بإضافة pytest باعتباره تبعية تطوير:

poetry add --dev pytest

الآن، قم بإنشاء ملف يسمى test_calculator.py داخل مجلد الاختبارات:

import pytest
from calculator.calculator import add, subtract, multiply, divide

def test_add():
    assert add(2, 3) == 5
    assert add(-1, 1) == 0
    assert add(0, 0) == 0
    assert add(-1, -1) == -2

def test_subtract():
    assert subtract(5, 2) == 3
    assert subtract(0, 0) == 0
    assert subtract(-1, 1) == -2
    assert subtract(-1, -1) == 0

def test_multiply():
    assert multiply(2, 3) == 6
    assert multiply(5, 0) == 0
    assert multiply(-1, 1) == -1
    assert multiply(-2, -3) == 6

def test_divide():
    assert divide(6, 2) == 3
    assert divide(5, 2) == 2.5
    assert divide(-10, 2) == -5
    with pytest.raises(ValueError):
        divide(4, 0)

أخيرًا، ما عليك سوى إجراء الاختبارات باستخدام الأمر التالي:

poetry run pytest

الخطوة 4: النشر على جيثب

الآن بعد أن تمت تغطية طلبنا بالاختبارات، فلنجهزه لمشاركته على GitHub. اتبع الخطوات أدناه لإضافة مشروعك إلى GitHub:

1. إنشاء مستودع على GitHub: انتقل إلى GitHub وقم بإنشاء مستودع جديد للآلة الحاسبة الخاصة بك.

2. أضف مشروعك إلى المستودع:

• قم بتهيئة مستودع Git داخل دليل مشروعك إذا لم تتم تهيئته بالفعل:

git init

• أضف جميع الملفات إلى Git وقم بالالتزام الأول:

git add .
git commit -m "Initial commit"

• قم بتوصيل المستودع المحلي الخاص بك بالمستودع البعيد على GitHub:

git remote add origin 

• قم بتحميل ملفاتك إلى GitHub:

git push -u origin main

أصبح مشروعك الآن على GitHub وجاهز للمشاركة والتعاون مع المطورين الآخرين.

الخطوة 5: التثبيت عبر النقطة أو الشعر

لتثبيت مكتبتك مباشرة، فقط استخدم الأوامر التالية:

• عبر النقطة:

pip install git https://github.com/seu_usuario/seu_repositorio.git

• عبر الشعر:

poetry add git https://github.com/seu_usuario/seu_repositorio.git

ماذا يأتي بعد ذلك؟

في هذا الجزء الأول من البرنامج التعليمي، نغطي الأساسيات الأساسية لإنشاء مكتبة بايثون باستخدام الشعر. لقد بدأنا بإعداد بيئة التطوير، وقمنا بتنفيذ آلة حاسبة أساسية مع اختبارات الوحدات باستخدام pytest، وشاركنا المشروع على GitHub للتعاون.

في الجزء التالي من هذا البرنامج التعليمي، سنستكشف كيفية نشر مكتبتك على PyPI، مستودع حزمة Python القياسي، ونتعلم كيفية تثبيته باستخدام Poetry أو النقطة مباشرة من PyPI. لن يؤدي هذا إلى تسهيل استخدام مكتبتك للمطورين الآخرين فحسب، بل سيساعد أيضًا في دمجك مع مجتمع Python.

تهانينا على وصولك إلى هذا الحد! أتمنى أن تستمتع بإنشاء مكتبة بايثون الخاصة بك. لا تتردد في مشاركة الأسئلة أو الاقتراحات في التعليقات. لننتقل الآن إلى الجزء الثاني ونواصل رحلتنا في التعاون مع مجتمع بايثون.

مراجع

• Canal Eduardo Mendes (@Dunossauro) إنشاء حزمة بايثون من الصفر: من المتطلبات إلى النشر
• التوثيق الشعري
• الشعر: بناء حزم بايثون بطريقة سهلة