python gradle plugin

Python Gradle Plugin

الآن ، يمكنك تشغيل البرامج النصية Python مع Java و Gradle يبني فقط.

يقوم هذا البرنامج المساعد Gradle تلقائيًا بتنزيل وتثبيت أداة Conda محددة لتشغيل البرامج النصية Python أو تنفيذيات أخرى ( pip ، conda إلخ) من Virtual ENV.

يمكن أن يكون تكوين مشروع Python مؤتمانًا بالكامل بواسطة مهام Gradle الآن.

متطلبات

• جافا 11 أو أعلى
• Gradle 6.2 أو مشروع أعلى

غاية

تشغيل البرامج النصية أو المشاريع Python من خلال تنفيذ مهمة واحدة من شأنها تنزيل وتثبيت بيئة Python الظاهرية.

يمكن إجراء تكوين Python إضافي (تثبيت حزم PIP/Conda وما إلى ذلك) عن طريق تحديد مهام Gradle في ملف build.gradle.kts .

الاستخدام

خطوات لتشغيل نص Python من Gradle

1. قم بتطبيق البرنامج المساعد على مشروع كما هو موضح في بوابة Gradle.

2. قم بتكوين مكون إضافي عن طريق تحديد إصدار Python المطلوب في برنامج Build Script:

   pythonPlugin {
       pythonVersion = " 3.8.2 "
   }

3. حدد مهمة لتشغيل البرنامج النصي المطلوب Python ، على سبيل المثال لتشغيل البرنامج النصي quicksort.py في main Dir ، أضف تكوين المهمة التالي لإنشاء البرنامج النصي:

   tasks {
       register< VenvTask >( " runQuickSort " ) {
               workingDir = projectDir.resolve( " main " )
               args = listOf ( " quicksort.py " )
       }
   }

4. قم بتشغيل نص Python من Gradle:

    # Linux
   ./gradlew runQuickSort
   # Windows
   gradlew.bat runQuickSort

5. انتظر حتى يتم تثبيت كوندا وإعداد البيئة.

6. يتمتع :)

خصائص Python Plugin

يمكن ضبط السلوك الافتراضي المكون الإضافي عن طريق تحديد الخصائص التالية:

• pythonVersion -> إصدار بيئة Python ، الافتراضي 3.13.0 ، يمكن التحقق من تلك المتاحة على https://anaconda.org/conda-forge/python/
• condaVersion -> إصدار Miniconda أو Anaconda ، py312_24.9.2-0 ، يمكن فحصها المتاحة على https://repo.anaconda.com/miniconda/ أو https://repo.anaconda.com/archive/ (anaconda)
• condaInstaller -> اسم تثبيت البيئة كوندا ، الافتراضي هو Miniconda3 ، لتغيير Anaconda إلى Anaconda3
• condaRepoUrl -> عنوان URL المستودع الذي يجب استخدامه لتنزيل الثنائيات ، الافتراضي https://repo.anaconda.com/miniconda ، من أجل Anaconda https://repo.anaconda.com/archive/
• اسم condaRepoUsername
• condaRepoPassword -> كلمة المرور للمصادقة الأساسية ، المستخدمة إذا تم تحديد condaRepoUsername ، لا ينبغي تمريرها مباشرة في ملف البرنامج النصي ، يمكن توفيرها بواسطة خصائص Gradle ، غائبة بشكل افتراضي
• condaRepoHeaders -> رؤوس اختيارية إضافية تستخدم للاتصال ، خريطة فارغة بشكل افتراضي
• useHomeDir -> عندما true دليل التثبيت الافتراضي هو الذي يكون من خاصية نظام user.home ، false افتراضيًا
• installDir -> خاصية لتخصيص دليل تثبيت conda true يساوي <rootProjectDir>/.gradle/python useHomeDir
• systemArch -> بنية نظام التشغيل ، يتم الحصول على افتراضي من خاصية نظام os.arch
• ideaDir -> Target .idea directory للكشف عن مشروع Intellij ، يساوي <rootProjectDir>/.idea بشكل افتراضي

عينة من تكوين الامتداد داخل ملف build.gradle.kts :

pythonPlugin {
    pythonVersion = " 3.7.0 "
    condaVersion = " 2022.05 "
    condaInstaller = " Anaconda3 "
    condaRepoUrl = " https://nexus.com/repositories/conda "
    condaRepoUsername = " user "
    condaRepoPassword = extra[ " conda.repo.pass " ].toString()
    condaRepoHeaders = mapOf (
        " CUSTOM_HEADER_1 " to " headerValue1 " ,
        " CUSTOM_HEADER_2 " to " headerValue2 "
    )
    installDir = file(layout.buildDirectory.dir( " python " ))
    systemArch = " arm64 "
}

خصائص مهمة VenvTask

يمكن تخصيص جميع المهام التي يجب تنفيذها في Virtual Env أيضًا بواسطة الحقول التالية:

• venvExec -> اسم القابل للتنفيذ من Virtual Env والذي سيتم تنفيذه ، python افتراضيًا
• inputFile -> ملف إدخال اختياري ، لا شيء افتراضيًا
• outputFile -> ملف الإخراج الاختياري ، لا شيء افتراضيًا
• args -> قائمة الوسيطات لـ venvExec قابلة للتنفيذ ، فارغة بشكل افتراضي
• workingDir -> دليل العمل ، دليل المشروع افتراضيًا
• environment -> خريطة مع متغيرات البيئة لتطبيقها أثناء التنفيذ ، فارغة بشكل افتراضي

نموذج تكوين VenvTask داخل ملف build.gradle.kts :

register< VenvTask >( " runPythonScript " ) {
    venvExec = " python "
    inputFile = file( " inputFile.txt " )
    outputFile = file( " outputFile.txt " )
    args = listOf ( " --some-flag " , " arg1 " )
    workingDir = projectDir.resolve( " main " )
    environment = mapOf ( " ENV_VAR_TO_PRINT " to " sampleEnvVar " )
}

يمكن العثور على أمثلة إضافية جنبًا إلى جنب مع تكوينات piptasks عينة في وحدة examples في هذا المشروع.

الإعداد Intellij

استيراد السيارات المثبتة Python SDK:

• تثبيت البرنامج المساعد SDK-Import Intellij.
• تنفيذ مهمة envSetup Gradle.
• اختر من بين "أدوات" -> "reimport SDK" لاستيراد Python SDK المثبت مع البرنامج المساعد.

الطريقة اليدوية:

• للحصول على الإكمال التلقائي والوحدات النمطية المعترف بها بشكل صحيح في نقطة فكرة Intellij إلى بيئة conda كما هو موضح في: https://www.jetbrains.com/help/idea/configuring-python-sdk.html
• للحصول على وحدات المصدر المستوردة المعترف بها بشكل صحيح في الاختبارات ، انقر بزر الماوس الأيمن على دليل المصادر (على سبيل المثال main ) -> Mark Directory as -> as Sources root .

كوندا تثبيت الدلائل

• Linux - <installDir>/.gradle/python/Linux/<condaInstaller>-<condaVersion>

• Windows - <installDir>/.gradle/python/Windows/<condaInstaller>-<condaVersion>

• MacOSX - <installDir>/.gradle/python/MacOSX/<condaInstaller>-<condaVersion>

حيث يكون <installDir> هو كتالوج الجذر حيث سيتم تثبيت conda محدد بواسطة installDir خاصية ، <condaInstaller> هو مثبت conda على سبيل المثال Miniconda3 و <condaVersion> هو إصدار مثبت conda على سبيل المثال py38_4.8.3

إذا كنت على دراية بـ Conda ، فيمكنك أيضًا تنفيذ أوامر Conda مثل conda deactivate أو conda install مباشرة مع الثنائيات من الكتالوجات أعلاه.

ملحوظات

• قد يكون هناك حاجة لتوضيح PYTHONPATH في النظام قبل تشغيل أي مهام (https://stackoverflow.com/a/31841132)

• يمكنك أيضًا تشغيل بعض البرامج النصية البسيطة في Python داخل ملفات بناء مثل هذا:

  

  يمكن أن تكون ميزة Intellij "حقن اللغة" مفيدة في مثل هذا السيناريو :)

القضايا المعروفة

• /usr/bin/env: 'python': No such file or directory عند تنفيذ مهمة envSetup -> يرتبط بحد Shebang Char الذي هو 128 .

  عند تثبيت Conda إذا كان مسار البادئة أطول من الحد من Shebang الافتراضي ( #!/usr/bin/env python ) يتم استخدامه في ملف البرنامج النصي Conda المثبت ( condabin/conda ). نظرًا لأنه لا يمكن الوصول إلى ثنائي الثنائي من خلال هذا المسار ، يتم إلقاء الاستثناء.

  يتمثل الحل الأسهل في تخزين مشروع الجذر في أقصر مسار ممكن أو استخدام installDir لتحديد مسار أقصر لكل مشروع فرعي مزعج معين.