ดาวน์โหลด pep8speaks - pep8speaks ซอร์สโค้ดดาวน์โหลดดาวน์โหลด

pep8speaks

หมวดหมู่อื่นๆ

pep8speaks is back again!

ดาวน์โหลด

Pep 8 พูด

แอพ GitHub เพื่อตรวจสอบรูปแบบรหัส Python โดยอัตโนมัติมากกว่าคำขอดึง

สารบัญ

การติดตั้ง
ตัวอย่าง
คุณสมบัติหลัก
การกำหนดค่า
ผู้ใช้ยอดนิยม
คุณสมบัติเบ็ดเตล็ด
repos ส่วนตัว
วิธีแก้ไขปัญหา PEP 8?
ประกาศการเปิดตัว
การบริจาค
การอัปเดต

การติดตั้ง

ไปที่หน้าแรกของแอพ - https://github.com/apps/pep8-speaks
คลิกที่ปุ่มกำหนดค่า
เพิ่มที่เก็บหรือองค์กรเพื่อเปิดใช้งาน PEP 8 พูด

ตัวอย่าง

คุณสมบัติหลัก

บอทแสดง ความคิดเห็นเพียงครั้งเดียวในคำขอดึงและอัปเดตต่อไป ใน New Commits ไม่เร่งรีบอีเมล!
ความคิดเห็นของบอทเฉพาะในกรณีที่ไฟล์ Python เกี่ยวข้อง ดังนั้นติดตั้งการรวมในที่เก็บทั้งหมดของคุณ บอทจะไม่แสดงความคิดเห็นว่าไม่ควร
โดยค่าเริ่มต้นบอทจะไม่แสดงความคิดเห็นหากไม่มีปัญหา PEP 8 คุณสามารถเปลี่ยนสิ่งนี้ในการกำหนดค่า
คุณสามารถใช้เลือกระหว่าง pycodestyle หรือ flake8 เป็น linter ของคุณ บอทสามารถอ่านการกำหนดค่าสำหรับทั้งคู่
บอทสามารถอ่าน setup.cfg ของคุณสำหรับ [flake8] และ [pycodestyle] ตรวจสอบส่วน Configuration ด้านล่าง

การกำหนดค่า

ไฟล์กำหนดค่าไม่จำเป็นสำหรับการรวมการทำงาน อย่างไรก็ตามสามารถกำหนดค่าเพิ่มเติมได้โดยการเพิ่มไฟล์ .pep8speaks.yml ในรูทของโครงการ นี่คือตัวอย่าง:

 # File : .pep8speaks.yml

scanner :
  diff_only : True # If False, the entire file touched by the Pull Request is scanned for errors. If True, only the diff is scanned.
  linter : pycodestyle # Other option is flake8

pycodestyle : # Same as scanner.linter value. Other option is flake8
  max-line-length : 100 # Default is 79 in PEP 8
  ignore : # Errors and warnings to ignore
    - W504 # line break after binary operator
    - E402 # module level import not at top of file
    - E731 # do not assign a lambda expression, use a def
    - C406 # Unnecessary list literal - rewrite as a dict literal.
    - E741 # ambiguous variable name

no_blank_comment : True # If True, no comment is made on PR without any errors.
descending_issues_order : False # If True, PEP 8 issues in message will be displayed in descending order of line numbers in the file

message : # Customize the comment made by the bot
  opened : # Messages when a new PR is submitted
    header :
      " Hello @{name}! Thanks for opening this PR. "
      # The keyword {name} is converted into the author's username
    footer :
      " Do see the [Hitchhiker's guide to code style](https://goo.gl/hqbW4r) "
      # The messages can be written as they would over GitHub
  updated : # Messages when new commits are added to the PR
    header : " Hello @{name}! Thanks for updating this PR. "
    footer : " " # Why to comment the link to the style guide everytime? :)
  no_errors : " There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers: "

หมายเหตุ:

การตั้งค่าเริ่มต้นอยู่ในข้อมูล/default_pep8speaks.yml .pep8speaks.yml ของคุณจะแทนที่ค่าเหล่านี้
สำหรับการร้องขอการดึงทุกครั้งบอทจะมองหา .pep8speaks.yml ในสาขา base (ที่มีอยู่) หากไม่พบไฟล์ก็จะค้นหาสาขา head (การเปลี่ยนแปลงที่เข้ามา)
ตั้งค่าของ scanner.linter เป็น pycodestyle หรือ flake8
- Flake8 เป็นเสื้อคลุมรอบ ๆ เทือกเขาที่มีการบังคับใช้เพิ่มเติม
สำหรับการกำหนดค่า linter (เช่น ignore หรือ max-line-length ) PEP8Speaks จะมีลักษณะและจัดลำดับความสำคัญการกำหนดค่าตามลำดับต่อไปนี้:
- pycodestyle: หรือ flake8: ส่วนของ .pep8speaks.yml
  - ขึ้นอยู่กับค่า scanner.linter
- [pycodestyle] หรือ [flake8] ส่วนของไฟล์ setup.cfg ในรูทของโครงการ
  - นี่เป็นอิสระจาก scanner.linter ดังนั้นส่วน [flake8] ของ setup.cfg จะทำงานให้กับ pycodestyle
อ่านเพิ่มเติมเกี่ยวกับเอกสารประกอบเทียมและ Flake8

ผู้ใช้ยอดนิยม

	องค์กร	คำอธิบาย
	แพนด้า	เครื่องมือจัดการข้อมูลที่ทรงพลังสำหรับ Python
	Adobe	โอเพ่นซอร์สจาก Adobe
	เปิดใช้งาน	การกระจาย Linux
	Pytorch Lightning	เสื้อคลุม Pytorch ที่มีน้ำหนักเบาสำหรับนักวิจัย ML
	Networkx	Python Library สำหรับทฤษฎีกราฟและเครือข่ายที่ซับซ้อน
	รูปแบบ	การสร้างแบบจำลองทางสถิติและเศรษฐมิติใน Python
	Xarray (Pydata)	อาร์เรย์และชุดข้อมูลที่มีป้ายกำกับ ND ใน Python (Python for Data)
	แดด	Python สำหรับฟิสิกส์พลังงานแสงอาทิตย์
	Astropy	ดาราศาสตร์ใน Python
	scikit เรียนรู้ contrib	โครงการที่เข้ากันได้กับ Scikit-learn
	ภาพ scikit	การประมวลผลภาพใน Python
	Spyder ide	สภาพแวดล้อมการพัฒนา Python ทางวิทยาศาสตร์
	ตัวเร่งปฏิกิริยา	Pytorch Framework สำหรับการวิจัยและพัฒนาการเรียนรู้อย่างลึกซึ้ง

ดูรายการองค์กรและผู้ใช้ที่สมบูรณ์

คุณสมบัติเบ็ดเตล็ด

ความคิดเห็น @pep8speaks suggest diff ในความคิดเห็นของ PR และจะแสดงความคิดเห็นเกี่ยวกับส่วนสำคัญของ Diff แนะนำการแก้ไขสำหรับ PR ตัวอย่าง
ความคิดเห็น @pep8speaks pep8ify บน PR และจะสร้างคำขอดึงด้วยการเปลี่ยนแปลงที่แนะนำโดย autopep8 กับสาขาของผู้เขียน PR autopep8 แก้ไขข้อผิดพลาดส่วนใหญ่ที่รายงานโดย pycodestyle
เพิ่ม [skip pep8] ทุกที่ในข้อความการกระทำชื่อเรื่อง PR หรือคำอธิบาย PR เพื่อห้าม PEP8Speaks จากการแสดงความคิดเห็นเกี่ยวกับคำขอดึง

repos ส่วนตัว

แอพนี้จะใช้ได้เฉพาะกับที่เก็บข้อมูลสาธารณะ ดังนั้นหากคุณต้องการปรับใช้ส้อมหรือ ใช้แอพสำหรับที่เก็บส่วนตัว นี่คือคำแนะนำ

วิธีแก้ไขปัญหา PEP 8?

ตรวจสอบข้อผิดพลาดในเครื่องด้วยเครื่องมือบรรทัดคำสั่ง pycodestyle (ก่อนหน้านี้รู้จักกันในชื่อ pep8 )
AutoPep8 เป็นเครื่องมือบรรทัดคำสั่งอื่นเพื่อแก้ไขปัญหา
นอกจากนี้ดูสีดำ

ประกาศการเปิดตัว

การอัปเดตไปยังแอพจะประกาศโดยใช้คุณสมบัติการเปิดตัว GitHub ที่นี่ การเปลี่ยนแปลงครั้งสำคัญมากมายเกิดขึ้นเมื่อชุมชนเติบโตขึ้นมากขึ้น คลิกที่ Watch -> Releases only ที่ด้านบนของหน้าเพื่อรับการแจ้งเตือนเกี่ยวกับการกำหนดค่าใหม่หรือการอัปเดตคุณสมบัติ

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

ผู้สนับสนุน

เป็นสปอนเซอร์ทองคำและรับโลโก้และชื่อของคุณพร้อมลิงค์ไปยังเว็บไซต์ของคุณบน readme และเว็บไซต์ของเรา

การกำกับดูแล Samagra

Samagrax

ผู้สนับสนุนก่อนหน้านี้

ผู้สนับสนุนทองคำ

เป็นสปอนเซอร์ทองคำและรับโลโก้และชื่อของคุณพร้อมลิงค์ไปยังเว็บไซต์ของคุณบน readme และเว็บไซต์ของเรา

มูลนิธิซอฟต์แวร์ Python

เรา

ผู้สนับสนุนเงิน

เป็นสปอนเซอร์สีเงินและรับโลโก้และชื่อของคุณพร้อมลิงค์ไปยังเว็บไซต์ของคุณบน readme และเว็บไซต์ของเรา

ccextractor

Sudhanshu Mishra

การบริจาค

คุณสามารถสนับสนุนโครงการได้โดยมีส่วนร่วมในการพัฒนา หากคุณมีข้อเสนอแนะใด ๆ สำหรับคุณสมบัติหรือการปรับปรุงใหม่โปรดสร้างปัญหา ยินดีต้อนรับคำขอมากที่สุด! อ่านเอกสารที่มีส่วนร่วมเพื่อทำความเข้าใจว่าโครงการทำงานอย่างไรและคุณสามารถเปลี่ยนแปลงได้อย่างไร

โครงการต้องโฮสต์บนเซิร์ฟเวอร์และเนื่องจากสิ่งนั้นต้องการการสนับสนุนทางการเงินเช่นกัน

โปรดอ่านเคสสำหรับการระดมทุน PEP 8 พูด

หากคุณใช้โครงการนี้และคุณชอบโปรดแจ้งให้เราทราบ ขอบคุณ!

_{^{_{โครงการนี้ไม่ได้รับรองกฎทั้งหมดของ PEP 8 ดั้งเดิมและเชื่อในการปรับแต่ง pycodestyle}}}

_{^_-}