Pygithub: أضف كتابة anontations لـ mypy (إلخ.)

تم إنشاؤها على ٨ سبتمبر ٢٠١٩  ·  6تعليقات  ·  مصدر: PyGithub/PyGithub

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

(لقد افترضت في الأصل من الوصف أن PyGithub قد تم وضع تعليقات توضيحية عليه وفوجئت أنه لم يكن كذلك).

هل هذا شيء فكرت فيه و / أو ستكون منفتحًا عليه؟

feature request improvement

التعليق الأكثر فائدة

من الممكن استخدام أدوات مثل https://github.com/Instagram/MonkeyType لتطبيق كتابة التعليقات التوضيحية المضمنة من ملف كعب روتين. لذا من المحتمل أن نبدأ العمل على كتابة بذرة ، ثم نطبقها مضمنة بعد إسقاط دعم Py2.

ال 6 كومينتر

إذا وافق المشرفون على هذه الفكرة ، فلن أمانع في العمل عليها.

أنا بخير مع هذا ، لكنه لن يكون جهدًا صغيرًا. ربما قبل ذلك ، يجب علينا ترقية المشروع إلى Python 3 (نظرًا لأن Python2 ستختفي قريبًا) ، حتى نتمكن من استخدام التعليقات التوضيحية من نوع Python3 في كل مكان.

من الممكن استخدام أدوات مثل https://github.com/Instagram/MonkeyType لتطبيق كتابة التعليقات التوضيحية المضمنة من ملف كعب روتين. لذا من المحتمل أن نبدأ العمل على كتابة بذرة ، ثم نطبقها مضمنة بعد إسقاط دعم Py2.

حسنًا ، لقد بدأت بالفعل العمل على فكرة trickeydan . لقد قمت بإنشاء ملفات stubs عن طريق تشغيل MonkeyType مقابل unittest وكتبتها إلى ملفات .piy بجانب ملفات .py. سيتطلب الأمر فحص جميع الأجزاء الأساسية يدويًا لأنه يبدو أن MonkeyType قد فاته بعض التفاصيل هنا وهناك للأسف (لذلك قد يستغرق الأمر بعض الوقت).

أعتقد أنه سيكون مطلوبًا أيضًا تصدير أكثر أو أقل من كل نوع لدينا في الوحدة النمطية __init__.py للأشخاص لتضمين نوع PyGithub في عمليات التحقق من الكتابة الخاصة بهم.

إذا كان أي شخص مهتمًا يمكنك التحقق من التقدم هنا: https://github.com/zer0tonin/PyGithub/tree/agg/type_stubs

المشكلة الوحيدة التي لاحظتها حتى الآن هي أن urllib3 لا يبدو أنه يحتوي على أي معلومات طباعة متاحة وللأسف نستخدم عددًا قليلاً من أنواعها.

@ zer0tonin دعونا نبقي الكرة تتدحرج. لماذا لا تفتح PR من فرعك ، حتى نتمكن من المراجعة.

urllib3 فقط لوظيفة إعادة المحاولة ، والتي تم تقديمها مؤخرًا في # 1002. دعونا نرى كيف يمكننا إضافة كعب إلى urllib3 لاحقًا.

مغلق في # 1231
سيتم إضافة تطبيق CI في # 1442

هل كانت هذه الصفحة مفيدة؟
0 / 5 - 0 التقييمات

القضايا ذات الصلة

xpdable picture xpdable  ·  5تعليقات

AdyaAbhra picture AdyaAbhra  ·  5تعليقات

grayaii picture grayaii  ·  4تعليقات

rthill91 picture rthill91  ·  4تعليقات

jacquev6 picture jacquev6  ·  3تعليقات