superhelp

https://github.com/grantps/superhelp

หมายเลขเวอร์ชัน: 1.9.5 ผู้แต่ง: Grant Paton-Simpson

ภาพรวม

Superhelp เป็นความช่วยเหลือสำหรับมนุษย์! เป้าหมายคือการให้ความช่วยเหลือที่กำหนดเองสำหรับตัวอย่างโค้ดอย่างง่าย SuperHelp ไม่ได้มีวัตถุประสงค์เพื่อแทนที่ความช่วยเหลือของ Python ในตัว แต่เพื่อเสริมสำหรับโครงสร้างรหัส Python พื้นฐาน Superhelp จะได้รับความเห็นด้วย สามารถให้ความช่วยเหลือในบริบทที่หลากหลายรวมถึงเทอร์มินัลและเว็บเบราว์เซอร์ (อาจเป็นส่วนหนึ่งของบทเรียนออนไลน์)

เริ่มต้นอย่างรวดเร็ว

คลิกที่ปุ่มด้านล่างเพื่อเปิดสมุดบันทึก Jupyter Binder ที่คุณสามารถเล่นได้ในเช่นรับคำแนะนำเกี่ยวกับตัวอย่างหรือสาย Python

หรือใส่สิ่งต่อไปนี้ที่ด้านบนของสคริปต์ Python ของคุณและเรียกใช้สคริปต์:

 import superhelp
superhelp.this()

การติดตั้ง

หมายเหตุ - Python 3.9+ เท่านั้น หากคุณมี Python รุ่นเก่าให้ใช้ปุ่ม Notebook Binder Jupyter แทน (ดูที่สูงขึ้น)

เพื่อติดตั้ง

บันทึก

1. ใช้ PIP

เช่น

 $ python3 -m pip install superhelp

ตรวจสอบโดยการรัน

 $ shelp

หากไม่ได้ผลและคุณอยู่ใน Linux การเพิ่มสิ่งต่อไปนี้ในไฟล์. bashrc ของคุณอาจแก้ไขปัญหา:

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

2. หรือโคลน repo

   $ git clone https://github.com/grantps/superhelp.git $ python3 setup.py ติดตั้ง

ตัวอย่างการใช้กรณี

• ชาร์ลอตต์ชอบตรวจสอบรหัสของเธอก่อนที่คนอื่นจะเห็นว่ารวมอยู่ด้วย

    import superhelp
    superhelp.this(warnings_only=True)
  

  ที่ด้านบนของแต่ละสคริปต์ เมื่อเธอมีความสุขกับรหัสเธอจะแสดงความคิดเห็นทั้งสองบรรทัด

• AVI เป็นผู้เริ่มต้น Python และต้องการรับคำแนะนำเกี่ยวกับฟังก์ชั่นห้าบรรทัดที่เขาเขียนเพื่อแสดงคำทักทายในรายชื่อผู้คน เขาเรียนรู้เกี่ยวกับการประชุม Python สำหรับการตั้งชื่อตัวแปรและวิธีที่ดีกว่าในการรวมสาย

• Zach ต้องการรับคำแนะนำเกี่ยวกับ Tuple ที่มีชื่อ เขาเรียนรู้วิธีเพิ่มสตริง DOC ในแต่ละสาขา

• นูร์กำลังพิจารณาที่จะส่งรหัสบางส่วนเพื่อสแต็กล้น แต่ต้องการปรับปรุงก่อน (หรืออาจได้รับแนวคิดสำหรับการแก้ปัญหาโดยตรง) เธอค้นพบว่าความเข้าใจในรายการอาจใช้งานได้ เธอยังตระหนักถึงความเข้าใจพจนานุกรมเป็นครั้งแรก

• อัลได้เขียน Dython Decorator อย่างง่าย แต่ต้องการดูว่ามีอะไรที่สามารถปรับปรุงได้หรือไม่ เขาเรียนรู้วิธีใช้ functool.wrap จากตัวอย่างที่ให้ไว้

• Moana เป็นนักพัฒนา Python ที่มีประสบการณ์ แต่มีแนวโน้มที่จะลืมสิ่งต่าง ๆ เช่นสตริงหมอในหน้าที่ของเธอ เธอเรียนรู้วิธีการมาตรฐานและเริ่มใช้บ่อยขึ้น Moana ยังพบว่าผ้าสำลีที่สรุปได้มีประโยชน์

• พอลต้องการตรวจสอบคุณภาพของรหัสก่อนรวมไว้ในโครงการของเขา เขาเรียนรู้เกี่ยวกับปัญหาบางอย่างและทำการปรับปรุงก่อนที่จะรวมเข้าด้วยกัน

ตัวอย่างการใช้งาน

ภาพหน้าจอจากเอาต์พุต HTML

ภาพหน้าจอจากเอาต์พุตเทอร์มินัล

มีธีมเทอร์มินัล ('มืด' และ 'แสง')

ภาพหน้าจอจากเอาท์พุท Markdown

การใช้ 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

ยืดไอเดีย

• ขยายนอกเหนือจากห้องสมุดมาตรฐานไปยังห้องสมุดยอดนิยมเช่นคำขอขวดขวด ฯลฯ

แพ็คเกจอื่น ๆ

https://github.com/aroberge/friendly-traceback