تنزيل superhelp - تنزيل رمز المصدر superhelp

superhelp

شفرة المصدر الأخرى

v1.1.0:

تنزيل

https://github.com/grantps/superhelp

مثال HTML الإخراج

رقم الإصدار: 1.9.5 المؤلف: جرانت باتون سيمبسون

ملخص

SuperHelp هو مساعدة للبشر! الهدف هو توفير مساعدة مخصصة للمقتطفات الرمز البسيط. لا يهدف SuperHelp إلى استبدال مساعدة Python المدمجة ولكن لاستكمالها لهياكل كود الثعبان الأساسية. سيتم أيضًا رأي SuperHelp. يمكن تقديم المساعدة في مجموعة متنوعة من السياقات بما في ذلك متصفحات المحطة ومواقع الويب (ربما كجزء من البرامج التعليمية عبر الإنترنت).

بداية سريعة

انقر فوق الزر أدناه لفتح دفتر Noteber Jupyter Binder ، يمكنك اللعب في Eg Get نصيحة على مقتطف أو خط Python

أو ضع ما يلي في الجزء العلوي من البرنامج النصي Python وقم بتشغيل البرنامج النصي:

 import superhelp
superhelp.this()

تثبيت

ملاحظة - Python 3.9+ فقط. إذا كان لديك إصدار أقدم من Python ، فاستخدم زر Binder Jupyter Notebook بدلاً من ذلك (انظر أعلى)

لتثبيت

ملحوظة

استخدم PIP

على سبيل المثال

 $ python3 -m pip install superhelp

تحقق عن طريق الجري

 $ shelp

إذا لم ينجح الأمر ، وكنت على Linux ، فإن إضافة ما يلي إلى ملف .bashrc قد يصلح المشكلة:

 export PATH=$PATH:~/.local/bin

أو استنساخ الريبو
$ git clone https://github.com/grantps/superhelp.git $ python3 setup.py install

مثال استخدام حالات

تحب شارلوت التحقق من رمزها قبل أن يراها الآخرون ذلك يشمل ذلك
```
  import superhelp
  superhelp.this(warnings_only=True)
```
في الجزء العلوي من كل نص. عندما تكون راضية عن الرمز ، تعلق هذين السطران.
Avi هو مبتدئ Python ويريد الحصول على المشورة بشأن وظيفة من خمسة أسطر كتبها لعرض التحيات إلى قائمة من الأشخاص. يتعلم عن اتفاقيات بيثون للتسمية المتغيرة وطرق أفضل للجمع بين السلاسل.
زاك يريد الحصول على المشورة بشأن توبلي المسماة. يتعلم كيفية إضافة سلاسل المستند إلى الحقول الفردية.
تفكر Noor في تقديم بعض التعليمات البرمجية إلى Stack Overflow ولكنه يريد تحسينه أولاً (أو ربما الحصول على أفكار لحل مباشرة). تكتشف أن فهم القائمة قد يعمل. كما أنها تدرك شاملات القاموس لأول مرة.
لقد كتب آل ديكور بيثون بسيط لكنه يريد معرفة ما إذا كان هناك أي شيء يمكن تحسينه. يتعلم كيفية استخدام functool.wrap من مثال مقدم.
Moana هي مطور Python ذي خبرة ولكنه يميل إلى نسيان أشياء مثل Strings Doc في وظائفها. تتعلم نهجًا قياسيًا وتبدأ في استخدامه في كثير من الأحيان. تجد Moana أيضًا البنية الملخصة المفيدة.
يريد بول التحقق من جودة بعض الكود قبل تضمينه في مشروعه. يتعلم عن بعض القضايا ويقوم بتحسينات قبل دمجها.

مثال الاستخدام

لقطة شاشة من إخراج HTML

مثال HTML الإخراج

لقطة شاشة من الإخراج الطرفي

مثال الإخراج الطرفي

السمات الطرفية المتاحة ("الظلام" و "الضوء")

مثال موضوعات الطرفية

لقطة شاشة من الإخراج

مثال الإخراج تخفيض

باستخدام superhelp على دفتر الملاحظات

أضف خلية جديدة في النهاية مع محتوى مثل:

 %%shelp

def sorted(my_list):
    sorted_list = my_list.sort()
    return sorted_list

وتشغيله للحصول على المشورة.

يحتوي دفتر الملاحظات على المزيد من الإرشادات التفصيلية في الأعلى.

باستخدام superhelp على تثبيت محلي

داخل البرنامج النصي الخاص بك

ضع ما يلي في الجزء العلوي من البرنامج النصي الخاص بك ثم قم بتشغيل البرنامج النصي (ملاحظة - هناك نوعان من السفقين على جانبي الملف):

 import superhelp
superhelp.this()

إذا كنت لا تريد إخراج الويب الافتراضي ، يمكنك تحديد إخراج آخر مثل "CLI" (واجهة سطر الأوامر) أو "MD" (Markdown):

 import superhelp
superhelp.this(output='md')

إذا كنت لا تريد المستوى الافتراضي "الإضافي" للرسائل ، فيمكنك تحديد مستوى تفاصيل مختلف ("موجز" أو "رئيسي") على سبيل المثال

 import superhelp
superhelp.this(detail_level='Brief')

أو:

 import superhelp
superhelp.this(detail_level='Main')

إذا كنت تريد فقط رؤية تحذيرات يمكنك تحديد تحذيرات فقط على سبيل المثال

 import superhelp
superhelp.this(warnings_only=True)

يتيح تنفيذ الرمز الخاص بك SuperHelp فهم الكود بشكل أفضل.

إذا كنت تريد تنفيذ الكود الخاص بك أثناء قيام SuperHelp بتقييمه

 import superhelp
superhelp.this(execute_code=True)

يمكنك استخدام العديد من الخيارات كما تريد على سبيل المثال

 import superhelp
superhelp.this(output='md', execute_code=True, warnings_only=True)

من سطر الأوامر (المحطة / وحدة التحكم)

 $ shelp -h  ## get extended help on usage (purpose, defaults, etc)

$ shelp --code "people = ['Tomas', 'Sal', 'Raj']" --output html --detail-level Main
$ shelp -c "people = ['Tomas', 'Sal', 'Raj']" -o html -d Main

$ shelp --file-path my_script.py --output cli --theme light --detail-level Extra
$ shelp -f my_snippet.py -o cli -t light -d Extra

$ shelp --project-path /home/g/proj --exclude-folders env
$ shelp -p /home/g/proj -e env

$ shelp --file-path my_script.py --warnings-only
$ shelp -f my_snippet.py -w

$ shelp --file-path my_script.py --execute-code
$ shelp -f my_snippet.py -x

$ shelp  ## to see advice on an example snippet displayed (detail level 'Extra')

$ shelp --advice-list  ## to see all types of help listed
$ shelp -a