dlint

dlint

DLINT هي أداة لتشجيع أفضل ممارسات الترميز والمساعدة في ضمان أن كود بيثون آمن.

أهم شيء قمت به كمبرمج في السنوات الأخيرة هو متابعة تحليل الكود الثابت بقوة. أكثر قيمة من المئات من الأخطاء الخطيرة التي منعت معها هو التغيير في العقلية حول طريقة عرض موثوقية البرنامج وجودة الرمز.

• جون كارماك ، 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 لأداء linting. يوفر هذا العديد من الميزات المفيدة دون إعادة اختراع العجلة.

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 duo105.md.
• لماذا DUO ؟ تم تطوير Dlint في الأصل من قبل فريق Duo Labs.

--select=DUO FLAG flake8 لتشغيل قواعد LINT DLINT فقط.

من هنا ، يمكننا بسهولة تشغيل 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
• Sublime: 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

linting

$ 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/