dlint

dlint

DLINT เป็นเครื่องมือในการส่งเสริมแนวทางปฏิบัติการเข้ารหัสที่ดีที่สุดและช่วยให้แน่ใจว่ารหัส Python ปลอดภัย

สิ่งที่สำคัญที่สุดที่ฉันได้ทำในฐานะโปรแกรมเมอร์ในช่วงไม่กี่ปีที่ผ่านมาคือการวิเคราะห์รหัสแบบคงที่อย่างจริงจัง มีค่ายิ่งกว่าข้อบกพร่องร้ายแรงหลายร้อยข้อที่ฉันป้องกันได้คือการเปลี่ยนแปลงในความคิดเกี่ยวกับวิธีที่ฉันดูความน่าเชื่อถือของซอฟต์แวร์และคุณภาพของรหัส

• John Carmack, 2011

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

• บทเรียนจากการสร้างเครื่องมือวิเคราะห์แบบคงที่ที่ Google

สำหรับเอกสารและรายการกฎโปรดดูเอกสาร

การติดตั้ง

$ python -m pip install dlint

และตรวจสอบอีกครั้งว่ามีการติดตั้งอย่างถูกต้อง:

$ python -m flake8 -h
Usage: flake8 [options] file file ...

...

Installed plugins: dlint: 0.16.0, mccabe: 0.5.3, pycodestyle: 2.2.0, pyflakes: 1.3.0

หมายเหตุ dlint: 0.16.0

โดยใช้

Dlint สร้างบน flake8 เพื่อดำเนินการผ้าสำลี สิ่งนี้ให้คุณสมบัติที่มีประโยชน์มากมายโดยไม่ต้องคิดค้นล้ออีกครั้ง

CLI

มาตรวจสอบง่ายๆ:

$ cat << EOF > test.py
print("TEST1")
exec('print("TEST2")')
EOF 

$ python test.py
TEST1
TEST2

$ python -m flake8 --select=DUO test.py
test.py:2:1: DUO105 use of " exec " is insecure

• ทำไมถึงไม่ปลอดภัย? หากต้องการเรียนรู้เพิ่มเติม /docs/linters/DUO105.md
• ทำไมต้อง DUO ? Dlint ได้รับการพัฒนาโดยทีม Duo Labs

--select=DUO Flag บอก flake8 ให้เรียกใช้กฎ Dlint Lint เท่านั้น

จากที่นี่เราสามารถเรียกใช้ dlint กับไดเรกทอรีของรหัส Python ได้อย่างง่ายดาย:

$ python -m flake8 --select=DUO /path/to/code

หากต้องการปรับแต่งผ้าสำลีของคุณให้ลองใช้ความช่วยเหลือจาก flake8 :

$ python -m flake8 --help

ตัวแก้ไขแบบอินไลน์

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

• VIM: https://github.com/vim-syntastic/syntastic
• emacs: https://github.com/flycheck/flycheck
• ประเสริฐ: https://github.com/sublimelinter/sublimelinter-flake8
• Pycharm: https://foxmask.net/post/2016/02/17/pycharm-running-flake8/
• Atom: https://atom.io/packages/linter-flake8
• Visual Studio Code: https://code.visualstudio.com/docs/python/linting#_flake8

การรวมเข้าด้วยกัน

Dlint สามารถรวมเข้ากับท่อ CI ได้อย่างง่ายดายหรืออะไรก็ตาม

สำหรับข้อมูลเพิ่มเติมและตัวอย่างโปรดดูว่า 'ฉันจะรวม dlint เข้ากับ XYZ ได้อย่างไร'

ปลั๊กอินที่กำหนดเอง

ปลั๊กอินที่กำหนดเองของ Dlint ถูกสร้างขึ้นในการตั้งชื่ออย่างง่ายและพึ่งพาโมดูล Python ในการสร้างปลั๊กอิน DLINT ที่กำหนดเองให้ใช้อนุสัญญาต่อไปนี้:

• ชื่อโมดูล Python ต้อง เริ่มต้นด้วย dlint_plugin_
• ชื่อคลาส Linter ต้อง เริ่มต้นด้วย Dlint
• คลาส Linter ควร สืบทอดจาก dlint.linters.base.BaseLinter
  • หากด้วยเหตุผลบางอย่างที่คุณต้องการหลีกเลี่ยงสิ่งนี้คุณ ต้อง ใช้ฟังก์ชั่น get_results อย่างเหมาะสมและสืบทอดจาก ast.NodeVisitor

ดูปลั๊กอินตัวอย่างสำหรับรายละเอียดเพิ่มเติม

การพัฒนา

ขั้นแรกให้ติดตั้งแพ็คเกจการพัฒนา:

$ python -m pip install -r requirements.txt
$ python -m pip install -r requirements-dev.txt
$ python -m pip install -e . 

การทดสอบ

$ pytest

การเป็นผ้าสำลี

$ flake8

ความครอบคลุม

$ pytest --cov

การเปรียบเทียบ

$ pytest -k test_benchmark_run --benchmark-py-file /path/to/file.py tests/test_benchmark/

หรือรับผลการวัดผล

$ pytest -k test_benchmark_individual --benchmark-py-file /path/to/file.py tests/test_benchmark/

หรือเรียกใช้กับ linter เดียว:

$ pytest -k test_benchmark_individual[DUO138-BadReCatastrophicUseLinter] --benchmark-py-file /path/to/file.py tests/test_benchmark/