آموزش (Tutorial)

این آموزش تماماً دربارهٔ مواجهه با استانداردهای کدنویسی، با دانش اندک یا بدون داشتن شناختی عمیق از برنامه‌نویسی یا خود استانداردهای کد است. این کار معادل نادیده گرفتن دفترچهٔ راهنما و پریدن مستقیم به میان کار است.

اعلان خط فرمان برای این مثال‌ها بدین صورت است:

tutor Desktop$

شروع به کار (Getting Started)

اجرای Pylint با آرگومان‌های --help دیدی کلی از آرگومان‌های موجود به شما می‌دهد. این کار را اکنون انجام دهید، مانند:

pylint --help

برخی از گزینه‌هایی که در اینجا بر آن‌ها تمرکز خواهیم کرد عبارتند از:

Commands:
  --help-msg=<msg-id>
  --generate-toml-config
Messages control:
  --disable=<msg-ids>
Reports:
  --reports=<y or n>
  --output-format=<format>

اگر به جزئیات بیشتری نیاز دارید، می‌توانید پیام راهنمای حتی طولانی‌تری را درخواست کنید:

pylint --long-help

به بخش پایانی خروجی این راهنمای طولانی‌تر دقت کنید. این بخش به شما نشان می‌دهد که Pylint قرار است به چه مواردی ایراد بگیرد:

Output:
   Using the default text output, the message format is :
  MESSAGE_TYPE: LINE_NUM:[OBJECT:] MESSAGE
  There are 5 kind of message types :
  * (C) convention, for programming standard violation
  * (R) refactor, for bad code smell
  * (W) warning, for python specific problems
  * (E) error, for probable bugs in the code
  * (F) fatal, if an error occurred which prevented pylint from doing
  further processing.

هنگامی که Pylint برای نخستین بار روی یک قطعه کد تازه اجرا می‌شود، یک شکایت رایج این است که بیش از حد پرسروصدا (noisy) است. پیکربندی پیش‌فرض هشدارهای زیادی را اعمال می‌کند. ما از برخی گزینه‌هایی که در بالا اشاره کردیم استفاده خواهیم کرد تا آن را کمی بیشتر با ترجیحات شما سازگار کنیم..SS "نخستین اجرای Pylint (Your First Pylint'ing)"

ما از یک اسکریپت پایه پایتون که ابزار black https://github.com/psf/black از قبل روی آن اعمال شده است، به‌عنوان محتوای نمونه برای آموزش خود استفاده خواهیم کرد. کد آغازی که به کار خواهیم برد simplecaesar.py نام دارد و در اینجا به‌صورت کامل آورده شده است:

#!/usr/bin/env python3
import string
shift = 3
choice = input("would you like to encode or decode?")
word = input("Please enter text")
letters = string.ascii_letters + string.punctuation + string.digits
encoded = ""
if choice == "encode":
    for letter in word:
        if letter == " ":
            encoded = encoded + " "
        else:
            x = letters.index(letter) + shift
            encoded = encoded + letters[x]
if choice == "decode":
    for letter in word:
        if letter == " ":
            encoded = encoded + " "
        else:
            x = letters.index(letter) - shift
            encoded = encoded + letters[x]
print(encoded)

بیایید شروع کنیم. اگر این دستور را اجرا کنیم:

tutor Desktop$ pylint simplecaesar.py
************* Module simplecaesar
simplecaesar.py:1:0: C0114: Missing module docstring (missing-module-docstring)
simplecaesar.py:5:0: C0103: Constant name "shift" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:8:0: C0103: Constant name "letters" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:9:0: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:13:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:15:12: C0103: Constant name "x" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:16:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:20:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:22:12: C0103: Constant name "x" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:23:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
-----------------------------------
Your code has been rated at 4.74/10

می‌توانیم ببینیم که خط دوم چنین است:

"simplecaesar.py:1:0: C0114: Missing module docstring (missing-module-docstring)"

این موضوع اساساً بدین معناست که سطر ۱ در ستون ۰ از قرارداد C0114 عدول کرده است. بخش دیگری از اطلاعات، نماد پیام در میان پرانتزها، یعنی missing-module-docstring است.

اگر بخواهیم کمی بیشتر در این باره مطالعه کنیم، می‌توانیم به خط فرمان بازگردیم و این دستور را امتحان کنیم:

tutor Desktop$ pylint --help-msg=missing-module-docstring
:missing-module-docstring (C0114): *Missing module docstring*
  Used when a module has no docstring.Empty modules do not require a docstring.
  This message belongs to the basic checker.

این مورد کاملاً ساده و بدیهی بود، اما ممکن است با پیام‌های خطایی نیز روبرو شویم که با مفاهیم نظری کدِ مربوط به آن‌ها آشنایی نداشته باشیم..SS گام بعدی

حال که برخی از موارد پیکربندی را پشت سر گذاشتیم، بیایید ببینیم با هشدارهای باقی‌مانده چه کار می‌توانیم بکنیم. اگر یک docstring برای توصیف کاری که کد قرار است انجام دهد اضافه کنیم، کمک خواهد کرد. پیام‌های invalid-name وجود دارند که بعداً به آن‌ها خواهیم پرداخت. در اینجا کد به‌روزشده آمده است:

#!/usr/bin/env python3
"""This script prompts a user to enter a message to encode or decode
using a classic Caesar shift substitution (3 letter shift)"""
import string
shift = 3
choice = input("would you like to encode or decode?")
word = input("Please enter text")
letters = string.ascii_letters + string.punctuation + string.digits
encoded = ""
if choice == "encode":
    for letter in word:
        if letter == " ":
            encoded = encoded + " "
        else:
            x = letters.index(letter) + shift
            encoded = encoded + letters[x]
if choice == "decode":
    for letter in word:
        if letter == " ":
            encoded = encoded + " "
        else:
            x = letters.index(letter) - shift
            encoded = encoded + letters[x]
print(encoded)

در ادامه آنچه هنگام اجرای آن رخ می‌دهد آمده است:

tutor Desktop$ pylint simplecaesar.py
************* Module simplecaesar
simplecaesar.py:8:0: C0103: Constant name "shift" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:11:0: C0103: Constant name "letters" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:12:0: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:16:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:18:12: C0103: Constant name "x" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:19:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:23:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:25:12: C0103: Constant name "x" doesn't conform to UPPER_CASE naming style (invalid-name)
simplecaesar.py:26:12: C0103: Constant name "encoded" doesn't conform to UPPER_CASE naming style (invalid-name)
------------------------------------------------------------------
Your code has been rated at 5.26/10 (previous run: 4.74/10, +0.53)

عالی است! Pylint به ما نشان داد که امتیاز کدمان از آخرین اجرا چقدر بهبود یافته است، و اکنون تنها پیام‌های invalid-name باقی مانده‌اند.

قراردادهای نسبتاً مشخصی پیرامون نام‌گذاری مواردی چون متغیرهای نمونه، توابع، کلاس‌ها و غیره وجود دارد. این قراردادها بر استفاده از حروف بزرگ (UPPERCASE) و کوچک (lowercase) و همچنین نویسه‌های جداکننده چند کلمه در نام تمرکز دارند. این مسئله برای بررسی از طریق عبارت باقاعده (regular expression) بسیار مناسب است، از این رو عبارت should match (([A-Z_][A-Z1-9_]*)|(__.*__))$ مطرح می‌شود.

در این حالت Pylint به ما می‌گوید که این متغیرها ثابت (constant) به نظر می‌رسند و باید تماماً با حروف بزرگ باشند. این یک قرارداد داخلی است که از بدو پیدایش Pylint همراه آن بوده است. شما نیز می‌توانید قراردادهای نام‌گذاری داخلی خود را ایجاد کنید اما برای اهداف این راهنما، می‌خواهیم به استاندارد PEP 8 https://peps.python.org/pep-0008 پایبند باشیم. در این مورد، متغیرهایی که تعریف کردیم باید از قرارداد حروف تماماً کوچک پیروی کنند. قاعده مناسب چیزی شبیه به این خواهد بود: "should match [a-z_][a-z0-9_]{2,30}$". به حروف کوچک در عبارت باقاعده (a-z در مقابل A-Z) توجه کنید.

اگر این قاعده را با استفاده از گزینه --const-rgx='[a-z\_][a-z0-9\_]{2,30}$' اجرا کنیم، اکنون خروجی بسیار ساکت‌تر خواهد بود:

tutor Desktop$ pylint simplecaesar.py --const-rgx='[a-z\_][a-z0-9\_]{2,30}$'
************* Module simplecaesar
simplecaesar.py:18:12: C0103: Constant name "x" doesn't conform to '[a-z\\_][a-z0-9\\_]{2,30}$' pattern (invalid-name)
simplecaesar.py:25:12: C0103: Constant name "x" doesn't conform to '[a-z\\_][a-z0-9\\_]{2,30}$' pattern (invalid-name)
------------------------------------------------------------------
Your code has been rated at 8.95/10 (previous run: 5.26/10, +3.68)

می‌توانید درباره عبارات باقاعده در https://docs.python.org/library/re.html مطالعه کنید یا از وب‌سایتی مانند https://regex101.com برای کمک گرفتن استفاده نمایید.

نکته:

نصب از خط فرمان (Command line installation)

Pylint با استفاده از یک مدیر بسته قابل نصب است. مدیر بستهٔ شما نسخه‌ای سازگار با مفسر شما را پیدا خواهد کرد. ما pip را توصیه می‌کنیم:

pip install pylint

یا اگر می‌خواهید املا را نیز با enchant بررسی کنید (ممکن است به نصب کتابخانهٔ C مربوط به enchant نیاز داشته باشید https://pyenchant.github.io/pyenchant/install.html#installing-the-enchant-c-library):

pip install pylint[spelling]

جدیدترین نسخهٔ pylint از تمام مفسرهای Python که پایان عمرشان فرانرسیده است پشتیبانی می‌کند.

ما استفاده از آخرین مفسر را توصیه می‌کنیم زیرا به ماژول توکار ast متکی هستیم که با هر مفسر جدید Python بهبود می‌یابد. به عنوان مثال، یک مفسر Python 3.6 نمی‌تواند نحو 3.8 را تحلیل کند (به ویژه به دلیل عملگر جدید walrus)، در حالی که یک مفسر 3.8 می‌تواند با Python 3.6 نیز کار کند. برای جزئیات بیشتر به بخش استفاده از pylint با چندین مفسر <#continuous-integration> مراجعه کنید.

نکته:

conda install pylint

sudo apt-get install pylint

یکپارچه‌سازی با ویرایشگر و IDE (Editor and IDE integration)

Pylint را می‌توان در ویرایشگرها و IDEهای گوناگون ادغام کرد. در زیر می‌توانید راهنماهایی را برای برخی از متداول‌ترین آن‌ها پیدا کنید.

یکپارچه‌سازی Pylint با TextMate

Pylint را به روش معمول نصب کنید:

pip install pylint

بستهٔ Python را برای TextMate نصب کنید https://github.com/textmate/python.tmbundle:

اکنون باید آن را در Bundles > Python مشاهده کنید.

در Preferences، برگهٔ Variables را انتخاب کنید. اگر متغیر TM_PYCHECKER از پیش در فهرست نیست، آن را با مقدار pylint اضافه کنید.

میان‌بر پیش‌فرض صفحه‌کلید برای اجرای بررسی‌کننده نحو (syntax checker) کلیدهای Control-Shift-V است - یک فایل .py را در Textmate باز کرده و آن را آزمایش کنید.

باید خروجی را در یک پنجرهٔ جدید ببینید:

آنگاه همه چیز روبه‌راه است و به احتمال زیاد Pylint نکاتی را دربارهٔ کد پایتون شما گوشزد کرده است (یا اگر کد شما از قبل با انتظارات آن مطابقت داشته باشد، با وضعیت 0 خارج خواهد شد).

اگر پیامی به این صورت دریافت کردید:

این پیام یعنی Pylint پیدا نشد، که احتمالاً ناشی از مشکلی در مسیرهای دستور است - TextMate باید در مسیرهای درستی به دنبال Pylint بگردد.

با استفاده از دستور which بررسی کنید که Pylint در کجا نصب شده است:

$ which pylint
/usr/local/bin/pylint

خروجی به شما خواهد گفت که Pylint کجا قرار دارد؛ در این مورد، در /usr/local/bin.

... و دوباره اجرای Pylint را امتحان کنید..SS یکپارچه‌سازی با Pre-commit (Pre-commit integration)

از pylint می‌توان به عنوان یک هوک pre-commit https://pre-commit.com استفاده کرد. با این حال ما استفاده از آن را توصیه نمی‌کنیم، چرا که pylint -- با توجه به سرعتش -- برای یک کار یکپارچه‌سازی پیوسته (CI) یا هوک pre-push در git مناسب‌تر است، به‌ویژه اگر مخزن شما بزرگ باشد.

از آنجا که pylint برای عملکرد صحیح نیاز به وارد کردن (import) ماژول‌ها و وابستگی‌ها دارد، این هوک تنها با نصب محلی pylint (در محیط شما) کار می‌کند. این بدان معناست که نمی‌توان از آن به همراه pre-commit.ci استفاده کرد و لازم است موارد زیر را به .pre-commit-config.yaml خود اضافه کنید:

.. sourcecode:: yaml

محدودیت دیگر این است که pylint برای استنتاج بهینهٔ مقادیر واقعی ناشی از فراخوانی‌ها، باید تمام کد شما را به یک‌باره تحلیل کند. اگر تنها بخشی از فایل‌ها به آن داده شوند، ممکن است pylint نوع یک مقدار خاص را تشخیص ندهد و برای آن زیرمجموعه استنتاج ضعیف‌تری ارائه کند. از آنجا که pre-commit فایل‌های ورودی را به منظور موازی‌سازی پردازش تکه‌بندی (slice) می‌کند، ممکن است نتیجه دچار افت کیفیت شود. همچنین در صورت تغییر مجموعهٔ فایل‌ها، نتیجه ممکن است به شکلی غیرمنتظره متفاوت باشد چرا که برش‌بندی جدید می‌تواند استنتاج را تغییر دهد. بنابراین در صورتی که درستی و قطعیت (تکرارپذیری) برای شما اهمیت بیشتری نسبت به موازی‌سازی دارد، گزینهٔ require_serial باید روی true تنظیم شود.

اگر pylint را به صورت محلی نصب کرده‌اید، می‌توانید آن را به شکل زیر به .pre-commit-config.yaml بیفزایید:

- repo: local
  hooks:
    - id: pylint
      name: pylint
      entry: pylint
      language: system
      types: [python]
      require_serial: true
      args:
        [
          "-rn", # Only display messages
          "-sn", # Don't display the score
        ]

می‌توانید همان‌طور که در آموزش <#tutorial> شرح داده شده است، از args برای ارسال آرگومان‌های خط فرمان استفاده کنید. یک هوک با آرگومان‌های بیشتر می‌تواند شبیه به این باشد:

- repo: local
  hooks:
    - id: pylint
      name: pylint
      entry: pylint
      language: system
      types: [python]
      args:
        [
          "-rn", # Only display messages
          "-sn", # Don't display the score
          "--rcfile=pylintrc", # Link to your config file
          "--load-plugins=pylint.extensions.docparams", # Load an extension
        ]

نمایش نشان استفاده

می‌توانید این نشان (badge) را در فایل README خود قرار دهید تا دیگران بدانند پروژهٔ شما از pylint استفاده می‌کند.

استفاده از نشان در فایل README.md پروژه (یا هر فایل Markdown دیگر):

[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)

استفاده از نشان در فایل README.rst پروژه (یا هر فایل rst دیگر):

.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen
    :target: https://github.com/pylint-dev/pylint

اگر از GitHub Actions استفاده می‌کنید و یکی از گردش‌های کاری CI شما با "name: pylint" آغاز می‌شود، می‌توانید از نشان‌های وضعیت گردش‌کار گیت‌هاب https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge#using-the-workflow-file-name برای نمایش وضعیت لحظه‌ای گذراندن موفق pylint در pushهای ارسالی به شاخهٔ پیش‌فرض خود استفاده کنید. برای اطلاعات دقیق‌تر، مستندات را بررسی کنید.

ارتقای pylint

احتمالاً بهتر است نسخهٔ pylint را در محیط توسعهٔ خود تثبیت کنید تا بتوانید زمان ارتقای هشدارهای pylint را مدیریت نمایید. pylint از نسخه‌بندی معنایی (semver) پیروی می‌کند؛ اما ما نمی‌توانیم تضمین کنیم که خروجی برنامه در بین نسخه‌های مختلف کاملاً یکسان باقی بماند. معنای این امر این است که:

اگر نسخهٔ فرعی (minor) را ثابت نگه داشته و به یک نسخهٔ وصله‌ای جدید ارتقا دهید، می‌توانید انتظار پیام‌های کمتری را داشته باشید. با این وجود، فعال بودن useless-suppression به این معناست که پس از برطرف شدن یک مثبت کاذب که قبلاً آن را غیرفعال کرده بودید، ممکن است یک هشدار جدید useless-suppression دریافت کنید. همچنین، اگر کتابخانهٔ مورد استفاده شما ارتقا یافته باشد و رفتار آن نسبت به قبل بهتر یا بدتر تشخیص داده شود، ممکن است پیام‌های جدیدی نیز دریافت کنید.

در این حالت می‌توانید انتظار تغییرات بسیار بیشتری در خروجی داشته باشید که عمدهٔ آن مربوط به بررسی‌های جدید است.

در این شرایط ممکن است لازم باشد دستوری را که اجرا می‌کنید یا افزونه و یکپارچه‌سازی ویرایشگر مورد استفادهٔ خود را تغییر دهید.

نحوه استفاده

اجرای Pylint

روی بسته‌های ماژول یا دایرکتوری‌ها

ابزار Pylint برای فراخوانی از خط فرمان طراحی شده است. نحوهٔ استفاده بدین صورت است:

pylint [options] modules_or_packages

به‌طور پیش‌فرض دستور pylint تنها فهرستی از ماژول‌ها و بسته‌های پایتون را می‌پذیرد. در نسخه‌های قبل از 2.15، تعیین دایرکتوری‌ای که یک بستهٔ صریح نباشد (حاوی __init__.py نباشد) به خطا منجر می‌شود:

pylint mydir
************* Module mydir
mydir/__init__.py:1:0: F0010: error while code parsing: Unable to load file mydir/__init__.py:
[Errno 2] No such file or directory: 'mydir/__init__.py' (parse-error)

بنابراین، در نسخه‌های قبل از 2.15 استفاده از گزینهٔ --recursive=y امکان تحلیل ایستای بسته‌های فضای نام (namespace package) را فراهم می‌کند:

pylint --recursive=y mydir mymodule mypackage

این گزینه باعث می‌شود pylint تلاش کند تمام ماژول‌ها (فایل‌های منتهی به پسوند .py) و تمام بسته‌های صریح (تمامی دایرکتوری‌های حاوی فایل __init__.py) را شناسایی کند.

ابزار Pylint این بسته یا ماژول را وارد (import) نخواهد کرد، اما برای تعیین مکان آن‌ها از ساختار درونی پایتون استفاده می‌کند و به همین دلیل مشمول همان قوانین و پیکربندی‌ها خواهد بود. شما باید به متغیر محیطی PYTHONPATH خود توجه داشته باشید، زیرا تحلیل نسخهٔ نصب‌شدهٔ یک ماژول به جای نسخهٔ در حال توسعهٔ آن یک خطای رایج است..SS روی فایل‌ها (On files)

همچنین تحلیل فایل‌های Python، با چند محدودیت، امکان‌پذیر است. برای سهولت کار، در صورتی که بتوان با استفاده از python path نام ماژول را از روی مسیر فایل تشخیص داد، می‌توانید نام فایل را به آن بدهید. چند مثال:

دستور pylint mymodule.py باید همیشه کار کند، چرا که دایرکتوری کاری فعلی به‌طور خودکار به ابتدای python path اضافه می‌شود

دستور pylint directory/mymodule.py کار خواهد کرد اگر: directory یک بستهٔ Python باشد (یعنی شامل یک فایل __init__.py باشد)، یک بستهٔ فضای‌نام ضمنی (implicit namespace package) باشد، یا اگر directory در python path قرار داشته باشد.

با بسته‌های فضای‌نام ضمنی (With implicit namespace packages)

اگر سورس‌های تحلیل‌شده از بسته‌های فضای‌نام ضمنی (PEP 420) استفاده می‌کنند، ریشه(های) سورس باید با استفاده از گزینهٔ --source-roots مشخص شوند. در غیر این صورت، نام بسته‌ها به اشتباه تشخیص داده می‌شود، زیرا بسته‌های فضای‌نام ضمنی فاقد فایل __init__.py هستند.

پشتیبانی از تطبیق الگو (Globbing support)

همچنین امکان مشخص کردن دایرکتوری‌ها و فایل‌ها با استفاده از الگوهای تطبیق (globbing patterns) وجود دارد:

pylint [options] packages/*/src

گزینه‌های خط فرمان (Command line options)

پیش از هر چیز، دو گزینهٔ پایه (اما کاربردی) وجود دارد.

ابزار Pylint بر پایهٔ چندین بررسی‌کننده (checker) معماری شده است. شما می‌توانید یک بررسی‌کنندهٔ خاص یا برخی از پیام‌ها یا دسته‌های پیام آن را با مشخص کردن --disable=<symbol> غیرفعال کنید. اگر می‌خواهید تنها برخی از بررسی‌کننده‌ها یا برخی از نمادهای پیام را فعال کنید، ابتدا از --disable=all و سپس از --enable=<symbol> استفاده کنید که در آن <symbol> فهرستی از نام‌های بررسی‌کننده و نمادهای پیام جداشده با کاما است. برای شرح بررسی‌کننده‌های ارائه‌شده همراه با قابلیت‌هایشان، فهرست ویژگی‌های موجود را ببینید. گزینه‌های --disable و --enable را می‌توان با فهرست‌های جداشده با کاما شامل ترکیبی از بررسی‌کننده‌ها، شناسه‌های پیام و دسته‌ها مانند -d C,W,no-error,design به کار برد

غیرفعال کردن همهٔ پیام‌ها با --disable=all امکان‌پذیر است. این کار برای فعال کردن تنها چند بررسی‌کننده یا چند پیام، با ابتدا غیرفعال کردن همه‌چیز و سپس فعال‌سازی دوبارهٔ تنها مواردی که نیاز دارید، کاربردی است.

هر بررسی‌کننده گزینه‌های خاصی دارد که می‌توانند یک مقدار yes/no، یک عدد صحیح، یک عبارت باقاعدهٔ Python، یا فهرستی از مقادیر جداشده با کاما (که عموماً برای بازنویسی یک عبارت باقاعده در شرایط خاص استفاده می‌شوند) دریافت کنند. برای فهرست کامل گزینه‌ها، از --help استفاده کنید

مشخص کردن تمام گزینه‌های مناسب برای پیکربندی و استانداردهای کدنویسی شما می‌تواند خسته‌کننده باشد؛ بنابراین می‌توان از یک فایل پیکربندی برای تعیین مقادیر پیش‌فرض استفاده کرد. می‌توانید یک فایل پیکربندی را در خط فرمان با استفاده از گزینهٔ --rcfile مشخص کنید. در غیر این صورت، Pylint به ترتیب زیر به دنبال فایل پیکربندی می‌گردد و از اولین موردی که بیابد استفاده می‌کند:

گزینهٔ --generate-toml-config یک فایل پیکربندی همراه با توضیحات را بر اساس پیکربندی فعلی در خروجی استاندارد تولید کرده و خارج می‌شود. این شامل موارد زیر است:

البته شما همچنین می‌توانید با مقادیر پیش‌فرض شروع کرده و پیکربندی را به‌صورت دستی تنظیم کنید.

سایر گزینه‌های سراسری کاربردی عبارتند از:

pylint -j 4 mymodule1.py mymodule2.py mymodule3.py mymodule4.py

کدهای خروج (Exit codes)

برنامهٔ Pylint کدهای خروج کدگذاری‌شده با بیت (bit-encoded) را برمی‌گرداند.

برای مثال، کد خروج 20 به این معنی است که حداقل یک پیام هشدار (4) و حداقل یک پیام شیوه‌نامه (16) وجود داشته و هیچ خطای دیگری رخ نداده است..SS خروجی Pylint

گزینه‌های خروجی

خروجی به صورت پیش‌فرض در stdout نوشته می‌شود. ساده‌ترین راه برای فرستادن خروجی به یک فایل، استفاده از گزینهٔ --output=<filename> است.

قالب پیش‌فرض برای خروجی، متن خام است. می‌توانید با دادن گزینهٔ --output-format=<value> به pylint این را تغییر دهید. مقادیر ممکن عبارتند از:

با ارسال فهرستی از قالب‌ها که با کاما از هم جدا شده‌اند به --output-format، می‌توان چندین قالب خروجی را به طور همزمان استفاده کرد. این خروجی را می‌توان با مشخص کردن نام فایل پس از دونقطه (:) به یک فایل هدایت کرد.

برای نمونه، جهت ذخیرهٔ گزارش json در somefile.json و همزمان چاپ گزارشی رنگی در stdout:

--output-format=json:somefile.json,colorized

قالب‌های سفارشی پیام

می‌توانید شیوهٔ دقیق نمایش اطلاعات را با استفاده از گزینهٔ --msg-template=<format string>; سفارشی‌سازی کنید. format string از نحو جدید قالب‌بندی پایتون https://docs.python.org/2/library/string.html#formatstrings بهره می‌برد و فیلدهای زیر در دسترس هستند:

برای نمونه، قالب پیش‌فرض پیشین (قبل از 1.0) را می‌توان با این دستور به دست آورد:

pylint --msg-template='{msg_id}:{line:3d},{column}: {obj}: {msg}'

چند نمونهٔ دیگر:

{path}:{line}:{column}: {msg_id}: {msg} ({symbol})

{path}({line}): [{msg_id}{obj}] {msg}

{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}

گزینهٔ --msg-template تنها با گزارشگرهای متنی قابل ترکیب است (--output-format یا تعیین نشده باشد یا یکی از مقادیر parseable، colorized یا msvs باشد). اگر هر دو گزینهٔ --output-format و --msg-template تعیین شوند، گزینهٔ --msg-template بر قالب خطی پیش‌فرضی که توسط کلاس گزارشگر تعریف شده است، اولویت خواهد داشت.

اگر مقادیر end_line یا end_column برابر با None باشند، توسط TextReporter پیش‌فرض به صورت یک رشتهٔ خالی نمایش داده می‌شوند..SS بخش تحلیل کد منبع (Source code analysis section)

برای هر ماژول python، ابزار Pylint ابتدا چند نویسهٔ '*' و به‌دنبال آن نام ماژول را نمایش می‌دهد. سپس، تعدادی پیام با قالب زیر نمایش داده می‌شود:

MESSAGE_TYPE: LINE_NUM:[OBJECT:] MESSAGE

می‌توانید با استفاده از گزینهٔ --output-format=parseable قالب خروجی دیگری دریافت کنید که بسیار کاربردی است، چرا که توسط اکثر ویرایشگرها و سایر ابزارهای توسعه شناخته می‌شود.

نوع پیام می‌تواند یکی از موارد زیر باشد:

گاهی خطی از کد که باعث خطا شده است همراه با یک علامت درج (caret: ^) که به خطا اشاره می‌کند نمایش داده می‌شود. این ویژگی ممکن است در نسخه‌های آیندهٔ Pylint تعمیم یابد.

مثال (برگرفته از اجرای Pylint روی خودش...):

************* Module pylint.checkers.format
W: 50: Too long line (86/80)
W:108: Operator not followed by a space
     print >>sys.stderr, 'Unable to match %r', line
            ^
W:141: Too long line (81/80)
W: 74:searchall: Unreachable code
W:171:FormatChecker.process_tokens: Redefining built-in (type)
W:150:FormatChecker.process_tokens: Too many local variables (20/15)
W:150:FormatChecker.process_tokens: Too many branches (13/12)

بخش گزارش‌ها (Reports section)

به‌دنبال پیام‌های تحلیل، Pylint می‌تواند مجموعه‌ای از گزارش‌ها را نمایش دهد که هر کدام بر جنبهٔ خاصی از پروژه تمرکز دارند؛ مانند تعداد پیام‌ها بر پایهٔ دسته‌بندی، وابستگی‌های ماژول‌ها. این ویژگی‌ها را می‌توان از طریق گزینهٔ --reports=y یا نگارش کوتاه آن -ry فعال کرد.

به‌عنوان مثال، گزارش معیارها خلاصه‌های جمع‌آوری‌شده از اجرای فعلی را نمایش می‌دهد:

پیام‌ها (Messages)

نمای کلی پیام‌ها (Messages overview)

Pylint می‌تواند پیام‌های زیر را صادر کند:

مهلک (Fatal)

تمام پیام‌ها در دسته‌بندی مهلک (fatal):

astroid-error / F0002

پیام صادرشده:

%s: %s

توضیحات:

هنگامی استفاده می‌شود که خطایی غیرمنتظره حین ساخت نمایش Astroid رخ داده باشد. این حالت معمولاً با یک traceback همراه است. لطفاً چنین خطاهایی را گزارش دهید!

جزئیات تکمیلی:

این پیام مربوط به یک مشکل داخلی در pylint است. نیازی به تغییر در کد شما نیست، اما شاید نیاز به تغییر در پیکربندی یا نحوهٔ نصب pylint باشد.

ایجادشده توسط بررسی‌کنندهٔ اصلی https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/lint/pylinter.py.

config-parse-error / F0011

پیام صادرشده:

error while parsing the configuration: %s

توضیحات:

هنگامی استفاده می‌شود که حین تجزیهٔ یک فایل پیکربندی pylint، استثنایی رخ داده باشد.

جزئیات تکمیلی:

این پیام مربوط به مشکلی در پیکربندی شماست، نه کد شما.

ایجادشده توسط بررسی‌کنندهٔ اصلی https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/lint/pylinter.py.

fatal / F0001

پیام صادرشده:

%s

توضیحات:

هنگامی استفاده می‌شود که خطایی مانع از تحلیل یک ماژول شده باشد (برای نمونه، عدم توانایی در یافتن آن).

جزئیات تکمیلی:

این پیام مربوط به یک مشکل داخلی در pylint است. نیازی به هیچ تغییری در کد شما نیست.

ایجادشده توسط بررسی‌کنندهٔ اصلی https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/lint/pylinter.py.

method-check-failed / F0202

پیام صادرشده:

Unable to check methods signature (%s / %s)

توضیحات:

هنگامی استفاده می‌شود که Pylint به دلیلی غیرمنتظره نتوانسته است سازگاری امضای متدها را بررسی کند. لطفاً در صورتی که دلیلی برای آن نیافتید، این مورد را گزارش دهید.

جزئیات تکمیلی:

این پیام مربوط به یک مشکل داخلی در pylint است. نیازی به هیچ تغییری در کد شما نیست.

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

parse-error / F0010

پیام صادرشده:

error while code parsing: %s

توضیحات:

هنگامی استفاده می‌شود که حین ساخت نمایش Astroid استثنایی رخ داده باشد که توسط astroid قابل رسیدگی بود.

جزئیات تکمیلی:

این پیام مربوط به یک مشکل داخلی در pylint است. نیازی به هیچ تغییری در کد شما نیست.

ایجادشده توسط بررسی‌کنندهٔ اصلی https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/lint/pylinter.py.

تمام پیام‌های تغییرنام‌یافته در دسته‌بندی مهلک (fatal):.SS old-import-error / F0401

پیام 'old-import-error' تغییر نام داده است. پیام جدید را می‌توانید در این بخش بیابید:

import-error / E0401

پیام صادرشده:

Unable to import %s

توضیحات:

زمانی به کار می‌رود که pylint نتواند ماژولی را وارد (import) کند.

کد دارای مشکل:

from patlib import Path  # [import-error]

کد صحیح:

from pathlib import Path

جزئیات تکمیلی:

این وضعیت ممکن است زمانی رخ دهد که بسته‌ای را وارد کنید که در محیط شما نصب نشده است، یا اینکه دچار غلط املایی شده باشید.

راه‌حل این است که بسته را از طریق pip/setup.py/wheel نصب نمایید یا غلط تایپی را برطرف سازید.

ایجادشده توسط بررسی‌کننده imports https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/imports.py.

خطا (Error)

تمام پیام‌های موجود در دسته‌بندی خطا:

abstract-class-instantiated / E0110

پیام صادرشده:

Abstract class %r with abstract methods instantiated

توضیحات:

زمانی استفاده می‌شود که از یک کلاس انتزاعی با فراکلاس `abc.ABCMeta` که دارای متدهای انتزاعی است، نمونه‌سازی (instantiate) شده باشد.

کد دارای مشکل:

import abc
class Animal(abc.ABC):
    @abc.abstractmethod
    def make_sound(self):
        pass
sheep = Animal()  # [abstract-class-instantiated]

کد صحیح:

import abc
class Animal(abc.ABC):
    @abc.abstractmethod
    def make_sound(self):
        pass
class Sheep(Animal):
    def make_sound(self):
        print("bhaaaaa")
sheep = Sheep()

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py..SS access-member-before-definition / E0203

پیام صادرشده:

دسترسی به عضو %r پیش از سطر تعریف آن %s

توضیحات:

زمانی استفاده می‌شود که به یکی از اعضای نمونه پیش از مقداردهی واقعی آن دسترسی پیدا شود.

کد دارای مشکل:

class Unicorn:
    def __init__(self, fluffiness_level):
        if self.fluffiness_level > 9000:  # [access-member-before-definition]
            print("It's OVER-FLUFFYYYY ! *crush glasses*")
        self.fluffiness_level = fluffiness_level

کد صحیح:

class Unicorn:
    def __init__(self, fluffiness_level):
        self.fluffiness_level = fluffiness_level
        if self.fluffiness_level > 9000:
            print("It's OVER-FLUFFYYYY ! *crush glasses*")

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

assigning-non-slot / E0237

پیام صادرشده:

انتساب به ویژگی %r که در slots کلاس تعریف نشده است

توضیحات:

زمانی استفاده می‌شود که به ویژگی‌ای که در slots کلاس تعریف نشده است، مقداری منتسب شود.

کد دارای مشکل:

class Student:
    __slots__ = ("name",)
    def __init__(self, name, surname):
        self.name = name
        self.surname = surname  # [assigning-non-slot]
        self.setup()
    def setup(self):
        pass

کد صحیح:

class Student:
    __slots__ = ("name", "surname")
    def __init__(self, name, surname):
        self.name = name
        self.surname = surname
        self.setup()
    def setup(self):
        pass

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS assignment-from-no-return / E1111

پیام صادرشده:

انتساب نتیجه فراخوانی یک تابع، در حالی که تابع هیچ مقداری بازنمی‌گرداند

توضیحات:

زمانی استفاده می‌شود که نتیجه فراخوانی یک تابع منتسب شود، اما تابع استنتاج‌شده هیچ مقداری را بازنگرداند.

کد دارای اشکال:

def add(x, y):
    print(x + y)
value = add(10, 10)  # [assignment-from-no-return]

کد تصحیح‌شده:

def add(x, y):
    return x + y
value = add(10, 10)

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

assignment-from-none / E1128

پیام صادرشده:

انتساب نتیجه فراخوانی یک تابع، در حالی که تابع None بازمی‌گرداند

توضیحات:

زمانی استفاده می‌شود که نتیجه فراخوانی یک تابع منتسب شود، اما تابع استنتاج‌شده چیزی جز None بازنگرداند.

کد دارای اشکال:

def function():
    return None
f = function()  # [assignment-from-none]

کد تصحیح‌شده:

def function():
    return None
f = function() if function() else 1

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS async-context-manager-with-regular-with / E1145

پیام صادرشده:

مدیر زمینه '%s' ناهمگام است و باید با 'async with' استفاده شود.

توضیحات:

زمانی استفاده می‌شود که یک مدیر زمینه ناهمگام به جای 'async with' با یک دستور معمولی 'with' به کار رود.

کد دارای مشکل:

from contextlib import asynccontextmanager
@asynccontextmanager
async def async_context():
    yield
with async_context():  # [async-context-manager-with-regular-with]
    print("This will cause an error at runtime")

کد درست:

import asyncio
from contextlib import asynccontextmanager
@asynccontextmanager
async def async_context():
    yield
async def main():
    async with async_context():
        print("This works correctly")

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

await-outside-async / E1142

پیام صادرشده:

عبارت 'await' باید درون یک تابع async به کار رود

توضیحات:

زمانی صادر می‌شود که await خارج از یک تابع async استفاده شود.

کد دارای مشکل:

import asyncio
def main():
    await asyncio.sleep(1)  # [await-outside-async]

کد درست:

import asyncio
async def main():
    await asyncio.sleep(1)

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS bad-configuration-section / E0014

پیام صادرشده:

تنظیم نابجا در بخش پیکربندی سطح بالای '%s' یافت شد : '%s'

توضیحات:

زمانی استفاده می‌شود که تنظیمی در سطح بالای یک پیکربندی toml شناسایی شود که نباید در آنجا باشد.

جزئیات تکمیلی:

این خطا بین pylint 2.12 و pylint 2.14 (پیش از بازسازی ساختار argparse) زمانی رخ می‌داد که با یک نوع مقدار غیرمنتظره در یک پیکربندی toml مواجه می‌شدیم.

ایجادشده توسط بررسی‌کنندهٔ اصلی https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/lint/pylinter.py.

bad-except-order / E0701

پیام صادرشده:

ترتیب نادرست بندهای except (%s)

توضیحات:

زمانی استفاده می‌شود که بندهای except به ترتیب درست (از خاص‌ترین به عام‌ترین) نباشند. اگر ترتیب را اصلاح نکنید، ممکن است برخی از استثناها توسط خاص‌ترین گرداننده گرفته نشوند.

کد دارای مشکل:

try:
    print(int(input()))
except Exception:
    raise
except TypeError:  # [bad-except-order]
    # This block cannot be reached since TypeError exception
    # is caught by previous exception handler.
    raise

کد درست:

try:
    print(int(input()))
except TypeError:
    raise
except Exception:
    raise

ایجادشده توسط بررسی‌کنندهٔ exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py.

bad-exception-cause / E0705

پیام صادرشده:

علت استثنا روی چیزی تنظیم شده است که نه استثنا است و نه None

توضیحات:

زمانی استفاده می‌شود که از نحو "raise ... from ..." استفاده شود، در حالی که علت استثنا نه یک استثنا باشد و نه None.

کد دارای مشکل:

def divide(x, y):
    result = 0
    try:
        result = x / y
    except ZeroDivisionError:
        # +1: [bad-exception-cause]
        raise ValueError(f"Division by zero when dividing {x} by {y} !") from result
    return result

کد درست:

def divide(x, y):
    result = 0
    try:
        result = x / y
    except ZeroDivisionError as exc:
        raise ValueError(f"Division by zero when dividing {x} by {y} !") from exc
    return result

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py..SS bad-format-character / E1300

پیام صادرشده:

Unsupported format character %r (%#02x) at index %d

توضیحات:

هنگامی استفاده می‌شود که یک نویسهٔ قالب‌بندیِ پشتیبانی‌نشده در یک رشتهٔ قالب به کار رفته باشد.

کد دارای مشکل:

print("%s %z" % ("hello", "world"))  # [bad-format-character]

کد درست:

print("%s %s" % ("hello", "world"))

جزئیات بیشتر:

این بررسی در حال حاضر تنها برای قالب‌بندی رشته‌ها به «سبک قدیمی» (old-style) همان‌طور که در مثال‌ها دیده می‌شود، فعال است. برای اطلاعات بیشتر، گزارش شمارۀ #6085 در https://github.com/pylint-dev/pylint/issues/6085 را ببینید.

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py.

bad-plugin-value / E0013

پیام صادرشده:

Plugin '%s' is impossible to load, is it installed ? ('%s')

توضیحات:

هنگامی استفاده می‌شود که یک مقدار نامعتبر در 'load-plugins' به کار رفته باشد.

جزئیات بیشتر:

یکی از افزونه‌های pylint شما بارگیری نمی‌شود. نیازی به تغییر در کد شما نیست، اما پیکربندی pylint یا نصب آن با مشکل مواجه است.

برای نمونه، ممکن است یک غلط املایی وجود داشته باشد. پیکربندی زیر:

[MAIN]
load-plugins = pylint.extensions.bad_biultin

باید به این صورت باشد:

[MAIN]
load-plugins = pylint.extensions.bad_builtin

یا افزونه‌ای که اضافه کرده‌اید در محیط شما قابل وارد کردن (importable) نیست.

ایجادشده توسط بررسی‌کنندهٔ main https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/lint/pylinter.py..SS bad-reversed-sequence / E0111

پیام صادر شده:

The first reversed() argument is not a sequence

توضیحات:

زمانی استفاده می‌شود که نخستین آرگومان تابع توکار ()reversed یک دنباله نباشد (__reversed__ یا __getitem__ و __len__ را پیاده‌سازی نکرده باشد)

کد دارای اشکال:

reversed({1, 2, 3, 4})  # [bad-reversed-sequence]

کد صحیح:

reversed([1, 2, 3, 4])

ایجاد شده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py.

bad-str-strip-call / E1310

پیام صادر شده:

Suspicious argument in %s.%s call

توضیحات:

آرگومان فراخوانی str.{l,r,}strip حاوی یک نویسه تکراری است،

کد دارای اشکال:

hello_world.py:

"Hello World".strip("Hello")  # [bad-str-strip-call]
# >>> ' World'

remove_abc_from_both_side.py:

"abcbc def bacabc".strip("abcbc ")  # [bad-str-strip-call]
# >>> 'def'

کد صحیح:

hello_world.py:

"Hello World".strip("Helo")
# >>> ' World'

remove_abc_from_both_side.py:

"abcbc def bacabc".strip("abc ")
# >>> 'def'

جزئیات تکمیلی:

یک تصور نادرست رایج این است که str.strip('Hello') زیررشته‌ی 'Hello' را از ابتدا و انتهای رشته حذف می‌کند. این‌گونه نیست. برگرفته از مستندات https://docs.python.org/3/library/stdtypes.html?highlight=strip#str.strip:

> آرگومان chars یک پیشوند یا پسوند نیست؛ بلکه تمام ترکیب‌های مقادیر آن حذف می‌شوند

وجود نویسه‌های تکراری در فراخوانی str.strip، گذشته از اینکه هیچ تأثیری بر نتیجه نهایی ندارد، ممکن است نشان‌دهنده این برداشت نادرست باشد.

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py..SS bad-string-format-type / E1307

پیام صادرشده:

آرگومان %r با نوع قالب‌بندی %r مطابقت ندارد

توضیحات:

زمانی استفاده می‌شود که نوع مورد نیاز رشتهٔ قالب‌بندی با نوع آرگومان واقعی سازگار نباشد.

کد دارای مشکل:

print("%d" % "1")  # [bad-string-format-type]

کد صحیح:

print("%d" % 1)

جزئیات بیشتر:

این بررسی در حال حاضر تنها برای قالب‌بندی رشته‌ها به "سبک قدیمی" (old-style) همان‌طور که در مثال‌ها دیده می‌شود، فعال است. برای اطلاعات بیشتر، گزارش #6085 را در https://github.com/pylint-dev/pylint/issues/6163 ببینید.

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کنندهٔ string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py.

bad-super-call / E1003

پیام صادرشده:

آرگومان نخست نامعتبر %r به super() داده شده است

توضیحات:

زمانی استفاده می‌شود که آرگومانی غیر از کلاس جاری به عنوان نخستین آرگومان تابع توکار super داده شود.

کد دارای مشکل:

class Animal:
    pass
class Tree:
    pass
class Cat(Animal):
    def __init__(self):
        super(Tree, self).__init__()  # [bad-super-call]
        super(Animal, self).__init__()

کد صحیح:

class Animal:
    pass
class Tree:
    pass
class Cat(Animal):
    def __init__(self):
        super(Animal, self).__init__()

جزئیات بیشتر:

در Python 2.7، تابع super() باید با کلاس خودش و self به عنوان آرگومان فراخوانی می‌شد (super(Cat, self)) که این امر می‌توانست منجر به اشتباه گرفتن کلاس والد و فرزند در کد شود.

در Python 3 روش توصیه‌شده، فراخوانی super() بدون آرگومان است (همچنین ببینید: super-with-arguments).

یک استثنا، فراخوانی super() روی یک کلاس والد غیرمستقیم است. این کار می‌تواند برای به‌دست آوردن متدی غیر از متد پیش‌فرض بازگردانده‌شده توسط mro() استفاده شود.

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کنندهٔ newstyle https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/newstyle.py..SS bare-name-capture-pattern / E1901

پیام صادرشده:

الگوی گرفتن نام `case %s` باقی الگوها را غیرقابل‌دسترس می‌کند. برای رفع این مشکل از یک نام نقطه‌دار (برای نمونه یک enum) استفاده کنید.

توضیحات:

زمانی صادر می‌شود که یک الگوی ضبط نام (name capture pattern) در دستور match استفاده شده باشد و گزاره‌های case در ادامهٔ آن وجود داشته باشند.

کد دارای مشکل:

red = 0
green = 1
blue = 2
def func(color):
    match color:
        case red:  # [bare-name-capture-pattern]
            print("I see red!")
        case green:  # [bare-name-capture-pattern]
            print("Grass is green")
        case blue:
            print("I'm feeling the blues :(")

کد درست:

from enum import Enum
class Color(Enum):
    RED = 0
    GREEN = 1
    BLUE = 2
def func(color: Color) -> None:
    match color:
        case Color.RED:
            print("I see red!")
        case Color.GREEN:
            print("Grass is green")
        case Color.BLUE:
            print("I'm feeling the blues :(")

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کننده match_statements https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/match_statements_checker.py.

bidirectional-unicode / E2502

پیام صادرشده:

حاوی نویسه‌های کنترلی است که می‌توانند اجازه دهند کد مبهم، متفاوت از آنچه نمایش داده می‌شود اجرا گردد

توضیحات:

یونیکدهای دوجهته (bidirectional unicode) معمولاً نویسه‌هایی نمایش‌داده‌نشده هستند که برای نمایش صحیح خطوط راست‌به‌چپ (RTL) (مانند چینی، ژاپنی، عربی، عبری و...) مورد نیازند. بنابراین آیا می‌توانید به این کد اعتماد کنید؟ آیا مطمئن هستید که در تمام ویرایشگرها به‌درستی نمایش داده می‌شود؟ اگر خودتان آن را ننوشته‌اید یا زبانتان راست‌به‌چپ نیست، نویسه‌های ویژه را حذف کنید؛ زیرا می‌توان از آن‌ها برای فریب شما در اجرای کدی استفاده کرد که کاری متفاوت از ظاهرش انجام می‌دهد. اطلاعات بیشتر: https://en.wikipedia.org/wiki/Bidirectional_text https://trojansource.codes

کد دارای مشکل:

# +1: [bidirectional-unicode]
example = "x‏" * 100  #    "‏x" is assigned

کد درست:

example = "x[U+2194]" * 100

ایجاد شده توسط بررسی‌کننده unicode_checker https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/unicode.py..SS broken-collections-callable / E6005

پیام صادرشده:

'collections.abc.Callable' درون Optional و Union در 3.9.0 / 3.9.1 معیوب است (به‌جای آن از 'typing.Callable' استفاده کنید)

توضیحات:

استفاده از ``collections.abc.Callable`` درون Optional و Union در پایتون 3.9.0 و 3.9.1 با مشکل مواجه است. در این موارد به‌جای آن از ``typing.Callable`` استفاده کنید. https://bugs.python.org/issue42965

کد دارای مشکل:

from collections.abc import Callable
from typing import Optional
def func() -> Optional[Callable[[int], None]]:  # [broken-collections-callable]
    ...

کد صحیح:

from typing import Callable, Optional
def func() -> Optional[Callable[[int], None]]: ...

فایل پیکربندی:

[main]
py-version=3.9
load-plugins=pylint.extensions.typing

پیوندهای مرتبط:

نکته:

ایجاد شده توسط بررسی‌کننده typing https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/typing.py.

broken-noreturn / E6004

پیام صادرشده:

'NoReturn' درون انواع مرکب در 3.7.0 / 3.7.1 معیوب است

توضیحات:

استفاده از ``typing.NoReturn`` درون انواع مرکب در پایتون 3.7.0 و 3.7.1 با مشکل مواجه است. اگر به درون‌نگری زمان اجرا وابسته نیستید، به‌جای آن از نشانه‌گذاری رشته‌ای استفاده کنید؛ مانند ``Callable[..., 'NoReturn']``. https://bugs.python.org/issue34921

کد دارای مشکل:

from typing import NoReturn, Union
def exploding_apple(apple) -> Union[None, NoReturn]:  # [broken-noreturn]
    print(f"{apple} is about to explode")

کد صحیح:

from typing import NoReturn
def exploding_apple(apple) -> NoReturn:
    print(f"{apple} is about to explode")
    raise Exception("{apple} exploded !")

فایل پیکربندی:

[main]
py-version=3.7
load-plugins=pylint.extensions.typing

نکته:

ایجاد شده توسط بررسی‌کننده typing https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/typing.py..SS catching-non-exception / E0712

پیام صادرشده:

گرفتن استثنایی که از Exception ارث‌بری نمی‌کند: %s

توضیحات:

زمانی استفاده می‌شود که کلاسی که از Exception ارث‌بری نمی‌کند، به‌عنوان استثنا در یک بند except به کار رود.

کد دارای مشکل:

class FooError:
    pass
try:
    1 / 0
except FooError:  # [catching-non-exception]
    pass

کد درست:

class FooError(Exception):
    pass
try:
    1 / 0
except FooError:
    pass

ایجادشده توسط بررسی‌کنندهٔ exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py.

class-variable-slots-conflict / E0242

پیام صادرشده:

مقدار %r در slots با متغیر کلاس تداخل دارد

توضیحات:

زمانی استفاده می‌شود که مقداری در __slots__ با یک متغیر کلاس، property یا متد تداخل داشته باشد.

کد دارای مشکل:

class Person:
    # +1: [class-variable-slots-conflict, class-variable-slots-conflict, class-variable-slots-conflict]
    __slots__ = ("age", "name", "say_hi")
    name = None
    def __init__(self, age, name):
        self.age = age
        self.name = name
    @property
    def age(self):
        return self.age
    def say_hi(self):
        print(f"Hi, I'm {self.name}.")

کد درست:

class Person:
    __slots__ = ("_age", "name")
    def __init__(self, age, name):
        self._age = age
        self.name = name
    @property
    def age(self):
        return self._age
    def say_hi(self):
        print(f"Hi, I'm {self.name}.")

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS declare-non-slot / E0245

پیام صادرشده:

نام %r در __slots__ وجود ندارد

توضیحات:

هنگامی صادر می‌شود که یک یادداشت نوع (type annotation) در یک کلاس، در فهرست نام‌های موجود در __slots__ وجود نداشته باشد و __slots__ نیز شامل مدخل __dict__ نباشد.

کد دارای مشکل:

class Student:
    __slots__ = ("name",)
    name: str
    surname: str  # [declare-non-slot]

کد صحیح:

class Student:
    __slots__ = ("name", "surname")
    name: str
    surname: str

ایجادشده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

dict-iter-missing-items / E1141

پیام صادرشده:

بازگشایی یک دیکشنری در پیمایش بدون فراخوانی .items()

توضیحات:

هنگام تلاش برای پیمایش یک dict بدون فراخوانی .items() صادر می‌شود.

کد دارای مشکل:

data = {"Paris": 2_165_423, "New York City": 8_804_190, "Tokyo": 13_988_129}
for city, population in data:  # [dict-iter-missing-items]
    print(f"{city} has population {population}.")

کد صحیح:

data = {"Paris": 2_165_423, "New York City": 8_804_190, "Tokyo": 13_988_129}
for city, population in data.items():
    print(f"{city} has population {population}.")

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

duplicate-argument-name / E0108

پیام صادرشده:

نام آرگومان تکراری %r در تعریف تابع

توضیحات:

نام‌های آرگومان تکراری در تعریف توابع، خطای نحوی هستند.

کد دارای مشکل:

def get_fruits(apple, banana, apple):  # [duplicate-argument-name]
    pass

کد صحیح:

def get_fruits(apple, banana, orange):
    pass

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py..SS duplicate-bases / E0241

پیام صادرشده:

پایه‌های تکراری برای کلاس %r

توضیحات:

استفاده تکراری از کلاس‌های پایه در کلاس‌های مشتق‌شده باعث بروز TypeError می‌شود.

کد دارای مشکل:

class Animal:
    pass
class Cat(Animal, Animal):  # [duplicate-bases]
    pass

کد درست:

class Animal:
    pass
class Bird(Animal):
    pass
class Cat(Animal):
    pass

ایجادشده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

format-needs-mapping / E1303

پیام صادرشده:

برای رشته قالب‌بندی نگاشت انتظار می‌رفت، نه %s

توضیحات:

زمانی استفاده می‌شود که یک رشته قالب‌بندی دارای مشخص‌کننده‌های تبدیل نام‌دار، به همراه آرگومانی به کار رود که نگاشت (mapping) نیست.

کد دارای مشکل:

print("%(x)d %(y)d" % [1, 2])  # [format-needs-mapping]

کد درست:

print("%(x)d %(y)d" % {"x": 1, "y": 2})

ایجادشده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py..SS function-redefined / E0102

پیام صادرشده:

%s already defined line %s

توضیحات:

زمانی استفاده می‌شود که یک تابع / کلاس / متد بازتعریف شده باشد.

کد دارای مشکل:

def get_email():
    pass
def get_email():  # [function-redefined]
    pass

کد صحیح:

def get_email():
    pass

ایجادشده توسط بررسی‌کنندهٔ basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py.

inconsistent-mro / E0240

پیام صادرشده:

Inconsistent method resolution order for class %r

توضیحات:

زمانی استفاده می‌شود که یک کلاس ترتیب تفکیک متد (MRO) ناسازگاری داشته باشد.

کد دارای مشکل:

class A:
    pass
class B(A):
    pass
class C(A, B):  # [inconsistent-mro]
    pass

کد صحیح:

class A:
    pass
class B(A):
    pass
class C(B):  # or 'B, A' or 'A' but not 'A, B'
    pass

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS inherit-non-class / E0239

پیام صادرشده:

ارث‌بری از %r، که یک کلاس نیست.

توضیحات:

زمانی استفاده می‌شود که یک کلاس از چیزی که کلاس نیست ارث‌بری کند.

کد دارای مشکل:

class Fruit(bool):  # [inherit-non-class]
    pass

کد صحیح:

class Fruit:
    def __bool__(self):
        pass

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

init-is-generator / E0100

پیام صادرشده:

متد __init__ یک مولد (generator) است

توضیحات:

زمانی استفاده می‌شود که متد ویژهٔ کلاس __init__ به دلیل وجود yield در بدنهٔ خود، به یک مولد (generator) تبدیل شود.

کد دارای مشکل:

class Fruit:
    def __init__(self, worms):  # [init-is-generator]
        yield from worms
apple = Fruit(["Fahad", "Anisha", "Tabatha"])

کد صحیح:

class Fruit:
    def __init__(self, worms):
        self.__worms = worms
    def worms(self):
        yield from self.__worms
apple = Fruit(["Fahad", "Anisha", "Tabatha"])
for worm in apple.worms():
    pass

ایجادشده توسط بررسی‌کنندهٔ basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py..SS invalid-all-format / E0605

پیام صادرشده:

قالب نامعتبر برای __all__، باید tuple یا list باشد

توضیحات:

زمانی استفاده می‌شود که __all__ دارای قالبی نامعتبر باشد.

کد دارای مشکل:

__all__ = "CONST"  # [invalid-all-format]
CONST = 42

کد درست:

__all__ = ("CONST",)
CONST = 42

ایجاد شده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py.

invalid-all-object / E0604

پیام صادرشده:

شیء نامعتبر %r در __all__، باید فقط شامل رشته‌ها باشد

توضیحات:

زمانی استفاده می‌شود که یک شیء نامعتبر (غیررشته‌ای) در __all__ قرار گیرد.

کد دارای مشکل:

__all__ = (
    None,  # [invalid-all-object]
    Fruit,
    Worm,
)
class Fruit:
    pass
class Worm:
    pass

کد درست:

__all__ = ["Fruit", "Worm"]
class Fruit:
    pass
class Worm:
    pass

جزئیات تکمیلی:

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py..SS invalid-bool-returned / E0304

پیام صادرشده:

__bool__ مقدار bool برنمی‌گرداند

توضیحات:

زمانی استفاده می‌شود که یک متد __bool__ مقداری غیر از bool برگرداند

کد دارای مشکل:

class CustomBool:
    """__bool__ returns an int"""
    def __bool__(self):  # [invalid-bool-returned]
        return 1

کد درست:

class CustomBool:
    """__bool__ returns `bool`"""
    def __bool__(self):
        return True

ایجاد شده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py.

invalid-bytes-returned / E0308

پیام صادرشده:

__bytes__ مقدار bytes برنمی‌گرداند

توضیحات:

زمانی استفاده می‌شود که یک متد __bytes__ مقداری غیر از bytes برگرداند

کد دارای مشکل:

class CustomBytes:
    """__bytes__ returns <type 'str'>"""
    def __bytes__(self):  # [invalid-bytes-returned]
        return "123"

کد درست:

class CustomBytes:
    """__bytes__ returns <type 'bytes'>"""
    def __bytes__(self):
        return b"some bytes"

ایجاد شده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py..SS invalid-character-backspace / E2510

پیام صادرشده:

نویسهٔ backspace بدون گریز نامعتبر است، به‌جای آن از "\b" استفاده کنید.

توضیحات:

مکان‌نما را به عقب بازمی‌گرداند، بنابراین نویسهٔ بعد از آن روی نویسهٔ قبلی بازنویسی خواهد شد.

کد دارای مشکل:

STRING = "Invalid character backspace  "  # [invalid-character-backspace]

کد صحیح:

STRING = "Valid character backspace \b"

ایجادشده توسط بررسی‌کنندهٔ unicode_checker https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/unicode.py.

invalid-character-carriage-return / E2511

پیام صادرشده:

نویسهٔ carriage-return بدون گریز نامعتبر است، به‌جای آن از "\r" استفاده کنید.

توضیحات:

مکان‌نما را به ابتدای سطر می‌برد، نویسه‌های بعدی ابتدای سطر را بازنویسی خواهند کرد.

کد صحیح:

STRING = "Valid carriage return: \r"

جزئیات تکمیلی:

این پیام به این دلیل وجود دارد که یکی از بررسی‌کننده‌های ما بسیار عمومی است، اما در استفادهٔ عادی هرگز رخ نخواهد داد زیرا یک syntax-error است که مانع از ایجاد بازنمایی کد فایل توسط python ast (و در نتیجه pylint) می‌شود.

ممکن است تنها با ارسال مستقیم یک گرهِ به‌درستی ساخته‌شده به بررسی‌کننده با آن روبرو شوید.

ایجادشده توسط بررسی‌کنندهٔ unicode_checker https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/unicode.py.

invalid-character-esc / E2513

پیام صادرشده:

نویسهٔ esc بدون گریز نامعتبر است، به‌جای آن از "\x1B" استفاده کنید.

توضیحات:

معمولاً کدهای گریزی را آغاز می‌کند که امکان کنترل اختیاری ترمینال را فراهم می‌سازند.

کد دارای مشکل:

STRING = "Invalid escape character  "  # [invalid-character-esc]

کد صحیح:

STRING = "Valid escape character \x1b"

ایجادشده توسط بررسی‌کنندهٔ unicode_checker https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/unicode.py..SS invalid-character-nul / E2514

پیام صادرشده:

نویسهٔ nul فرارنشده نامعتبر است، به جای آن از "\0" استفاده کنید.

توضیحات:

عمدتاً پایان ورودی برای پایتون.

جزئیات بیشتر:

نیازی به استفاده از نویسه‌های پایان رشته نیست. اشیاء رشته‌ای طول خود را نگهداری می‌کنند.

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ unicode_checker https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/unicode.py.

invalid-character-sub / E2512

پیام صادرشده:

نویسهٔ sub فرارنشده نامعتبر است، به جای آن از "\x1A" استفاده کنید.

توضیحات:

ترکیب کلیدهای Ctrl+Z به عنوان "پایان متن" در ویندوز. برخی برنامه‌ها (مانند type) ادامهٔ فایل را پس از آن نادیده می‌گیرند.

کد مشکل‌دار:

STRING = "Invalid character sub  "  # [invalid-character-sub]

کد درست:

STRING = "Valid character sub x1A"

ایجادشده توسط بررسی‌کنندهٔ unicode_checker https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/unicode.py.

invalid-character-zero-width-space / E2515

پیام صادرشده:

نویسهٔ zero-width-space (فاصله با پهنای صفر) فرارنشده نامعتبر است، به جای آن از "\u200B" استفاده کنید.

توضیحات:

نویسهٔ فاصلهٔ نامرئی می‌تواند اجرای واقعی کد را پنهان کند.

کد مشکل‌دار:

STRING = "Invalid character zero-width-space ​"  # [invalid-character-zero-width-space]

کد درست:

STRING = "Valid character zero-width-space u200B"

ایجادشده توسط بررسی‌کنندهٔ unicode_checker https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/unicode.py..SS invalid-class-object / E0243

پیام صادرشده:

انتساب نامعتبر به '__class__'. باید یک تعریف کلاس باشد اما '%s' دریافت شد

توضیحات:

زمانی استفاده می‌شود که یک شیء نامعتبر به ویژگی __class__ منتسب شود. تنها یک کلاس مجاز است.

کد دارای مشکل:

class Apple:
    pass
Apple.__class__ = 1  # [invalid-class-object]

کد درست:

class Apple:
    pass
class RedDelicious:
    pass
Apple.__class__ = RedDelicious

ایجاد شده توسط بررسی‌کننده‌ی classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

invalid-enum-extension / E0244

پیام صادرشده:

گسترش کلاس ارث‌بری‌شده‌ی Enum با نام "%s"

توضیحات:

زمانی استفاده می‌شود که یک کلاس برای گسترش یک کلاس ارث‌بری‌شده‌ی Enum تلاش کند. انجام این کار باعث بروز TypeError در زمان اجرا خواهد شد.

کد دارای مشکل:

from enum import Enum
class Color(Enum):
    ORANGE = 1
    CHERRY = 2
class Fruit(Color):  # [invalid-enum-extension]
    APPLE = 3

کد درست:

from enum import Enum
class Color(Enum):
    ORANGE = 1
    CHERRY = 2
class Fruit(Enum):
    ORANGE = 1
    CHERRY = 2
    APPLE = 3

ایجاد شده توسط بررسی‌کننده‌ی classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS invalid-envvar-value / E1507

پیام صادرشده:

%s از آرگومان نوع %s پشتیبانی نمی‌کند

توضیحات:

توابع دستکاری متغیرهای محیطی فقط از آرگومان‌های نوع رشته پشتیبانی می‌کنند. https://docs.python.org/3/library/os.html#os.getenv را ببینید.

کد دارای مشکل:

import os
os.getenv(1)  # [invalid-envvar-value]

کد درست:

import os
os.getenv("1")

ایجادشده توسط بررسی‌کننده stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py.

invalid-field-call / E3701

پیام صادرشده:

استفاده نامعتبر از field()، %s

توضیحات:

مشخص‌کننده dataclasses.field() باید تنها به‌عنوان مقدار یک انتساب درون یک dataclass، یا درون تابع make_dataclass() استفاده شود.

کد دارای مشکل:

from dataclasses import dataclass, field
@dataclass
class C:
    a: float
    b: float
    c: float
    field(init=False)  # [invalid-field-call]
    def __post_init__(self):
        self.c = self.a + self.b
print(field(init=False))  # [invalid-field-call]

کد درست:

from dataclasses import dataclass, field, make_dataclass
C = make_dataclass(
    "C",
    [("x", int), "y", ("z", int, field(default=5))],
    namespace={"add_one": lambda self: self.x + 1},
)
@dataclass
class C:
    a: float
    b: float
    c: float = field(init=False)
    def __post_init__(self):
        self.c = self.a + self.b

ایجادشده توسط بررسی‌کننده dataclass https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/dataclass_checker.py..SS invalid-format-returned / E0311

پیام صادرشده:

__format__ مقدار str برنمی‌گرداند

توضیحات:

زمانی استفاده می‌شود که متد __format__ مقداری غیر از رشته بازگرداند

کد دارای مشکل:

class CustomFormat:
    """__format__ returns <type 'int'>"""
    def __format__(self, format_spec):  # [invalid-format-returned]
        return 1

کد صحیح:

class CustomFormat:
    """__format__ returns <type 'str'>"""
    def __format__(self, format_spec):
        return "hello!"

تولید شده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py.

invalid-getnewargs-ex-returned / E0313

پیام صادرشده:

__getnewargs_ex__ تاپلی شامل (tuple, dict) برنمی‌گرداند

توضیحات:

زمانی استفاده می‌شود که متد __getnewargs_ex__ مقداری را بازگرداند که به صورت tuple(tuple, dict) نباشد

کد دارای مشکل:

class CustomGetNewArgsEx:
    """__getnewargs_ex__ returns tuple with incorrect arg length"""
    def __getnewargs_ex__(self):  # [invalid-getnewargs-ex-returned]
        return (tuple(1), dict(x="y"), 1)

کد صحیح:

class CustomGetNewArgsEx:
    """__getnewargs_ex__ returns <type 'tuple'>"""
    def __getnewargs_ex__(self):
        return ((1,), {"2": 2})

تولید شده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py..SS invalid-getnewargs-returned / E0312

پیام صادرشده:

__getnewargs__ یک tuple بازنمی‌گرداند

توضیحات:

هنگامی به کار می‌رود که متد __getnewargs__ چیزی غیر از tuple بازگرداند

کد دارای مشکل:

class CustomGetNewArgs:
    """__getnewargs__ returns an integer"""
    def __getnewargs__(self):  # [invalid-getnewargs-returned]
        return 1

کد درست:

class CustomGetNewArgs:
    """__getnewargs__ returns <type 'tuple'>"""
    def __getnewargs__(self):
        return (1, 2)

ایجادشده توسط بررسی‌کنندهٔ classes در https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py.

invalid-hash-returned / E0309

پیام صادرشده:

__hash__ یک int بازنمی‌گرداند

توضیحات:

هنگامی به کار می‌رود که متد __hash__ چیزی غیر از یک عدد صحیح (integer) بازگرداند

کد دارای مشکل:

class CustomHash:
    """__hash__ returns dict"""
    def __hash__(self):  # [invalid-hash-returned]
        return {}

کد درست:

class CustomHash:
    """__hash__ returns `int`"""
    def __hash__(self):
        return 19

ایجادشده توسط بررسی‌کنندهٔ classes در https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py..SS invalid-index-returned / E0305

پیام صادرشده:

__index__ مقدار int برنمی‌گرداند

توضیحات:

زمانی استفاده می‌شود که متد __index__ مقداری را برگرداند که عدد صحیح نیست

کد دارای مشکل:

class CustomIndex:
    """__index__ returns a dict"""
    def __index__(self):  # [invalid-index-returned]
        return {"19": "19"}

کد صحیح:

class CustomIndex:
    """__index__ returns <type 'int'>"""
    def __index__(self):
        return 19

ایجادشده توسط بازبین classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py.

invalid-length-hint-returned / E0310

پیام صادرشده:

__length_hint__ عدد صحیح غیرمنفی برنمی‌گرداند

توضیحات:

زمانی استفاده می‌شود که متد __length_hint__ مقداری را برگرداند که یک عدد صحیح غیرمنفی نیست

کد دارای مشکل:

class CustomLengthHint:
    """__length_hint__ returns non-int"""
    def __length_hint__(self):  # [invalid-length-hint-returned]
        return 3.0

کد صحیح:

class CustomLengthHint:
    """__length_hint__ returns <type 'int'>"""
    def __length_hint__(self):
        return 10

ایجادشده توسط بازبین classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py..SS invalid-length-returned / E0303

پیام صادرشده:

__len__ عدد صحیح غیرمنفی برنمی‌گرداند

توضیحات:

زمانی استفاده می‌شود که یک متد __len__ مقداری را برگرداند که یک عدد صحیح غیرمنفی نیست

کد دارای اشکال:

class FruitBasket:
    def __init__(self, fruits):
        self.fruits = ["Apple", "Banana", "Orange"]
    def __len__(self):  # [invalid-length-returned]
        return -len(self.fruits)

کد صحیح:

class FruitBasket:
    def __init__(self, fruits):
        self.fruits = ["Apple", "Banana", "Orange"]
    def __len__(self):
        return len(self.fruits)

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py.

invalid-match-args-definition / E1902

پیام صادرشده:

`__match_args__` باید یک تاپل از رشته‌ها باشد.

توضیحات:

زمانی صادر می‌شود که `__match_args__` یک تاپل از رشته‌های مورد نیاز برای match نباشد.

کد دارای اشکال:

class Book:
    __match_args__ = ["title", "year"]  # [invalid-match-args-definition]
    def __init__(self, title, year):
        self.title = title
        self.year = year

کد صحیح:

class Book:
    __match_args__ = ("title", "year")
    def __init__(self, title, year):
        self.title = title
        self.year = year

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ match_statements https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/match_statements_checker.py..SS invalid-metaclass / E1139

پیام صادرشده:

متاکلاس نامعتبر %r استفاده شده است

توضیحات:

زمانی صادر می‌شود که تشخیص داده شود یک کلاس از چیزی به عنوان متاکلاس استفاده می‌کند که ممکن است برای استفاده به عنوان متاکلاس نامعتبر باشد.

کد مشکل‌دار:

class Apple(metaclass=int):  # [invalid-metaclass]
    pass

کد درست:

class Plant:
    pass
class Apple(Plant):
    pass

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

invalid-repr-returned / E0306

پیام صادرشده:

__repr__ مقدار str برنمی‌گرداند

توضیحات:

زمانی استفاده می‌شود که متد __repr__ چیزی غیر از رشته برگرداند

کد مشکل‌دار:

class CustomRepr:
    """__repr__ returns <type 'int'>"""
    def __repr__(self):  # [invalid-repr-returned]
        return 1

کد درست:

class CustomRepr:
    """__repr__ returns <type 'str'>"""
    def __repr__(self):
        return "apples"

ایجادشده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py..SS invalid-sequence-index / E1126

پیام صادرشده:

نمایهٔ دنباله یک int،‏ slice یا نمونه‌ای با __index__ نیست

توضیحات:

زمانی استفاده می‌شود که یک نوع دنباله با نوعی نامعتبر نمایه‌گذاری شود. انواع معتبر عبارتند از intها،‏ sliceها و اشیایی با متد __index__.

کد دارای مشکل:

fruits = ["apple", "banana", "orange"]
print(fruits["apple"])  # [invalid-sequence-index]

کد صحیح:

fruits = ["apple", "banana", "orange"]
print(fruits[0])

جزئیات بیشتر:

مراقب استفاده از [True] یا [False] به عنوان نمایهٔ دنباله باشید، زیرا True و False به ترتیب به صورت 1 و 0 ارزیابی می‌شوند و بدون ایجاد خطا، عنصر دوم و اول لیست را برمی‌گردانند.

ایجادشده توسط بررسی‌کنندهٔ typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

invalid-slice-index / E1127

پیام صادرشده:

نمایهٔ برش یک int،‏ None یا نمونه‌ای با __index__ نیست

توضیحات:

زمانی استفاده می‌شود که نمایهٔ برش یک عدد صحیح، None یا شیئی با متد __index__ نباشد.

کد دارای مشکل:

LETTERS = ["a", "b", "c", "d"]
FIRST_THREE = LETTERS[:"3"]  # [invalid-slice-index]

کد صحیح:

LETTERS = ["a", "b", "c", "d"]
FIRST_THREE = LETTERS[:3]

ایجادشده توسط بررسی‌کنندهٔ typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

invalid-slice-step / E1144

پیام صادرشده:

گام برش نمی‌تواند 0 باشد

توضیحات:

زمانی استفاده می‌شود که گام برش 0 باشد و شیء، متد سفارشی __getitem__ را پیاده‌سازی نکرده باشد.

کد دارای مشکل:

LETTERS = ["a", "b", "c", "d"]
LETTERS[::0]  # [invalid-slice-step]

کد صحیح:

LETTERS = ["a", "b", "c", "d"]
LETTERS[::2]

ایجادشده توسط بررسی‌کنندهٔ typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS invalid-slots / E0238

پیام صادرشده:

Invalid __slots__ object

توضیحات:

هنگامی استفاده می‌شود که یک __slots__ نامعتبر در کلاس یافت شود. تنها یک رشته، یک شیء تکرارپذیر یا یک دنباله مجاز است.

کد دارای اشکال:

class Person:  # [invalid-slots]
    __slots__ = 42

کد درست:

class Person:
    __slots__ = ("name", "age")

ایجاد شده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

invalid-slots-object / E0236

پیام صادرشده:

Invalid object %r in __slots__, must contain only non empty strings

توضیحات:

هنگامی استفاده می‌شود که یک شیء نامعتبر (غیررشته‌ای) در __slots__ قرار گیرد.

کد دارای اشکال:

class Person:
    __slots__ = ("name", 3)  # [invalid-slots-object]

کد درست:

class Person:
    __slots__ = ("name", "surname")

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

invalid-star-assignment-target / E0113

پیام صادرشده:

Starred assignment target must be in a list or tuple

توضیحات:

هنگامی صادر می‌شود که یک عبارت ستاره‌دار به‌عنوان مقصد انتساب ستاره‌دار استفاده شود.

کد دارای اشکال:

*fruit = ["apple", "banana", "orange"]  # [invalid-star-assignment-target]

کد درست:

fruit = ["apple", "banana", "orange"]

ایجاد شده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py..SS invalid-str-returned / E0307

پیام صادرشده:

__str__ مقدار str بازنمی‌گرداند

توضیحات:

هنگامی به کار می‌رود که متد __str__ چیزی غیر از یک رشته را بازگرداند.

کد دارای اشکال:

class CustomStr:
    """__str__ returns int"""
    def __str__(self):  # [invalid-str-returned]
        return 1

کد درست:

class CustomStr:
    """__str__ returns <type 'str'>"""
    def __str__(self):
        return "oranges"

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py.

invalid-unary-operand-type / E1130

پیام صادرشده:

%s

توضیحات:

هنگامی صادر می‌شود که یک عملوند یکانی روی شیئی به کار رود که از این نوع عملیات پشتیبانی نمی‌کند.

کد دارای اشکال:

cherries = 10
eaten_cherries = int
cherries = -eaten_cherries  # [invalid-unary-operand-type]

کد درست:

cherries = 10
eaten_cherries = 2
cherries -= eaten_cherries

ایجادشده توسط بررسی‌کنندهٔ typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

invalid-unicode-codec / E2501

پیام صادرشده:

UTF-16 و UTF-32 با نسخه‌های پیشین سازگار نیستند. به‌جای آن‌ها از UTF-8 استفاده کنید

توضیحات:

برای سازگاری، به‌جای UTF-16/UTF-32 از UTF-8 استفاده کنید. همچنین برای پیشینهٔ این موضوع به https://bugs.python.org/issue1503789 مراجعه کنید. و برای برخی از مشکلات احتمالی، برای نمونه هنگام استفاده از UTF-16، https://softwareengineering.stackexchange.com/questions/102205 را ببینید.

جزئیات تکمیلی:

این پیام یک جای‌نگه‌دار برای مشکلی احتمالی در آینده در رابطه با کدک‌های یونیکد است.

ایجادشده توسط بررسی‌کنندهٔ unicode_checker https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/unicode.py..SS logging-format-truncated / E1201

پیام صادرشده:

رشته قالب‌بندی لاگ‌گیری در میانه مشخص‌کننده تبدیل پایان می‌یابد

توضیحات:

زمانی استفاده می‌شود که رشته قالب دستور لاگ‌گیری پیش از پایان مشخص‌کننده تبدیل خاتمه یابد.

کد مشکل‌دار:

import logging
import sys
logging.warning("Python version: %", sys.version)  # [logging-format-truncated]

کد صحیح:

import logging
import sys
logging.warning("Python version: %s", sys.version)

ایجاد شده توسط بررسی‌کننده logging https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/logging.py.

logging-too-few-args / E1206

پیام صادرشده:

آرگومان‌های ناکافی برای رشته قالب‌بندی لاگ‌گیری

توضیحات:

زمانی استفاده می‌شود که به رشته قالب‌بندی لاگ‌گیری، آرگومان‌های بسیار کمی اختصاص داده شود.

کد مشکل‌دار:

import logging
try:
    function()
except Exception as e:
    logging.error("%s error occurred: %s", e)  # [logging-too-few-args]
    raise

کد صحیح:

import logging
try:
    function()
except Exception as e:
    logging.error("%s error occurred: %s", type(e), e)
    raise

ایجاد شده توسط بررسی‌کننده logging https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/logging.py..SS logging-too-many-args / E1205

پیام صادرشده:

آرگومان‌های بیش از حد برای رشته قالب‌بندی لاگ‌گیری

توضیحات:

زمانی استفاده می‌شود که به یک رشته قالب‌بندی لاگ‌گیری، بیش از حد آرگومان داده شود.

کد دارای مشکل:

import logging
try:
    function()
except Exception as e:
    logging.error("Error occurred: %s", type(e), e)  # [logging-too-many-args]
    raise

کد درست:

import logging
try:
    function()
except Exception as e:
    logging.error("%s error occurred: %s", type(e), e)
    raise

ایجادشده توسط بررسی‌کننده logging https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/logging.py.

logging-unsupported-format / E1200

پیام صادرشده:

نویسه قالب‌بندی لاگ‌گیری پشتیبانی‌نشده %r (%#02x) در اندیس %d

توضیحات:

زمانی استفاده می‌شود که یک نویسه قالب‌بندی پشتیبانی‌نشده در رشته قالب‌بندی دستور لاگ‌گیری به کار رود.

کد دارای مشکل:

import logging
logging.info("%s %y !", "Hello", "World")  # [logging-unsupported-format]

کد درست:

import logging
logging.info("%s %s !", "Hello", "World")

ایجادشده توسط بررسی‌کننده logging https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/logging.py..SS method-hidden / E0202

پیام صادرشده:

صفت تعریف‌شده در %s خط %s این متد را پنهان می‌کند

توضیحات:

زمانی استفاده می‌شود که یک کلاس متدی را تعریف کند که توسط یک صفت نمونه از یک کلاس والد یا تنظیم‌شده توسط کد بیرونی پنهان شده باشد.

کد دارای مشکل:

class Fruit:
    def __init__(self, vitamins):
        self.vitamins = vitamins
    def vitamins(self):  # [method-hidden]
        pass

کد درست:

class Fruit:
    def __init__(self, vitamins):
        self.vitamins = vitamins
    def antioxidants(self):
        pass

ایجاد شده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

misplaced-bare-raise / E0704

پیام صادرشده:

دستور raise درون یک بند except قرار ندارد

توضیحات:

زمانی استفاده می‌شود که یک raise بدون آرگومان (bare raise) درون یک بند except استفاده نشده باشد. این کار خطایی تولید می‌کند، زیرا هیچ استثنای فعالی برای پرتاب مجدد وجود ندارد. یک استثنا در این قاعده، یک raise بدون آرگومان درون یک بند finally است که تا زمانی که استثنایی درون بلوک try ایجاد شده باشد ممکن است کار کند، اما با این وجود نوعی بوی بد کد (code smell) به شمار می‌رود و نباید به آن اتکا کرد.

کد دارای مشکل:

def validate_positive(x):
    if x <= 0:
        raise  # [misplaced-bare-raise]

کد درست:

def validate_positive(x):
    if x <= 0:
        raise ValueError(f"{x} is not positive")

ایجاد شده توسط بررسی‌کننده exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py..SS misplaced-format-function / E0119

پیام صادرشده:

تابع format روی str فراخوانی نشده است

توضیحات:

زمانی صادر می‌شود که تابع format روی یک شیء str فراخوانی نشود؛ مانند انجام print("value: {}").format(123) به‌جای print("value: {}".format(123)). ممکن است این چیزی نباشد که کاربر قصد انجام آن را داشته است.

کد دارای مشکل:

print("Value: {}").format("Car")  # [misplaced-format-function]

کد درست:

print("Value: {}".format("Car"))

ایجادشده توسط بررسی‌کنندهٔ basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py.

missing-format-string-key / E1304

پیام صادرشده:

کلید %r در دیکشنری رشتهٔ قالب وجود ندارد

توضیحات:

زمانی استفاده می‌شود که یک رشتهٔ قالب با مشخص‌کننده‌های تبدیل نام‌گذاری‌شده، همراه با دیکشنری‌ای به‌کار رود که شامل تمام کلیدهای مورد نیاز آن رشتهٔ قالب نیست.

کد دارای مشکل:

# +1: [missing-format-string-key]
fruit_prices = """
Apple: %(apple_price)d ¤
Orange: %(orange_price)d ¤
""" % {
    "apple_price": 42
}

کد درست:

fruit_prices = """
Apple: %(apple_price)d ¤
Orange: %(orange_price)d ¤
""" % {
    "apple_price": 42,
    "orange_price": 87,
}

ایجادشده توسط بررسی‌کنندهٔ string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py.

missing-kwoa / E1125

پیام صادرشده:

آرگومان کلیدواژه‌ای اجباری %r در فراخوانی %s وجود ندارد

توضیحات:

زمانی استفاده می‌شود که در فراخوانی یک تابع، یک آرگومان فقط-کلیدواژه‌ای (keyword-only) اجباری ارسال نشود.

کد دارای مشکل:

def target(pos, *, keyword):
    return pos + keyword
def not_forwarding_kwargs(*args, **kwargs):
    target(*args)  # [missing-kwoa]

کد درست:

def target(pos, *, keyword):
    return pos + keyword
def not_forwarding_kwargs(*args, **kwargs):
    target(*args, **kwargs)

ایجادشده توسط بررسی‌کنندهٔ typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS mixed-format-string / E1302

پیام صادرشده:

ترکیب مشخص‌کننده‌های تبدیل نام‌دار و بدون نام در رشته قالب‌بندی

توضیحات:

هنگامی استفاده می‌شود که یک رشته قالب‌بندی، هم شامل مشخص‌کننده‌های تبدیل نام‌دار (مانند '%(foo)d') و هم بدون نام (مانند '%d') باشد. همچنین زمانی استفاده می‌شود که یک مشخص‌کننده تبدیل نام‌دار شامل * برای حداقل عرض فیلد و/یا دقت باشد.

کد دارای مشکل:

print("x=%(x)d, y=%d" % (0, 1))  # [mixed-format-string]

کد صحیح:

only_named.py:

print("x=%(x)d, y=%(y)d" % {"x": 0, "y": 1})

only_ordered.py:

print("x=%d, y=%d" % (0, 1))

ایجاد شده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py.

modified-iterating-dict / E4702

پیام صادرشده:

دیکشنری در حال پیمایش '%s' در داخل بدنه حلقه for در حال تغییر است؛ در عوض روی رونوشتی از آن پیمایش کنید.

توضیحات:

هنگامی صادر می‌شود که مواردی به یک dict در حال پیمایش اضافه یا از آن حذف شوند. انجام این کار باعث ایجاد خطای RuntimeError می‌شود.

کد دارای مشکل:

fruits = {"apple": 1, "orange": 2, "mango": 3}
i = 0
for fruit in fruits:
    fruits["apple"] = i  # [modified-iterating-dict]
    i += 1

کد صحیح:

fruits = {"apple": 1, "orange": 2, "mango": 3}
i = 0
for fruit in fruits.copy():
    fruits["apple"] = i
    i += 1

ایجاد شده توسط بررسی‌کننده modified_iteration https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/modified_iterating_checker.py..SS modified-iterating-set / E4703

پیام صادرشده:

مجموعهٔ در حال پیمایش '%s' در بدنهٔ حلقهٔ for تغییر داده می‌شود، به‌جای آن روی یک رونوشت از آن پیمایش کنید.

توضیحات:

زمانی صادر می‌شود که مواردی به یک مجموعهٔ در حال پیمایش اضافه یا از آن حذف شوند. انجام این کار باعث ایجاد یک RuntimeError می‌شود.

کد دارای مشکل:

fruits = {"apple", "orange", "mango"}
for fruit in fruits:
    fruits.add(fruit + "yum")  # [modified-iterating-set]

کد درست:

fruits = {"apple", "orange", "mango"}
for fruit in fruits.copy():
    fruits.add(fruit + "yum")

ایجاد شده توسط بازبین modified_iteration https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/modified_iterating_checker.py.

multiple-class-sub-patterns / E1904

پیام صادرشده:

چندین زیرالگو برای صفت %s

توضیحات:

زمانی صادر می‌شود که بیش از یک زیرالگو برای یک صفت مشخص در یک الگوی کلاس وجود داشته باشد.

کد دارای مشکل:

class Book:
    __match_args__ = ("title", "year")
    def __init__(self, title, year):
        self.title = title
        self.year = year
def func(item: Book):
    match item:
        case Book("abc", title="abc"):  # [multiple-class-sub-patterns]
            ...
        case Book(year=2000, year=2001):  # [multiple-class-sub-patterns]
            ...

کد درست:

class Book:
    __match_args__ = ("title", "year")
    def __init__(self, title, year):
        self.title = title
        self.year = year
def func(item: Book):
    match item:
        case Book(title="abc"):
            ...
        case Book(year=2000):
            ...

پیوندهای مرتبط:

ایجاد شده توسط بازبین match_statements https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/match_statements_checker.py..SS no-member / E1101

پیام صادرشده:

%s %r has no %r member%s

توضیحات:

زمانی استفاده می‌شود که به یک عضو ناموجود از یک متغیر دسترسی پیدا شود.

کد دارای مشکل:

from pathlib import Path
directories = Path("".").mothers  # [no-member]
class Cat:
    def meow(self):
        print(""Meow")
Cat().roar()  # [no-member]

کد تصحیح‌شده:

from pathlib import Path
directories = Path("".").parents
class Cat:
    def meow(self):
        print(""Meow")
Cat().meow()

جزئیات بیشتر:

اگر با خطای ناخوشایند no-member مواجه شده‌اید، این احتمال وجود دارد که یکی از موارد زیر رخ داده باشد:

تحلیل ماژول‌های اکستنشن C به‌صورت پیش‌فرض پشتیبانی نمی‌شود، به‌ویژه از آنجا که pylint راهی برای استخراج شیء AST از ماژول اکستنشن ندارد.

اما pylint در واقع سازوکاری دارد که در صورت تمایل به تحلیل اکستنشن‌های C می‌توانید از آن استفاده کنید. pylint پرچمی با نام extension-pkg-allow-list (سابقاً extension-pkg-whitelist) دارد که از طریق آن می‌توانید به آن اعلام کنید که ماژول مربوطه را وارد (import) کرده و از آن ماژول واردشده یک AST بسازد:

$ pylint --extension-pkg-allow-list=your_c_extension

توجه داشته باشید که استفاده از این پرچم بدین معناست که اکستنشن‌ها درون مفسر فعال پایتون بارگذاری می‌شوند و ممکن است کدهای دلخواهی را اجرا کنند که شاید شما تمایلی به آن نداشته باشید. به همین دلیل است که بارگذاری اکستنشن‌های C به‌صورت پیش‌فرض غیرفعال است. در صورتی که نمی‌خواهید دردسر مشخص کردن مداوم ماژول‌های اکستنشن C را با این پرچم متحمل شوید، می‌توانید گزینهٔ unsafe-load-any-extension را در فایل پیکربندی خود فعال کنید؛ این کار باعث ساخت اشیاء AST از تمام اکستنشن‌های C می‌شود که pylint با آن‌ها مواجه می‌گردد:

$ pylint --unsafe-load-any-extension=y

همچنین از آنجا که pylint برای صفاتی که در اکستنشن‌های C یافت نمی‌شوند خطای جداگانه‌ای تحت عنوان c-extension-no-member صادر می‌کند، می‌توانید این خطا را برای پروژهٔ خود غیرفعال نمایید.

اگر چیزی به‌صورت پویا تولید شود، pylint قادر به فهم کد کتابخانهٔ شما (چه اکستنشن C باشد و چه نباشد) نخواهد بود. در این حالت می‌توانید صفات تولیدشده را با گزینهٔ generated-members مشخص کنید. برای مثال اگر cv2.LINE_AA و sphinx.generated_member موارد مثبت کاذب برای no-member ایجاد می‌کنند، می‌توانید این دستور را اجرا کنید:

$ pylint --generated-member=cv2.LINE_AA,sphinx.generated_member

ایجادشده توسط بررسی‌کنندهٔ typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS no-method-argument / E0211

پیام صادرشده:

Method %r has no argument

توضیحات:

زمانی استفاده می‌شود که متدی که باید نمونه مقید (bound instance) را به عنوان نخستین آرگومان داشته باشد، هیچ آرگومانی برای آن تعریف نشده باشد.

کد دارای اشکال:

class Person:
    def print_greeting():  # [no-method-argument]
        print("hello")

کد درست:

class Person:
    def print_greeting(self):
        print("hello")

ایجادشده توسط بازبین classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

no-name-in-module / E0611

پیام صادرشده:

No name %r in module %r

توضیحات:

زمانی استفاده می‌شود که نامی در یک ماژول پیدا نشود.

کد دارای اشکال:

from os import pizza  # [no-name-in-module]

کد درست:

from os import path

ایجادشده توسط بازبین variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py.

no-self-argument / E0213

پیام صادرشده:

Method %r should have "self" as first argument

توضیحات:

زمانی استفاده می‌شود که یک متد آرگومانی غیر از "self" را به عنوان نخستین آرگومان خود داشته باشد. این مورد یک خطا در نظر گرفته می‌شود زیرا این قرارداد به قدری رایج است که نباید آن را زیر پا بگذارید!

کد دارای اشکال:

class Fruit:
    def __init__(this, name):  # [no-self-argument]
        this.name = name

کد درست:

class Fruit:
    def __init__(self, name):
        self.name = name

ایجادشده توسط بازبین classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS no-value-for-parameter / E1120

پیام صادرشده:

هیچ مقداری برای آرگومان %s در فراخوانی %s وجود ندارد

توضیحات:

زمانی استفاده می‌شود که در فراخوانی یک تابع، آرگومان‌های بسیار کمی ارسال شود.

کد دارای مشکل:

def add(x, y):
    return x + y
add(1)  # [no-value-for-parameter]

کد درست:

def add(x, y):
    return x + y
add(1, 2)

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

non-iterator-returned / E0301

پیام صادرشده:

__iter__ یک غیرتکرارکننده بازمی‌گرداند

توضیحات:

زمانی استفاده می‌شود که یک متد __iter__ چیزی را بازگرداند که تکرارپذیر نیست (یعنی فاقد متد `__next__` است)

کد دارای مشکل:

import random
class GenericAstrology:
    def __init__(self, signs, predictions):
        self.signs = signs
        self.predictions = predictions
    def __iter__(self):  # [non-iterator-returned]
        self.index = 0
        self.number_of_prediction = len(self.predictions)
        return self
SIGNS = ["Aries", "Taurus", "Gemini", "Cancer", "Leo", "Virgo", "Libra"]
PREDICTIONS = ["good things", "bad thing", "existential dread"]
for sign, prediction in GenericAstrology(SIGNS, PREDICTIONS):
    print(f"{sign} : {prediction} today")

کد درست:

import random
class GenericAstrology:
    def __init__(self, signs, predictions):
        self.signs = signs
        self.predictions = predictions
    def __iter__(self):
        self.index = 0
        self.number_of_prediction = len(self.predictions)
        return self
    def __next__(self):
        if self.index == len(self.signs):
            raise StopIteration
        self.index += 1
        prediction_index = random.randint(0, self.number_of_prediction - 1)
        return self.signs[self.index - 1], self.predictions[prediction_index]
SIGNS = ["Aries", "Taurus", "Gemini", "Cancer", "Leo", "Virgo", "Libra"]
PREDICTIONS = ["good things", "bad thing", "existential dread"]
for sign, prediction in GenericAstrology(SIGNS, PREDICTIONS):
    print(f"{sign} : {prediction} today")

ایجادشده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py..SS nonexistent-operator / E0107

پیام صادرشده:

استفاده از عملگر ناموجود %s

توضیحات:

زمانی استفاده می‌شود که تلاش کنید از عملگرهای پیش‌افزایش یا پیش‌کاهش به سبک C (-- و ++) که در Python وجود ندارند، استفاده کنید.

کد دارای مشکل:

i = 0
while i <= 10:
    print(i)
    ++i  # [nonexistent-operator]

کد صحیح:

i = 0
while i <= 10:
    print(i)
    i += 1

ایجاد شده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py.

nonlocal-and-global / E0115

پیام صادرشده:

نام %r هم nonlocal و هم global است

توضیحات:

زمانی صادر می‌شود که یک نام، هم nonlocal و هم global باشد.

کد دارای مشکل:

NUMBER = 42
def update_number(number):  # [nonlocal-and-global]
    global NUMBER
    nonlocal NUMBER
    NUMBER = number
    print(f"New global number is: {NUMBER}")
update_number(24)

کد صحیح:

NUMBER = 42
def update_number(number):
    global NUMBER
    NUMBER = number
    print(f"New global number is: {NUMBER}")
update_number(24)

ایجاد شده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py..SS nonlocal-without-binding / E0117

پیام صادرشده:

nonlocal name %s found without binding

توضیحات:

زمانی صادر می‌شود که یک متغیر nonlocal هیچ نام متصل‌شده‌ای در دامنه‌های والد نداشته باشد

کد دارای مشکل:

class Fruit:
    def get_color(self):
        nonlocal colors  # [nonlocal-without-binding]

کد درست:

class Fruit:
    colors = ["red", "green"]
    def get_color(self):
        nonlocal colors

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py.

not-a-mapping / E1134

پیام صادرشده:

Non-mapping value %s is used in a mapping context

توضیحات:

زمانی استفاده می‌شود که یک مقدار غیرنگاشت در جایی که نگاشت انتظار می‌رود، به کار رود

کد دارای مشکل:

def print_colors(**colors):
    print(colors)
print_colors(**list("red", "black"))  # [not-a-mapping]

کد درست:

def print_colors(**colors):
    print(colors)
print_colors(**dict(red=1, black=2))

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS not-an-iterable / E1133

پیام صادرشده:

مقدار غیرقابل‌پیمایش %s در یک بافت پیمایشی استفاده شده است

توضیحات:

زمانی استفاده می‌شود که یک مقدار غیرقابل‌پیمایش در جایی که انتظار یک شیء قابل‌پیمایش می‌رود به کار گرفته شود

کد دارای مشکل:

for i in 10:  # [not-an-iterable]
    pass

کد درست:

for i in "10":
    pass

ایجاد شده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

not-async-context-manager / E1701

پیام صادرشده:

مدیر زمینه ناهمگام '%s' متدهای __aenter__ و __aexit__ را پیاده‌سازی نکرده است.

توضیحات:

زمانی استفاده می‌شود که یک مدیر زمینه ناهمگام با شیئی به کار رود که پروتکل مدیریت زمینه ناهمگام را پیاده‌سازی نکرده است.

کد دارای مشکل:

class ContextManager:
    def __enter__(self):
        pass
    def __exit__(self, *exc):
        pass
async def foo():
    async with ContextManager():  # [not-async-context-manager]
        pass

کد درست:

class AsyncContextManager:
    def __aenter__(self):
        pass
    def __aexit__(self, *exc):
        pass
async def foo():
    async with AsyncContextManager():
        pass

جزئیات بیشتر:

مدیر زمینه ناهمگام متدهای __aenter__ و __aexit__ را پیاده‌سازی نکرده است. این پیام هنگام استفاده از Python < 3.5 صادر نمی‌شود.

ایجاد شده توسط بررسی‌کننده async https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/async_checker.py..SS not-callable / E1102

پیام صادرشده:

%s قابل فراخوانی نیست

توضیحات:

زمانی استفاده می‌شود که شیء فراخوانی‌شده، به عنوان یک شیء غیرقابل فراخوانی استنتاج شده باشد.

کد دارای مشکل:

NUMBER = 42
print(NUMBER())  # [not-callable]

کد درست:

NUMBER = 42
print(NUMBER)

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

not-context-manager / E1129

پیام صادرشده:

مدیر زمینه '%s' متدهای __enter__ و __exit__ را پیاده‌سازی نکرده است.

توضیحات:

زمانی استفاده می‌شود که یک نمونه در دستور with پروتکل مدیر زمینه (__enter__/__exit__) را پیاده‌سازی نکرده باشد.

کد دارای مشکل:

class MyContextManager:
    def __enter__(self):
        pass
with MyContextManager() as c:  # [not-context-manager]
    pass

کد درست:

class MyContextManager:
    def __enter__(self):
        pass
    def __exit__(self, *exc):
        pass
with MyContextManager() as c:
    pass

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS not-in-loop / E0103

پیام صادرشده:

%r به درستی درون حلقه قرار نگرفته است

توضیحات:

زمانی استفاده می‌شود که کلیدواژه‌های break یا continue بیرون از یک حلقه استفاده شده باشند.

کد دارای مشکل:

def print_even_numbers():
    for i in range(100):
        if i % 2 == 0:
            print(i)
    else:
        continue  # [not-in-loop]

کد صحیح:

def print_even_numbers():
    for i in range(100):
        if i % 2:
            continue
        print(i)

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py.

notimplemented-raised / E0711

پیام صادرشده:

NotImplemented برانگیخته شده است - باید NotImplementedError برانگیخته شود

توضیحات:

زمانی استفاده می‌شود که به جای NotImplementedError، خودِ NotImplemented برانگیخته شود.

کد دارای مشکل:

class Worm:
    def bore(self):
        raise NotImplemented  # [notimplemented-raised]

کد صحیح:

class Worm:
    def bore(self):
        raise NotImplementedError

ایجادشده توسط بررسی‌کننده exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py.

positional-only-arguments-expected / E3102

پیام صادرشده:

`%s()` برخی آرگومان‌های فقط-موقعیتی را به صورت آرگومان‌های کلیدواژه‌ای دریافت کرد: %s

توضیحات:

زمانی صادر می‌شود که آرگومان‌های فقط-موقعیتی (positional-only) به صورت آرگومان‌های کلیدواژه‌ای ارسال شده باشند. کلیدواژه‌ها را برای آرگومان‌های مربوطه در فراخوانی تابع حذف کنید.

کد دارای مشکل:

def cube(n, /):
    """Takes in a number n, returns the cube of n"""
    return n**3
cube(n=2)  # [positional-only-arguments-expected]

کد صحیح:

def cube(n, /):
    """Takes in a number n, returns the cube of n"""
    return n**3
cube(2)

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده method_args https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/method_args.py..SS possibly-used-before-assignment / E0606

پیام صادرشده:

استفادهٔ احتمالی از متغیر %r پیش از انتساب

توضیحات:

زمانی صادر می‌شود که به یک متغیر محلی پیش از انتساب مقدار به آن در هر دو شاخهٔ ساختار if/else دسترسی پیدا شود.

کد دارای مشکل:

def check_lunchbox(items: list[str]):
    if not items:
        empty = True
    print(empty)  # [possibly-used-before-assignment]

کد درست:

def check_lunchbox(items: list[str]):
    empty = False
    if not items:
        empty = True
    print(empty)

جزئیات بیشتر:

می‌توانید از assert_never برای مشخص کردن انتخاب‌های جامع (exhaustive) استفاده کنید:

from typing import assert_never
def handle_date_suffix(suffix):
    if suffix == "d":
        ...
    elif suffix == "m":
        ...
    elif suffix == "y":
        ...
    else:
        assert_never(suffix)
if suffix in "dmy":
    handle_date_suffix(suffix)

یا به جای assert_never()، می‌توانید تابعی با حاشیه‌نویسی بازگشتی Never یا NoReturn را فراخوانی کنید. برخلاف حالت معمول که pylint طبق طراحی خود حاشیه‌نویسی‌های نوع را نادیده می‌گیرد و تحلیل ایستای خودش را انجام می‌دهد، در اینجا pylint با این حاشیه‌نویسی‌های خاص مانند یک کامنت غیرفعال‌سازی رفتار می‌کند.

در حال حاضر pylint تکرار همان شرط را مانند این مجاز می‌داند، حتی با وجود اینکه این کار باعث نادیده ماندن برخی از موارد خطا می‌شود، چرا که pylint کدهای میانی را ارزیابی نمی‌کند:

if guarded():
    var = 1
# what if code here affects the result of guarded()?
if guarded():
    print(var)

اما این استثنا محدود به تکرار دقیقاً همان شرط است. این مورد هشدار صادر می‌کند:

if guarded():
    var = 1
if guarded() or other_condition:
    print(var)  # [possibly-used-before-assignment]

اگر این رفتار برایتان عجیب است، در نظر داشته باشید که pylint به عنوان یک ابزار تحلیل ایستا، نمی‌داند که آیا guarded() قطعی (deterministic) است یا با یک پایگاه‌داده ارتباط برقرار می‌کند. برای متغیرها (برای مثال guarded در برابر guarded())، این موضوع کمتر مسئله‌ساز است؛ بنابراین در این حالت، possibly-used-before-assignment بیشتر به عنوان یک ترجیح سبکی برای آینده‌نگری (future-proofing) عمل می‌کند تا این‌که ذاتاً یک خطا باشد.

ایجادشده توسط بررسی‌کنندهٔ variables در https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py..SS potential-index-error / E0643

پیام صادرشده:

نمایهٔ نامعتبر برای طول شیء تکرارپذیر

توضیحات:

زمانی صادر می‌شود که نمایهٔ استفاده‌شده روی یک شیء تکرارپذیر، فراتر از طول آن شیء باشد.

کد دارای مشکل:

print([1, 2, 3][3])  # [potential-index-error]

کد درست:

print([1, 2, 3][2])

ایجادشده توسط بررسی‌کنندهٔ variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py.

raising-bad-type / E0702

پیام صادرشده:

پرتاب %s در حالی که تنها کلاس‌ها یا نمونه‌ها مجاز هستند

توضیحات:

زمانی استفاده می‌شود که چیزی پرتاب شود که نه کلاس است و نه نمونه (یعنی یک `TypeError` رخ خواهد داد).

کد دارای مشکل:

class FasterThanTheSpeedOfLightError(ZeroDivisionError):
    def __init__(self):
        super().__init__("You can't go faster than the speed of light !")
def calculate_speed(distance: float, time: float) -> float:
    try:
        return distance / time
    except ZeroDivisionError as e:
        raise None  # [raising-bad-type]

کد درست:

class FasterThanTheSpeedOfLightError(ZeroDivisionError):
    def __init__(self):
        super().__init__("You can't go faster than the speed of light !")
def calculate_speed(distance: float, time: float) -> float:
    try:
        return distance / time
    except ZeroDivisionError as e:
        raise FasterThanTheSpeedOfLightError() from e

ایجادشده توسط بررسی‌کنندهٔ exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py..SS raising-non-exception / E0710

پیام صادرشده:

برانگیختن کلاسی که از BaseException ارث‌بری نمی‌کند

توضیحات:

زمانی استفاده می‌شود که کلاسی برانگیخته شود که از BaseException ارث‌بری نمی‌کند.

کد دارای مشکل:

raise str  # [raising-non-exception]

کد درست:

raise Exception("Goodbye world !")

ایجادشده توسط بررسی‌کنندهٔ exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py.

redundant-keyword-arg / E1124

پیام صادرشده:

آرگومان %r بر پایهٔ موقعیت و کلیدواژه در فراخوانی %s ارسال شده است

توضیحات:

زمانی استفاده می‌شود که فراخوانی یک تابع منجر به انتساب چندین مقدار به یک پارامتر تابع شود؛ یک مقدار از طریق آرگومان موقعیتی و مقداری دیگر از طریق آرگومان کلیدواژه‌ای.

کد دارای مشکل:

def square(x):
    return x * x
square(5, x=4)  # [redundant-keyword-arg]

کد درست:

only_arg.py:

def square(x):
    return x * x
square(5)

only_kwarg.py:

def square(x):
    return x * x
square(x=4)

ایجادشده توسط بررسی‌کنندهٔ typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS relative-beyond-top-level / E0402

پیام صادرشده:

تلاش برای واردسازی نسبی فراتر از بستهٔ سطح‌بالا

توضیحات:

زمانی استفاده می‌شود که یک واردسازی نسبی تلاش کند به سطوحی بیش از حد مجاز در بستهٔ جاری دسترسی یابد.

کد مشکل‌دار:

from ................antigravity import NGField  # [relative-beyond-top-level]

کد درست:

absolute_import.py:

from physic.antigravity import NGField

fix_the_relative_import.py:

# Right number of dots in the import: you needed 15 dots, not 16, duh.
# from ...............antigravity import NGField

جزئیات بیشتر:

از نظر تاریخی، واردسازی‌های مطلق (absolute imports) به‌شدت ترجیح داده می‌شدند. واردسازی‌های نسبی به شما امکان می‌دهند بسته‌ها را بدون تغییر هیچ کدی بازسازمان‌دهی کنید، اما امروزه ابزارهای بازآفرینی کد (refactoring) و IDEها به شما اجازه می‌دهند در صورت صریح/مطلق بودن واردسازی‌ها، در هر صورت این کار را تقریباً بدون هیچ هزینه‌ای انجام دهید. بنابراین، همچنان واردسازی‌های مطلق اغلب نسبت به موارد نسبی ترجیح داده می‌شوند.

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ imports https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/imports.py.

repeated-keyword / E1132

پیام صادرشده:

دریافت چندین مقدار برای آرگومان کلیدواژه‌ای %r در فراخوانی تابع

توضیحات:

زمانی صادر می‌شود که یک فراخوانی تابع چندین مقدار برای یک آرگومان کلیدواژه‌ای دریافت کند.

کد مشکل‌دار:

def func(a, b, c):
    return a, b, c
func(1, 2, c=3, **{"c": 4})  # [repeated-keyword]
func(1, 2, **{"c": 3}, **{"c": 4})  # [repeated-keyword]

کد درست:

def func(a, b, c):
    return a, b, c
func(1, 2, c=3)

ایجادشده توسط بررسی‌کنندهٔ typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS return-arg-in-generator / E0106

پیام صادرشده:

دستور return همراه با آرگومان درون generator

توضیحات:

زمانی استفاده می‌شود که یک عبارت "return" همراه با آرگومان در یک تابع یا متد مولد (generator) یافت شود (برای مثال به همراه چند عبارت "yield").

کد درست:

def yield_numbers():
    for number in range(10):
        yield number
        return "I am now allowed!"  # This was not allowed in Python 3.3 and earlier.

جزئیات بیشتر:

این پیامی است که برای python > 3.3 صادر نخواهد شد. این پیام قبلاً برای کدهایی مانند زیر صادر می‌شد:

def interrogate_until_you_find_jack(pirates):
    for pirate in pirates:
        if pirate == "Captain Jack Sparrow":
            return "Arrr! We've found our captain!"
        yield pirate

که اکنون معتبر بوده و معادل حالت مورد انتظار پیشین است:

def interrogate_until_you_find_jack(pirates):
    for pirate in pirates:
        if pirate == "Captain Jack Sparrow":
            raise StopIteration("Arrr! We've found our captain!")
        yield pirate

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py.

return-in-init / E0101

پیام صادرشده:

دستور return صریح در __init__

توضیحات:

زمانی استفاده می‌شود که متد خاص کلاس، یعنی __init__، دارای یک مقدار بازگشتی صریح باشد.

کد دارای مشکل:

class Sum:
    def __init__(self, a, b):  # [return-in-init]
        return a + b

کد درست:

class Sum:
    def __init__(self, a, b) -> None:
        self.result = a + b

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py..SS return-outside-function / E0104

پیام صادرشده:

بازگشت خارج از تابع

توضیحات:

هنگامی استفاده می‌شود که یک دستور "return" در خارج از یک تابع یا متد پیدا شود.

کد دارای مشکل:

return 42  # [return-outside-function]

کد درست:

def get_the_answer():
    return 42

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py.

singledispatch-method / E1519

پیام صادرشده:

دکوراتور singledispatch نباید با متدها استفاده شود، به جای آن از singledispatchmethod استفاده کنید.

توضیحات:

دکوراتور singledispatch باید توابع را تزیین کند و نه متدهای کلاس یا نمونه را. برای چنین مواردی از singledispatchmethod استفاده کنید.

کد دارای مشکل:

from functools import singledispatch
class Board:
    @singledispatch  # [singledispatch-method]
    def convert_position(self, position):
        pass
    @convert_position.register  # [singledispatch-method]
    def _(self, position: str) -> tuple:
        position_a, position_b = position.split(",")
        return (int(position_a), int(position_b))
    @convert_position.register  # [singledispatch-method]
    def _(self, position: tuple) -> str:
        return f"{position[0]},{position[1]}"

کد درست:

from functools import singledispatch
@singledispatch
def convert_position(position):
    print(position)
@convert_position.register
def _(position: str) -> tuple:
    position_a, position_b = position.split(",")
    return (int(position_a), int(position_b))
@convert_position.register
def _(position: tuple) -> str:
    return f"{position[0]},{position[1]}"

ایجادشده توسط بررسی‌کننده stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py..SS singledispatchmethod-function / E1520

پیام صادرشده:

دکوراتور singledispatchmethod نباید برای توابع استفاده شود؛ به‌جای آن از singledispatch استفاده کنید.

توضیحات:

singledispatchmethod باید متدهای کلاس یا نمونه را تزیین کند و نه توابع را. در این موارد از singledispatch استفاده کنید.

کد مشکل‌دار:

from functools import singledispatchmethod
@singledispatchmethod  # [singledispatchmethod-function]
def convert_position(position):
    print(position)
@convert_position.register  # [singledispatchmethod-function]
def _(position: str) -> tuple:
    position_a, position_b = position.split(",")
    return (int(position_a), int(position_b))
@convert_position.register  # [singledispatchmethod-function]
def _(position: tuple) -> str:
    return f"{position[0]},{position[1]}"

کد درست:

from functools import singledispatchmethod
class Board:
    @singledispatchmethod
    def convert_position(cls, position):
        pass
    @singledispatchmethod
    @classmethod
    def _(cls, position: str) -> tuple:
        position_a, position_b = position.split(",")
        return (int(position_a), int(position_b))
    @singledispatchmethod
    @classmethod
    def _(cls, position: tuple) -> str:
        return f"{position[0]},{position[1]}"

ایجادشده توسط بازبین stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py.

star-needs-assignment-target / E0114

پیام صادرشده:

عبارت ستاره‌دار فقط می‌تواند در مقصد انتساب استفاده شود

توضیحات:

هنگامی صادر می‌شود که یک عبارت ستاره‌دار در مقصد انتساب استفاده نشده باشد.

کد مشکل‌دار:

stars = *["Sirius", "Arcturus", "Vega"]  # [star-needs-assignment-target]

کد درست:

sirius, *arcturus_and_vega = ["Sirius", "Arcturus", "Vega"]

ایجادشده توسط بازبین basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py..SS syntax-error / E0001

پیام صادرشده:

%s

توضیحات:

زمانی استفاده می‌شود که یک خطای نحوی برای یک پودمان رخ دهد.

کد دارای مشکل:

fruit_stock = {
    'apple': 42,
    'orange': 21  # [syntax-error]
    'banana': 12
}

کد درست:

fruit_stock = {"apple": 42, "orange": 21, "banana": 12}

جزئیات تکمیلی:

پودمان توکار ast در python در صورت وجود یک خطای نحوی نمی‌تواند کد شما را تجزیه کند، بنابراین در صورت بروز خطای نحوی، سایر پیام‌ها اصلاً در دسترس نخواهند بود.

پیوندهای مرتبط:

ایجاد شده توسط بازبین main https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/lint/pylinter.py.

too-few-format-args / E1306

پیام صادرشده:

آرگومان‌های کافی برای رشتهٔ قالب‌بندی وجود ندارد (Not enough arguments for format string)

توضیحات:

زمانی استفاده می‌شود که به یک رشتهٔ قالب‌بندی که از مشخص‌کننده‌های تبدیل بدون نام استفاده می‌کند، آرگومان‌های بسیار کمی داده شود.

کد دارای مشکل:

print("Today is {0}, so tomorrow will be {1}".format("Monday"))  # [too-few-format-args]

کد درست:

print("Today is {0}, so tomorrow will be {1}".format("Monday", "Tuesday"))

پیوندهای مرتبط:

ایجاد شده توسط بازبین string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py..SS too-many-format-args / E1305

پیام صادرشده:

آرگومان‌های بیش از حد برای رشته قالب‌بندی

توضیحات:

زمانی استفاده می‌شود که به یک رشته قالب‌بندی که از مشخص‌کننده‌های تبدیل بدون نام استفاده می‌کند، آرگومان‌های بیش از حد داده شود.

کد دارای اشکال:

# +1: [too-many-format-args]
print("Today is {0}, so tomorrow will be {1}".format("Monday", "Tuesday", "Wednesday"))

کد درست:

print("Today is {0}, so tomorrow will be {1}".format("Monday", "Tuesday"))

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py.

too-many-function-args / E1121

پیام صادرشده:

آرگومان‌های مکانی بیش از حد برای فراخوانی %s

توضیحات:

زمانی استفاده می‌شود که در فراخوانی یک تابع، آرگومان‌های مکانی بیش از حد ارسال شود.

کد دارای اشکال:

class Fruit:
    def __init__(self, color):
        self.color = color
apple = Fruit("red", "apple", [1, 2, 3])  # [too-many-function-args]

کد درست:

class Fruit:
    def __init__(self, color, name):
        self.color = color
        self.name = name
apple = Fruit("red", "apple")

ایجاد شده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS too-many-positional-sub-patterns / E1903

پیام صادرشده:

%s انتظار %d زیرالگوی موقعیتی دارد (%d داده شده است)

توضیحات:

هنگامی صادر می‌شود که تعداد زیرالگوهای موقعیتی از تعداد زیرالگوهای مجاز مشخص‌شده در `__match_args__` فراتر رود.

کد دارای مشکل:

class Book:
    __match_args__ = ("title", "year")
    def __init__(self, title, year, author):
        self.title = title
        self.year = year
        self.author = author
def func(item: Book):
    match item:
        case Book("title", 2000, "author"):  # [too-many-positional-sub-patterns]
            ...

کد درست:

class Book:
    __match_args__ = ("title", "year")
    def __init__(self, title, year, author):
        self.title = title
        self.year = year
        self.author = author
def func(item: Book):
    match item:
        case Book("title", 2000, author="author"):
            ...

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ match_statements https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/match_statements_checker.py.

too-many-star-expressions / E0112

پیام صادرشده:

بیش از یک عبارت ستاره‌دار در انتساب

توضیحات:

هنگامی صادر می‌شود که بیش از یک عبارت ستاره‌دار (`*x`) در یک انتساب وجود داشته باشد. این یک SyntaxError است.

کد دارای مشکل:

*stars, *constellations = ["Sirius", "Arcturus", "Vega"]  # [too-many-star-expressions]

کد درست:

*sirius_and_arcturus, vega = ["Sirius", "Arcturus", "Vega"]

ایجادشده توسط بررسی‌کنندهٔ basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py..SS truncated-format-string / E1301

پیام صادرشده:

رشته قالب‌بندی در میانه مشخص‌کننده تبدیل پایان می‌یابد

توضیحات:

زمانی استفاده می‌شود که یک رشته قالب‌بندی پیش از پایان یک مشخص‌کننده تبدیل خاتمه یابد.

کد دارای مشکل:

PARG_2 = 1
print("strange format %2" % PARG_2)  # [truncated-format-string]

کد درست:

PARG_2 = 1
print(f"strange format {PARG_2}")

ایجادشده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py.

undefined-all-variable / E0603

پیام صادرشده:

نام متغیر تعریف‌نشده %r در __all__

توضیحات:

زمانی استفاده می‌شود که در __all__ به یک نام متغیر تعریف‌نشده ارجاع داده شود.

کد دارای مشکل:

__all__ = ["get_fruit_colour"]  # [undefined-all-variable]
def get_fruit_color():
    pass

کد درست:

__all__ = ["get_fruit_color"]
def get_fruit_color():
    pass

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py..SS undefined-variable / E0602

پیام صادرشده:

متغیر تعریف‌نشده %r

توضیحات:

زمانی استفاده می‌شود که به یک متغیر تعریف‌نشده دسترسی پیدا شود.

کد دارای مشکل:

print(number + 2)  # [undefined-variable]

کد صحیح:

number = 3
print(number + 2)

ایجادشده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py.

unexpected-keyword-arg / E1123

پیام صادرشده:

آرگومان کلیدواژه‌ای غیرمنتظره %r در فراخوانی %s

توضیحات:

زمانی استفاده می‌شود که در فراخوانی یک تابع، آرگومان کلیدواژه‌ای ارسال شود که با هیچ‌یک از نام‌های پارامتر تابع مطابقت ندارد.

کد دارای مشکل:

def print_coordinates(x=0, y=0):
    print(f"{x=}, {y=}")
print_coordinates(x=1, y=2, z=3)  # [unexpected-keyword-arg]

کد صحیح:

def print_coordinates(x=0, y=0):
    print(f"{x=}, {y=}")
print_coordinates(x=1, y=2)

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

unexpected-special-method-signature / E0302

پیام صادرشده:

متد ویژه %r انتظار %s پارامتر(ها) را دارد، %d %s داده شده است

توضیحات:

زمانی صادر می‌شود که یک متد ویژه با تعداد نامعتبری از پارامترها تعریف شده باشد. اگر تعداد آن‌ها بسیار کم یا بسیار زیاد باشد، ممکن است اصلاً کار نکند.

کد دارای مشکل:

class ContextManager:
    def __enter__(self, context):  # [unexpected-special-method-signature]
        pass
    def __exit__(self, type):  # [unexpected-special-method-signature]
        pass

کد صحیح:

class ContextManager:
    def __enter__(self):
        pass
    def __exit__(self, type, value, traceback):
        pass

ایجادشده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/special_methods_checker.py..SS unhashable-member / E1143

پیام صادرشده:

'%s' هش‌پذیر نیست و نمی‌تواند به عنوان یک %s در یک %s به کار رود

توضیحات:

زمانی صادر می‌شود که یک کلید dict یا عضو set هش‌پذیر نباشد (یعنی متد __hash__ را تعریف نکرده باشد).

کد دارای مشکل:

# Print the number of apples:
print({"apple": 42}[["apple"]])  # [unhashable-member]

کد صحیح:

# Print the number of apples:
print({"apple": 42}["apple"])

ایجاد شده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

unpacking-non-sequence / E0633

پیام صادرشده:

تلاش برای بازگشایی یک غیردنباله%s

توضیحات:

زمانی استفاده می‌شود که چیزی که یک دنباله نیست، در یک انتساب بازگشایی (unpack) به کار رود

کد دارای مشکل:

a, b, c = 1  # [unpacking-non-sequence]

کد صحیح:

a, b, c = 1, 2, 3

ایجاد شده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py.

unrecognized-inline-option / E0011

پیام صادرشده:

گزینه فایل ناشناخته %r

توضیحات:

زمانی استفاده می‌شود که با یک گزینه درون‌خطی ناشناخته مواجه شویم.

کد دارای مشکل:

# +1: [unrecognized-inline-option]
# pylint:applesoranges=1

کد صحیح:

# pylint: enable=too-many-public-methods

ایجاد شده توسط بررسی‌کننده main https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/lint/pylinter.py..SS unrecognized-option / E0015

پیام صادرشده:

گزینه ناشناخته یافت شد: %s

توضیحات:

هنگامی استفاده می‌شود که گزینه‌ای تشخیص داده شود که برای برنامه ناشناخته است.

جزئیات تکمیلی:

یکی از گزینه‌های شما ناشناخته است. نیازی به ایجاد تغییر در کد شما نیست، اما پیکربندی pylint یا نحوه فراخوانی pylint باید اصلاح شود.

برای نمونه، این پیام هنگام اجرای pylint به صورت pylint --unknown-option=yes test.py صادر می‌شود. یا ممکن است pylint را با پیکربندی toml زیر اجرا کرده باشید:

[tool.pylint]
jars = "10"

در حالی که باید از مورد زیر استفاده شود:

[tool.pylint]
jobs = "10"

این هشدار در pylint 2.14 اضافه شد؛ پیش از آن، گزینه‌های نادرست در سکوت و بدون خطا نادیده گرفته می‌شدند.

ایجاد شده توسط بازبین main https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/lint/pylinter.py.

unsubscriptable-object / E1136

پیام صادرشده:

مقدار '%s' قابل اندیس‌گذاری نیست

توضیحات:

هنگامی صادر می‌شود که یک مقدار اندیس‌گذاری‌شده از قابلیت اندیس‌گذاری پشتیبانی نکند (یعنی متد __getitem__ یا برای یک کلاس متد __class_getitem__ را تعریف نکرده باشد).

کد دارای مشکل:

class Fruit:
    pass
Fruit()[1]  # [unsubscriptable-object]

کد صحیح:

class Fruit:
    def __init__(self):
        self.colors = ["red", "orange", "yellow"]
    def __getitem__(self, idx):
        return self.colors[idx]
Fruit()[1]

ایجاد شده توسط بازبین typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS unsupported-assignment-operation / E1137

پیام صادرشده:

%r does not support item assignment

توضیحات:

زمانی صادر می‌شود که یک شیء از انتساب آیتم پشتیبانی نکند (یعنی متد __setitem__ را تعریف نکرده باشد).

کد مشکل‌دار:

def pick_fruits(fruits):
    for fruit in fruits:
        print(fruit)
pick_fruits(["apple"])[0] = "orange"  # [unsupported-assignment-operation]

کد درست:

def pick_fruits(fruits):
    for fruit in fruits:
        print(fruit)
    return []
pick_fruits(["apple"])[0] = "orange"

ایجاد شده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

unsupported-binary-operation / E1131

پیام صادرشده:

%s

توضیحات:

زمانی صادر می‌شود که یک عملیات حسابی دودویی بین دو عملوند پشتیبانی نشود.

کد مشکل‌دار:

drink = "water" | None  # [unsupported-binary-operation]
result = [] | None  # [unsupported-binary-operation]

کد درست:

masked = 0b111111 & 0b001100
result = 0xAEFF | 0x0B99

فایل پیکربندی:

[main]
py-version=3.9

ایجاد شده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS unsupported-delete-operation / E1138

پیام صادرشده:

%r does not support item deletion

توضیحات:

زمانی صادر می‌شود که یک شیء از حذف آیتم پشتیبانی نکند (یعنی متد __delitem__ را تعریف نکرده باشد).

کد دارای مشکل:

FRUITS = ("apple", "orange", "berry")
del FRUITS[0]  # [unsupported-delete-operation]

کد صحیح:

FRUITS = ["apple", "orange", "berry"]
del FRUITS[0]

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

unsupported-membership-test / E1135

پیام صادرشده:

Value '%s' doesn't support membership test

توضیحات:

زمانی صادر می‌شود که یک نمونه در عبارت آزمون عضویت، پروتکل عضویت (__contains__/__iter__/__getitem__) را پیاده‌سازی نکرده باشد.

کد دارای مشکل:

class Fruit:
    pass
apple = "apple" in Fruit()  # [unsupported-membership-test]

کد صحیح:

class Fruit:
    FRUITS = ["apple", "orange"]
    def __contains__(self, name):
        return name in self.FRUITS
apple = "apple" in Fruit()

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS used-before-assignment / E0601

پیام صادرشده:

استفاده از متغیر %r پیش از انتساب

توضیحات:

زمانی صادر می‌شود که به یک متغیر محلی پیش از انتساب آن دسترسی پیدا شود. هنگام ارزیابی بلوک‌های except/finally مرتبط، فرض می‌شود که انتساب‌های درون بلوک‌های try رخ نداده‌اند. همچنین هنگام ارزیابی دستورهای خارج از بلوک، فرض بر این است که انتساب‌های درون بلوک‌های except انجام نگرفته‌اند، مگر زمانی که بلوک try مرتبط شامل دستور return باشد.

کد دارای مشکل:

print(hello)  # [used-before-assignment]
hello = "Hello World !"

کد صحیح:

hello = "Hello World !"
print(hello)

ایجاد شده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py.

used-prior-global-declaration / E0118

پیام صادرشده:

نام %r پیش از اعلان global استفاده شده است

توضیحات:

زمانی صادر می‌شود که یک نام پیش از اعلان global استفاده شود، که از Python 3.6 به بعد منجر به خطا می‌شود.

کد دارای مشکل:

TOMATO = "black cherry"
def update_tomato():
    print(TOMATO)  # [used-prior-global-declaration]
    global TOMATO
    TOMATO = "cherry tomato"

کد صحیح:

TOMATO = "black cherry"
def update_tomato():
    global TOMATO
    TOMATO = "moneymaker"

ایجاد شده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py.

yield-inside-async-function / E1700

پیام صادرشده:

yield درون تابع async

توضیحات:

زمانی استفاده می‌شود که یک دستور `yield` یا `yield from` درون یک تابع async یافت شود.

کد دارای مشکل:

async def foo():
    yield from [1, 2, 3]  # [yield-inside-async-function]

کد صحیح:

async def foo():
    def _inner_foo():
        yield from [1, 2, 3]
async def foo():
    yield 42

جزئیات بیشتر:

این پیام هنگام استفاده از Python < 3.5 نمی‌تواند صادر شود.

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کننده async https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/async_checker.py..SS yield-outside-function / E0105

پیام صادرشده:

دستور yield خارج از تابع

توضیحات:

زمانی استفاده می‌شود که یک دستور "yield" خارج از یک تابع یا متد یافت شود.

کد دارای مشکل:

for i in range(10):
    yield i  # [yield-outside-function]

کد درست:

def one_to_ten():
    for i in range(10):
        yield i

ایجادشده توسط بررسی‌کنندهٔ basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py.

تمام پیام‌های تغییرنام‌یافته در دسته‌بندی خطا:

bad-context-manager / E0235

پیام 'bad-context-manager' تغییر نام یافته است. پیام جدید را می‌توان در این نشانی یافت:

bad-exception-context / E0703

پیام 'bad-exception-context' تغییر نام یافته است. پیام جدید را می‌توان در این نشانی یافت:

bad-option-value / E0012

پیام 'bad-option-value' تغییر نام یافته است. پیام جدید را می‌توان در این نشانی یافت:

useless-option-value / R0022

پیام صادرشده:

مقدار گزینهٔ بی‌استفاده برای '%s'، %s

توضیحات:

زمانی استفاده می‌شود که با مقداری برای گزینه‌ای که اکنون از pylint حذف شده است، برخورد شود.

کد دارای مشکل:

"""'bad-continuation' was removed from pylint in https://github.com/pylint-dev/pylint/pull/3571"""
# pylint: disable=bad-continuation  # [useless-option-value]

کد درست:

"""'bad-continuation' was removed from pylint in https://github.com/pylint-dev/pylint/pull/3571"""

جزئیات بیشتر:

اگر نمی‌خواهید پیکربندی خود را از پیام‌های قدیمی پاک‌سازی کنید، می‌توانید این بررسی را غیرفعال کنید.

ایجادشده توسط بررسی‌کنندهٔ main https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/lint/pylinter.py..SS unknown-option-value / W0012

پیام صادرشده:

مقدار ناشناختهٔ گزینه برای '%s'، یک پیام معتبر pylint انتظار می‌رفت اما '%s' دریافت شد

توضیحات:

زمانی استفاده می‌شود که با یک مقدار ناشناخته برای یک گزینه مواجه شود.

کد دارای مشکل:

# pylint: disable=missnig-docstring  # [unknown-option-value]

کد صحیح:

# pylint: disable=missing-docstring

ایجادشده توسط وارسی‌کنندهٔ main https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/lint/pylinter.py.

maybe-no-member / E1103

نام 'maybe-no-member' تغییر یافته است. پیام جدید را می‌توان در اینجا یافت:

old-non-iterator-returned-2 / E0234

نام 'old-non-iterator-returned-2' تغییر یافته است. پیام جدید را می‌توان در اینجا یافت:

old-unbalanced-tuple-unpacking / E0632

نام 'old-unbalanced-tuple-unpacking' تغییر یافته است. پیام جدید را می‌توان در اینجا یافت:

unbalanced-tuple-unpacking / W0632

پیام صادرشده:

احتمال بازگشایی ناتراز تاپل با دنبالهٔ %s: سمت چپ دارای %d برچسب%s، سمت راست دارای %d مقدار%s است

توضیحات:

زمانی استفاده می‌شود که یک بازگشایی ناتراز تاپل در انتساب وجود داشته باشد

کد دارای مشکل:

fruits = ("orange", "apple", "strawberry", "peer")
orange, apple, strawberry = fruits  # [unbalanced-tuple-unpacking]

کد صحیح:

fruits = ("orange", "apple", "strawberry", "peer")
orange, apple, *remaining_fruits = fruits

پیوندهای مرتبط:

ایجادشده توسط وارسی‌کنندهٔ variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py..SS unhashable-dict-key / E1140

'unhashable-dict-key' تغییر نام یافته است. پیام جدید را می‌توان در اینجا یافت:

هشدار (Warning)

تمام پیام‌ها در دسته‌بندی هشدار:

abstract-method / W0223

پیام صادرشده:

متد %r در کلاس %r انتزاعی است اما در کلاس فرزند %r بازنویسی نشده است

توضیحات:

زمانی استفاده می‌شود که یک متد انتزاعی (یعنی raise NotImplementedError) در کلاس عینی (concrete) بازنویسی نشده باشد.

کد دارای مشکل:

abstract_method.py:

import abc
class WildAnimal:
    @abc.abstractmethod
    def make_sound(self):
        pass
class Panther(WildAnimal):  # [abstract-method]
    pass

function_raising_not_implemented_error.py:

class Pet:
    def make_sound(self):
        raise NotImplementedError
class Cat(Pet):  # [abstract-method]
    pass

کد صحیح:

abstract_method.py:

import abc
class WildAnimal:
    @abc.abstractmethod
    def make_sound(self):
        pass
class Panther(WildAnimal):
    def make_sound(self):
        print("MEEEOW")

function_raising_not_implemented_error.py:

class Pet:
    def make_sound(self):
        raise NotImplementedError
class Cat(Pet):
    def make_sound(self):
        print("Meeeow")

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS anomalous-backslash-in-string / W1401

پیام صادرشده:

بک‌اسلش غیرعادی در رشته: '%s'. ممکن است ثابت رشته فاقد پیشوند r باشد.

توضیحات:

هنگامی استفاده می‌شود که یک بک‌اسلش در یک رشتهٔ لیترال وجود داشته باشد اما به عنوان یک نویسهٔ گریز عمل نکند.

کد دارای مشکل:

string = "\z"  # [syntax-error]

کد صحیح:

double_escape.py:

string = "\\z"

existing_escape_sequence.py:

string = "\t"

r_prefix.py:

string = r"\z"

جزئیات بیشتر:

\z همانند \\z است زیرا هیچ توالی گریزی برای z وجود ندارد. اما این موضوع برای خوانندهٔ کد مشخص نیست.

تنها دلیلی که نشان داده شده این مورد منجر به syntax-error می‌شود این است که CI مربوط به pylint اکنون بر روی Python 3.12 اجرا می‌شود، جایی که این حالت واقعاً یک SyntaxError صادر می‌کند. امیدواریم در آینده این ناهمخوانی را در مستندات برطرف کنیم.

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کنندهٔ string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py.

anomalous-unicode-escape-in-string / W1402

پیام صادرشده:

توالی گریز یونیکد غیرعادی در رشتهٔ بایتی: '%s'. ممکن است ثابت رشته فاقد پیشوند r یا u باشد.

توضیحات:

هنگامی استفاده می‌شود که یک گریز مانند u در یک رشتهٔ بایتی دیده شود در حالی که هیچ اثری در آن ندارد.

کد دارای مشکل:

print(b"\u%b" % b"0394")  # [syntax-error]

کد صحیح:

print(b"\\u%b" % b"0394")

ایجاد شده توسط بررسی‌کنندهٔ string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py..SS arguments-differ / W0221

پیام صادرشده:

%s %s %r method

توضیحات:

زمانی استفاده می‌شود که یک متد تعداد متفاوتی آرگومان نسبت به رابط پیاده‌سازی‌شده یا متد بازنویسی‌شده داشته باشد. آرگومان‌های اضافی دارای مقدار پیش‌فرض نادیده گرفته می‌شوند.

کد دارای مشکل:

class Drink:
    def mix(self, fluid_one, fluid_two):
        return fluid_one + fluid_two
class Cocktail(Drink):
    def mix(self, fluid_one, fluid_two, alcoholic_fluid):  # [arguments-differ]
        return fluid_one + fluid_two + alcoholic_fluid

کد صحیح:

add_option_in_base_class.py:

"""
Here we assume that drink and cocktail are the same thing and should actually
inherit from each over. We also assume that 'Drink' are 'Cocktail' without
alcohol (we added the alcohol option in the base class).
This permit to not have to modify the cocktails calls downstream but the case where
an alcohol is mixed in a soft drink will need to be handled.
"""
class Drink:
    def mix(self, fluid_one, fluid_two, alcoholic_fluid=None):
        # if alcoholic_fluid is not None:
        #     raise Exception(f"This soft drink has {alcoholic_fluid} in it !")
        return fluid_one + fluid_two
class Cocktail(Drink):
    def mix(self, fluid_one, fluid_two, alcoholic_fluid):
        return fluid_one + fluid_two + alcoholic_fluid

default_value.py:

"""
Here we assume that drink and cocktail are the same thing and should actually
inherit from each over. We also assume that any Cocktail can be treated like
a Drink (if you add beer to it).
This permit to not have to modify the calls downstream and causes the least
amount of disturbance at the cost of making cocktails beer-based implicitly.
"""
class Drink:
    def mix(self, fluid_one, fluid_two):
        return fluid_one + fluid_two
class Cocktail(Drink):
    def mix(self, fluid_one, fluid_two, alcoholic_fluid="Beer"):
        return fluid_one + fluid_two + alcoholic_fluid

no_inheritance.py:

"""
Here we assume that 'Drink' and 'Cocktail' are different things and should
not be treated together like if they were the same thing.
This will force some downstream changes and force the API user to make a
conscious decision about the alcoholic content of its drink when using the
API. For example, it's impossible to create a mojito with beer without
explicitly wanting to, or to add an alcohol to a soft-drink.
"""
class Drink:
    def mix(self, fluid_one, fluid_two):
        return fluid_one + fluid_two
class Cocktail:
    def mix(self, fluid_one, fluid_two, alcoholic_fluid):
        return fluid_one + fluid_two + alcoholic_fluid

جزئیات بیشتر:

argument-differ نشان‌دهنده مشکلی در رابطه با «اصل جایگزینی لیسکوف» (Liskov Substitution Principle) است. این بدان معناست که کد مورد نظر یک اصل مهم طراحی را نقض می‌کند که راه‌حل واحدی ندارد. توصیه می‌کنیم برای یافتن بهترین راه‌حل متناسب با مورد خود، در اینترنت جستجو کنید.

برای ارائه چند نمونه از راه‌حل‌های بالقوه:

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS arguments-out-of-order / W1114

پیام صادرشده:

Positional arguments appear to be out of order

توضیحات:

زمانی صادر می‌شود که نام‌های آرگومان فراخواننده کاملاً با نام‌های پارامتر در امضای تابع مطابقت دارند اما ترتیبی یکسان ندارند.

کد دارای مشکل:

def function_3_args(first_argument, second_argument, third_argument):
    """Three arguments function"""
    return first_argument, second_argument, third_argument
def args_out_of_order():
    first_argument = 1
    second_argument = 2
    third_argument = 3
    function_3_args(  # [arguments-out-of-order]
        first_argument, third_argument, second_argument
    )

کد صحیح:

def function_3_args(first_argument, second_argument, third_argument):
    """Three arguments function"""
    return first_argument, second_argument, third_argument
def args_out_of_order():
    first_argument = 1
    second_argument = 2
    third_argument = 3
    function_3_args(first_argument, second_argument, third_argument)

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

arguments-renamed / W0237

پیام صادرشده:

%s %s %r method

توضیحات:

زمانی استفاده می‌شود که یک پارامتر متد نامی متفاوت با رابط پیاده‌سازی‌شده یا متد بازنویسی‌شده داشته باشد.

کد دارای مشکل:

class Fruit:
    def brew(self, ingredient_name: str):
        print(f"Brewing a {type(self)} with {ingredient_name}")
class Apple(Fruit): ...
class Orange(Fruit):
    def brew(self, flavor: str):  # [arguments-renamed]
        print(f"Brewing an orange with {flavor}")
for fruit, ingredient_name in [[Orange(), "thyme"], [Apple(), "cinnamon"]]:
    fruit.brew(ingredient_name=ingredient_name)

کد صحیح:

class Fruit:
    def brew(self, ingredient_name: str):
        print(f"Brewing a {type(self)} with {ingredient_name}")
class Apple(Fruit): ...
class Orange(Fruit):
    def brew(self, ingredient_name: str):
        print(f"Brewing an orange with {ingredient_name}")
for fruit, ingredient_name in [[Orange(), "thyme"], [Apple(), "cinnamon"]]:
    fruit.brew(ingredient_name=ingredient_name)

ایجادشده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS assert-on-string-literal / W0129

پیام صادرشده:

دستور assert یک لیترال رشته‌ای را به عنوان نخستین آرگومان خود دارد. این assert به‌صورت %s با شکست مواجه خواهد شد.

توضیحات:

هنگامی استفاده می‌شود که یک دستور assert یک لیترال رشته‌ای را به عنوان نخستین آرگومان خود داشته باشد، که باعث می‌شود assert همیشه برقرار باشد.

کد دارای اشکال:

def test_division():
    a = 9 / 3
    assert "No ZeroDivisionError were raised"  # [assert-on-string-literal]

کد درست:

def test_division():
    a = 9 / 3
    assert a == 3

جزئیات بیشتر:

اعمال مستقیم assert روی یک لیترال رشته‌ای همواره برقرار خواهد بود. راهکار این است که چیزی را بیازمایید که امکان شکست خوردن آن وجود داشته باشد، یا اصلاً از assert استفاده نکنید.

برای assertionهای unittest، پیام مشابه redundant-unittest-assert / W1503 <#redundant-unittest-assert> وجود دارد.

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده‌ی basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py.

assert-on-tuple / W0199

پیام صادرشده:

دستور assert روی یک تاپل غیرخالی فراخوانی شده است. آیا منظورتان 'assert x,y' بود؟

توضیحات:

فراخوانی assert روی یک تاپل، در صورتی که تاپل خالی نباشد همواره به true ارزیابی می‌شود، و اگر خالی باشد همواره به false ارزیابی خواهد شد.

کد دارای اشکال:

assert (1, None)  # [assert-on-tuple]

کد درست:

x, y = (1, None)
assert x
assert y

جزئیات بیشتر:

ایجادشده توسط بررسی‌کننده‌ی basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py..SS attribute-defined-outside-init / W0201

پیام صادرشده:

صفت %r خارج از __init__ تعریف شده است

توضیحات:

زمانی استفاده می‌شود که یک صفت نمونه خارج از متد __init__ تعریف شده باشد.

کد مشکل‌دار:

class Student:
    def register(self):
        self.is_registered = True  # [attribute-defined-outside-init]

کد صحیح:

class Student:
    def __init__(self):
        self.is_registered = False
    def register(self):
        self.is_registered = True

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

bad-builtin / W0141

پیام صادرشده:

از تابع توکار %s استفاده شده است

توضیحات:

زمانی استفاده می‌شود که یک تابع توکار غیرمجاز به کار رفته باشد (گزینهٔ bad-function را ببینید). توابع غیرمجاز معمول مواردی همچون map یا filter هستند که پایتون امروزه جایگزین تمیزتری مانند list comprehension برای آن‌ها ارائه می‌دهد.

کد مشکل‌دار:

numbers = list(map(lambda x: 2 * x, [1, 2, 3]))  # [bad-builtin]
print(numbers)

کد صحیح:

numbers = [2 * x for x in [1, 2, 3]]
print(numbers)

فایل پیکربندی:

[MAIN]
load-plugins = pylint.extensions.bad_builtin

نکته:

ایجادشده توسط بررسی‌کنندهٔ deprecated_builtins https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/bad_builtin.py..SS bad-chained-comparison / W3601

پیام صادرشده:

مقایسه زنجیره‌ای مشکوک %s-بخشی با استفاده از عملگرهای ناسازگار از نظر معنایی (%s)

توضیحات:

زمانی استفاده می‌شود که یک مقایسه زنجیره‌ای وجود دارد که در آن یک عبارت، بخشی از دو مقایسه متعلق به گروه‌های معنایی متفاوت است ("<" معنای یکسانی با "is" ندارد، زنجیره‌سازی آن‌ها در "0 < x is None" احتمالاً یک اشتباه است).

کد مشکل‌دار:

parrot.py:

shop = {
    # animal: (specie, descriptions)
    "parrot": ("Norvegian blue", ("restin'", "remarkable", "beautiful plumage")),
}
if "parrot" in shop is "restin'":  # [bad-chained-comparison]
    print("Hellooooo, Pooolllllyyy ! WAAAAKEEY, WAKKEEEY !")

xor.py:

def xor_check(*, left=None, right=None):
    if left is None != right is None:  # [bad-chained-comparison]
        raise ValueError(
            "Either both left= and right= need to be provided or none should."
        )

کد صحیح:

parrot.py:

shop = {
    # animal: (specie, descriptions)
    "parrot": ("Norvegian blue", ("restin'", "remarkable", "beautiful plumage")),
}
if "parrot" in shop and "restin'" in shop["parrot"][1]:
    print("Hellooooo, Pooolllllyyy ! WAAAAKEEY, WAKKEEEY !")

xor.py:

def xor_check(*, left=None, right=None):
    if (left is None) != (right is None):
        raise ValueError(
            "Either both left= and right= need to be provided or none should."
        )

پیوندهای مرتبط:

ایجاد شده توسط بازبین bad-chained-comparison https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/bad_chained_comparison.py..SS bad-dunder-name / W3201

پیام صادرشده:

نام متد dunder نامعتبر است یا دارای غلط املایی است %s.

توضیحات:

زمانی استفاده می‌شود که یک متد dunder دارای غلط املایی باشد یا با نامی خارج از فهرست از پیش تعریف‌شدهٔ نام‌های dunder تعریف شده باشد.

کد دارای مشکل:

class Apples:
    def _init_(self):  # [bad-dunder-name]
        pass
    def __hello__(self):  # [bad-dunder-name]
        print("hello")

کد صحیح:

class Apples:
    def __init__(self):
        pass
    def hello(self):
        print("hello")

فایل پیکربندی:

[MAIN]
load-plugins=pylint.extensions.dunder

نکته:

ایجاد شده توسط بررسی‌کنندهٔ dunder https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/dunder.py.

bad-format-string / W1302

پیام صادرشده:

رشتهٔ قالب‌بندی نامعتبر

توضیحات:

زمانی استفاده می‌شود که یک رشتهٔ قالب‌بندی PEP 3101 نامعتبر باشد.

کد دارای مشکل:

print("{a[0] + a[1]}".format(a=[0, 1]))  # [bad-format-string]

کد صحیح:

print("{a[0]} + {a[1]}".format(a=[0, 1]))

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کنندهٔ string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py..SS bad-format-string-key / W1300

پیام صادرشده:

کلید دیکشنری رشتهٔ قالب‌بندی باید یک رشته باشد، نه %s

توضیحات:

زمانی استفاده می‌شود که یک رشتهٔ قالب‌بندی با مشخص‌کننده‌های تبدیل نام‌گذاری‌شده، به همراه دیکشنری‌ای به کار رود که همهٔ کلیدهای آن رشته نیستند.

کد دارای مشکل:

print("%(one)d" % {"one": 1, 2: 2})  # [bad-format-string-key]

کد درست:

print("%(one)d, %(two)d" % {"one": 1, "two": 2})

جزئیات بیشتر:

این بررسی تنها برای قالب‌بندی رشته به سبک قدیمی با استفاده از عملگر '%' کار می‌کند.

این بررسی تنها در صورتی کار می‌کند که دیکشنری حاوی مقادیر برای قالب‌بندی به‌صورت درون‌خطی (inline) تعریف شده باشد. ارسال یک متغیر این بررسی را فعال نخواهد کرد، زیرا ممکن است از کلیدهای دیگر در این دیکشنری در زمینه‌های دیگری استفاده شده باشد، در حالی که یک دیکشنری تعریف‌شده به‌صورت درون‌خطی مشخصاً تنها برای نگه‌داشتن مقادیری در نظر گرفته شده است که باید قالب‌بندی شوند.

ایجادشده توسط بررسی‌کنندهٔ string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py.

bad-indentation / W0311

پیام صادرشده:

دندانه‌گذاری نادرست. %s %s یافت شد، مورد انتظار %s

توضیحات:

زمانی استفاده می‌شود که تعداد غیرمنتظره‌ای از فاصله‌ها یا تب‌های دندانه‌گذاری یافت شود.

کد دارای مشکل:

if input():
   print('yes')  # [bad-indentation]

کد درست:

if input():
    print("yes")

جزئیات بیشتر:

از گزینهٔ --indent-string می‌توان برای تنظیم واحد دندانه‌گذاری برای این بررسی استفاده کرد.

ایجادشده توسط بررسی‌کنندهٔ format https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/format.py..SS bad-open-mode / W1501

پیام صادرشده:

"%s" حالت معتبری برای open نیست.

توضیحات:

پایتون از حالت‌های r، w، a[، x] همراه با گزینه‌های b، + و U (تنها با r) پشتیبانی می‌کند. صفحه https://docs.python.org/3/library/functions.html#open را ببینید.

کد دارای مشکل:

def open_and_get_content(file_path):
    with open(file_path, "rwx") as file:  # [bad-open-mode]
        return file.read()

کد درست:

def open_and_get_content(file_path):
    with open(file_path, "r") as file:
        return file.read()

ایجادشده توسط بررسی‌کننده stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py.

bad-staticmethod-argument / W0211

پیام صادرشده:

متد ایستا با %r به‌عنوان نخستین آرگومان

توضیحات:

زمانی استفاده می‌شود که یک متد ایستا دارای "self" یا مقداری مشخص‌شده در گزینه valid-classmethod-first-arg یا گزینه valid-metaclass-classmethod-first-arg به‌عنوان نخستین آرگومان باشد.

کد دارای مشکل:

class Wolf:
    @staticmethod
    def eat(self):  # [bad-staticmethod-argument]
        pass

کد درست:

class Wolf:
    @staticmethod
    def eat(sheep):
        pass

ایجادشده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

bad-thread-instantiation / W1506

پیام صادرشده:

threading.Thread به تابع target نیاز دارد

توضیحات:

این هشدار زمانی صادر می‌شود که از کلاس threading.Thread بدون ارسال تابع target به‌صورت یک kwarg یا به‌عنوان آرگومان دوم نمونه‌سازی شود. به‌طور پیش‌فرض، پارامتر نخست پارامتر group است، نه پارامتر target.

کد دارای مشکل:

import threading
def thread_target(n):
    print(n**2)
thread = threading.Thread(lambda: None)  # [bad-thread-instantiation]
thread.start()

کد درست:

import threading
def thread_target(n):
    print(n**2)
thread = threading.Thread(target=thread_target, args=(10,))
thread.start()

ایجادشده توسط بررسی‌کننده stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py..SS bare-except / W0702

پیام صادرشده:

هیچ نوع استثنایی مشخص نشده است

توضیحات:

یک عبارت ``except:`` خالی، استثناهای ``SystemExit`` و ``KeyboardInterrupt`` را نیز می‌گیرد که این امر متوقف کردن برنامه با ``Control-C`` را دشوارتر ساخته و می‌تواند مشکلات دیگر را پنهان کند. اگر می‌خواهید تمام استثناهایی را بگیرید که نشان‌دهنده خطاهای برنامه هستند، از ``except Exception:`` استفاده کنید (عبارت except خالی معادل ``except BaseException:`` است).

کد دارای مشکل:

try:
    import platform_specific_module
except:  # [bare-except]
    platform_specific_module = None

کد درست:

try:
    import platform_specific_module
except ImportError:
    platform_specific_module = None

جزئیات بیشتر:

یک قاعده سرانگشتی خوب این است که استفاده از عبارت‌های ‘except’ خالی را به دو حالت محدود کنید: - اگر گرداننده استثنا، گزارش ردیابی (traceback) را چاپ یا ثبت (log) کند؛ حداقل کاربر متوجه خواهد شد که خطایی رخ داده است. - اگر کد نیاز به انجام عملیات پاک‌سازی داشته باشد، اما سپس با raise اجازه دهد استثنا به سمت بالا منتشر شود. بلوک try...finally می‌تواند روش بهتری برای مدیریت این حالت باشد.

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py.

binary-op-exception / W0711

پیام صادرشده:

استثنای موردنظر برای گرفتن، نتیجه یک عملیات باینری "%s" است

توضیحات:

زمانی استفاده می‌شود که استثنای موردنظر برای گرفتن به صورت "except A or B:" باشد. اگر قصد گرفتن چند استثنا را دارید، آن را به شکل "except (A, B):" بازنویسی کنید.

کد دارای مشکل:

try:
    1 / 0
except ZeroDivisionError or ValueError:  # [binary-op-exception]
    pass

کد درست:

try:
    1 / 0
except (ZeroDivisionError, ValueError):
    pass

ایجادشده توسط بررسی‌کننده exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py..SS boolean-datetime / W1502

پیام صادرشده:

استفاده از datetime.time در بافت بولی (boolean).

توضیحات:

استفاده از datetime.time در یک بافت بولی می‌تواند باعث پنهان شدن باگ‌های ظریفی شود، به‌ویژه زمانی که زمان مشخص‌شده با نیمه‌شب UTC مطابقت دارد. این رفتار در Python 3.5 اصلاح شد. برای ارجاع، https://bugs.python.org/issue13936 را ببینید.

کد دارای مشکل:

import datetime
if datetime.time():  # [boolean-datetime]
    print("It is time.")
if datetime.datetime.now().time():  # [boolean-datetime]
    print("Now or never.")

کد صحیح:

import datetime
time_now_utc = datetime.datetime.now(tz=datetime.UTC).time()
if time_now_utc > datetime.time(6, 0):
    print("Daytime!")
if time_now_utc < datetime.time(6, 0):
    print("Nighttime!")

فایل پیکربندی:

[main]
py-version=3.4

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کننده stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py.

break-in-finally / W0137

پیام صادرشده:

استفاده از 'break' درون بند 'finally' توصیه نمی‌شود

توضیحات:

زمانی صادر می‌شود که کلیدواژه `break` درون یک بند finally پیدا شود. این مورد از Python 3.14 به بعد یک SyntaxWarning ایجاد خواهد کرد.

کد دارای مشکل:

while True:
    try:
        pass
    finally:
        break  # [break-in-finally]

کد صحیح:

while True:
    try:
        pass
    except ValueError:
        pass
    else:
        break

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py..SS broad-exception-caught / W0718

پیام صادرشده:

گرفتن استثنای بیش از حد عمومی %s

توضیحات:

اگر از یک عبارت ساده‌ی ``except Exception:`` استفاده کنید، ممکن است در نهایت استثناهایی غیر از مواردی که انتظار دارید را بگیرید. این کار می‌تواند با پنهان کردن خطاهای نامرتبط، اشکال‌ها (باگ‌ها) را مخفی کرده و عیب‌یابی برنامه‌ها را دشوارتر کند.

کد دارای مشکل:

try:
    import platform_specific_module
except Exception:  # [broad-exception-caught]
    platform_specific_module = None

کد درست:

try:
    import platform_specific_module
except ImportError:
    platform_specific_module = None

جزئیات بیشتر:

برای نمونه، اگر در حال تلاش برای وارد کردن یک کتابخانه با وابستگی‌های سیستمی موردنیاز باشید و به‌جای خطاهای واردسازی تنها، همه‌چیز را بگیرید، پیام خطایی را که می‌گوید کد شما در صورت نصب وابستگی‌های سیستمی می‌توانست اجرا شود، از دست خواهید داد.

پیوندهای مرتبط:

ایجادشده توسط ارزیاب exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py.

broad-exception-raised / W0719

پیام صادرشده:

پرتاب استثنای بیش از حد عمومی: %s

توضیحات:

پرتاب استثناهایی که بیش از حد کلی هستند شما را مجبور می‌کند که استثناها را نیز به‌صورت کلی بگیرید. این امر شما را وادار به استفاده از یک عبارت ساده‌ی ``except Exception:`` خواهد کرد. سپس ممکن است در نهایت استثناهایی به‌جز موارد مورد انتظار را بگیرید. این وضعیت می‌تواند خطاها را پنهان کرده و هنگام پنهان ماندن خطاهای غیرمرتبط، عیب‌یابی برنامه‌ها را سخت‌تر کند.

کد دارای مشکل:

def small_apple(apple, length):
    if len(apple) < length:
        raise Exception("Apple is too small!")  # [broad-exception-raised]
    print(f"{apple} is proper size.")

کد درست:

def small_apple(apple, length):
    if len(apple) < length:
        raise ValueError("Apple is too small!")
    print(f"{apple} is proper size.")

پیوندهای مرتبط:

ایجادشده توسط ارزیاب exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py..SS cell-var-from-loop / W0640

پیام صادرشده:

متغیر سلولی %s در حلقه تعریف شده است

توضیحات:

متغیری که در یک بستار (closure) به کار رفته، درون یک حلقه تعریف شده است. این امر باعث می‌شود که تمام بستارها از همان مقدار یکسان برای متغیر محصورشده (closed-over) استفاده کنند.

کد دارای مشکل:

def teacher_greeting(names):
    greetings = []
    for name in names:
        def greet():
            # do something
            print(f"Hello, {name}!")  # [cell-var-from-loop]
        if name.isalpha():
            greetings.append(greet)
    for greet in greetings:
        # the "name" variable is evaluated when the function is called here,
        # which is the last value it had in the loop - "Not-A-Name"
        greet()
teacher_greeting(["Graham", "John", "Terry", "Eric", "Terry", "Michael"])
# "Hello, Michael!"
# "Hello, Michael!"
# "Hello, Michael!"
# "Hello, Michael!"
# "Hello, Michael!"

کد صحیح:

functools.partial.py:

import functools
def teacher_greeting(names):
    greetings = []
    for name in names:
        if name.isalpha():
            # "name" is evaluated when the partial is created here, so this
            # does not do lazy evaluation
            greetings.append(functools.partial(print, f"Hello, {name}!"))
    for greet in greetings:
        # `partial`s are called like functions, but you've already passed the
        # arguments to them
        greet()
teacher_greeting(["Graham", "John", "Terry", "Eric", "Terry", "Michael"])
# "Hello, Graham!"
# "Hello, John!"
# "Hello, Eric!"
# "Hello, Terry!"
# "Hello, Michael!"

new_function.py:

def teacher_greeting(names):
    def greet(name):
        # do something
        print(f"Hello, {name}!")
    for name in names:
        if name.isalpha():
            # we're passing the value of "name" to the function here
            greet(name)
teacher_greeting(["Graham", "John", "Terry", "Eric", "Terry", "Michael"])
# "Hello, Graham!"
# "Hello, John!"
# "Hello, Eric!"
# "Hello, Terry!"
# "Hello, Michael!"

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py..SS comparison-with-callable / W0143

پیام صادرشده:

مقایسه با یک callable، آیا پرانتزها را از قلم انداخته‌اید؟

توضیحات:

این پیام زمانی صادر می‌شود که pylint تشخیص دهد مقایسه‌ای با یک شیء قابل فراخوانی (callable) انجام شده است؛ امری که ممکن است نشان‌دهنده از قلم افتادن پرانتزها و در نتیجه بروز رفتار ناخواسته باشد.

کد دارای مشکل:

def function_returning_a_fruit() -> str:
    return "orange"
def is_an_orange(fruit: str = "apple"):
    # apple == <function function_returning_a_fruit at 0x7f343ff0a1f0>
    return fruit == function_returning_a_fruit  # [comparison-with-callable]

کد درست:

def function_returning_a_fruit() -> str:
    return "orange"
def is_an_orange(fruit: str = "apple"):
    # apple == orange
    return fruit == function_returning_a_fruit()

ایجاد شده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/comparison_checker.py.

confusing-with-statement / W0124

پیام صادرشده:

آمدن یک مدیر زمینه (context manager) دیگر پس از "as" شبیه یک تاپل به نظر می‌رسد.

توضیحات:

زمانی صادر می‌شود که یکی از بخش‌های دستور `with` چندین مقدار بازگرداند و انتساب نام با `as` را تنها برای بخشی از آن مقادیر به کار ببرد، مانند with ctx() as a, b. این وضعیت می‌تواند گمراه‌کننده باشد، زیرا مشخص نیست که آیا مدیر زمینه یک تاپل برمی‌گرداند یا آن گره فاقد انتساب نام، خود یک مدیر زمینه دیگر است.

کد دارای مشکل:

with open("file.txt", "w") as fh1, fh2:  # [confusing-with-statement]
    pass

کد درست:

with open("file.txt", "w", encoding="utf8") as fh1:
    with open("file.txt", "w", encoding="utf8") as fh2:
        pass

ایجاد شده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py..SS consider-ternary-expression / W0160

پیام صادرشده:

بازنویسی به‌صورت یک عبارت سه‌تایی را مد نظر قرار دهید

توضیحات:

چندین دستور انتساب که در بلوک‌های if/else پخش شده‌اند را می‌توان با یک انتساب واحد و یک عبارت سه‌تایی (ternary expression) بازنویسی کرد

کد دارای مشکل:

x, y = input(), input()
if x >= y:  # [consider-ternary-expression]
    maximum = x
else:
    maximum = y

کد درست:

x, y = input(), input()
maximum = x if x >= y else y

فایل پیکربندی:

[MAIN]
load-plugins=pylint.extensions.consider_ternary_expression

نکته:

ایجادشده توسط بررسی‌کنندهٔ consider_ternary_expression https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/consider_ternary_expression.py.

contextmanager-generator-missing-cleanup / W0135

پیام صادرشده:

از زمینهٔ استفاده‌شده در تابع %r خارج نخواهد شد.

توضیحات:

هنگامی استفاده می‌شود که یک contextmanager درون یک تابع مولد (generator function) استفاده شده باشد و پاک‌سازی مدیریت نشده باشد.

کد دارای مشکل:

import contextlib
@contextlib.contextmanager
def cm():
    contextvar = "acquired context"
    print("cm enter")
    yield contextvar
    print("cm exit")
def genfunc_with_cm():
    with cm() as context:  # [contextmanager-generator-missing-cleanup]
        yield context * 2

کد درست:

import contextlib
@contextlib.contextmanager
def good_cm_except():
    contextvar = "acquired context"
    print("good cm enter")
    try:
        yield contextvar
    except GeneratorExit:
        print("good cm exit")
def genfunc_with_cm():
    with good_cm_except() as context:
        yield context * 2
def genfunc_with_discard():
    with good_cm_except():
        yield "discarded"
@contextlib.contextmanager
def good_cm_yield_none():
    print("good cm enter")
    yield
    print("good cm exit")
def genfunc_with_none_yield():
    with good_cm_yield_none() as var:
        print(var)
        yield "constant yield"
@contextlib.contextmanager
def good_cm_finally():
    contextvar = "acquired context"
    print("good cm enter")
    try:
        yield contextvar
    finally:
        print("good cm exit")
def good_cm_finally_genfunc():
    with good_cm_finally() as context:
        yield context * 2
@contextlib.contextmanager
def good_cm_no_cleanup():
    contextvar = "acquired context"
    print("cm enter")
    yield contextvar
def good_cm_no_cleanup_genfunc():
    with good_cm_no_cleanup() as context:
        yield context * 2

جزئیات بیشتر:

نمونه‌سازی و استفاده از یک contextmanager در داخل یک تابع مولد (generator function) در صورتی که این انتظار وجود داشته باشد که زمینه (context) فقط برای تابع مولد در دسترس باشد، می‌تواند به رفتارهای غیرمنتظره منجر شود. در صورتی که مولد بسته یا تخریب نشود، مدیر زمینه به همان صورت معلق باقی می‌ماند.

این پیام به‌جای تابع contextmanager به تابع مولد هشدار می‌دهد، زیرا روش‌های استفاده از یک contextmanager بسیار متنوع است. یک contextmanager می‌تواند به‌عنوان یک دکوراتور استفاده شود (که بلافاصله متدهای __enter__/__exit__ روی آن اعمال می‌شوند) و استفاده از as ... یا دور انداختن مقدار بازگشتی نیز بیانگر این است که آیا زمینه به پاک‌سازی نیاز دارد یا خیر. بنابراین برای این پیام، هشدار دادن به فراخوانندهٔ contextmanager اهمیت دارد.

این بررسی در صورتی که دستور yield درون یک بلوک if-else بدون پاک‌سازی سفارشی استفاده شود، می‌تواند موارد مثبت کاذب (false positive) ایجاد کند. برای این موارد از pylint: disable استفاده کنید.

from contextlib import contextmanager
@contextmanager
def good_cm_no_cleanup():
    contextvar = "acquired context"
    print("cm enter")
    if some_condition:
        yield contextvar
    else:
        yield contextvar
def good_cm_no_cleanup_genfunc():
    # pylint: disable-next=contextmanager-generator-missing-cleanup
    with good_cm_no_cleanup() as context:
        yield context * 2

continue-in-finally / W0136

پیام صادرشده:

استفاده از 'continue' در بند 'finally' توصیه نمی‌شود

توضیحات:

هنگامی صادر می‌شود که کلیدواژه `continue` درون یک بند finally یافت شود. این مورد از Python 3.14 به بعد، یک SyntaxWarning ایجاد خواهد کرد.

کد مشکل‌دار:

while True:
    try:
        pass
    finally:
        continue  # [continue-in-finally]

کد درست:

while True:
    try:
        pass
    except ValueError:
        pass
    else:
        continue

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_error_checker.py.

dangerous-default-value / W0102

پیام صادرشده:

مقدار پیش‌فرض خطرناک %s به عنوان آرگومان

توضیحات:

زمانی استفاده می‌شود که یک مقدار تغییرپذیر مانند لیست یا دیکشنری در مقدار پیش‌فرض یک آرگومان شناسایی شود.

کد مشکل‌دار:

def whats_on_the_telly(penguin=[]):  # [dangerous-default-value]
    penguin.append("property of the zoo")
    return penguin

کد درست:

def whats_on_the_telly(penguin=None):
    if penguin is None:
        penguin = []
    penguin.append("property of the zoo")
    return penguin

جزئیات بیشتر:

با یک مقدار پیش‌فرض تغییرپذیر، با هر بار فراخوانی مقدار پیش‌فرض تغییر می‌یابد، یعنی:

whats_on_the_telly() # ["property of the zoo"]
whats_on_the_telly() # ["property of the zoo", "property of the zoo"]
whats_on_the_telly() # ["property of the zoo", "property of the zoo", "property of the zoo"]

ایجاد شده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py..SS deprecated-argument / W4903

پیام صادرشده:

استفاده از آرگومان منسوخ‌شده %s در متد %s()

توضیحات:

این آرگومان به‌عنوان منسوخ‌شده علامت‌گذاری شده است و در آینده حذف خواهد شد.

کد دارای مشکل:

int(x=1)  # [deprecated-argument]

کد درست:

int(1)

فایل پیکربندی:

جزئیات بیشتر:

جایگزین واقعی باید به‌صورت موردی و با مطالعهٔ هشدار منسوخ‌شدن یا یادداشت‌های انتشار بررسی شود.

ایجادشده توسط بررسی‌کنندهٔ stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py.

deprecated-attribute / W4906

پیام صادرشده:

استفاده از صفت منسوخ‌شده %r

توضیحات:

این صفت به‌عنوان منسوخ‌شده علامت‌گذاری شده است و در آینده حذف خواهد شد.

کد دارای مشکل:

from configparser import ParsingError
err = ParsingError("filename")
source = err.filename  # [deprecated-attribute]

کد درست:

from configparser import ParsingError
err = ParsingError("filename")
source = err.source

جزئیات بیشتر:

جایگزین واقعی باید به‌صورت موردی و با مطالعهٔ هشدار منسوخ‌شدن یا یادداشت‌های انتشار بررسی شود.

ایجادشده توسط بررسی‌کنندهٔ stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py..SS deprecated-class / W4904

پیام صادرشده:

استفاده از کلاس منسوخ‌شدهٔ %s از ماژول %s

توضیحات:

این کلاس به عنوان منسوخ‌شده علامت‌گذاری شده است و در آینده حذف خواهد شد.

کد دارای مشکل:

from collections import Iterable  # [deprecated-class]

کد درست:

from collections.abc import Iterable

جزئیات بیشتر:

جایگزین مناسب باید به صورت موردی و با مطالعهٔ هشدار منسوخ‌شدن یا یادداشت‌های انتشار بررسی شود.

ایجاد شده توسط بررسی‌کنندهٔ stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py.

deprecated-decorator / W4905

پیام صادرشده:

استفاده از دکوراتور منسوخ‌شدهٔ %s()

توضیحات:

این دکوراتور به عنوان منسوخ‌شده علامت‌گذاری شده است و در آینده حذف خواهد شد.

کد دارای مشکل:

import abc
class Animal:
    @abc.abstractclassmethod  # [deprecated-decorator]
    def breath(cls):
        pass

کد درست:

import abc
class Animal:
    @abc.classmethod
    @abc.abstractmethod
    def breath(cls):
        pass

فایل پیکربندی:

[main]
py-version = 3.3

جزئیات بیشتر:

جایگزین مناسب باید به صورت موردی و با مطالعهٔ هشدار منسوخ‌شدن یا یادداشت‌های انتشار بررسی شود.

ایجاد شده توسط بررسی‌کنندهٔ stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py..SS deprecated-method / W4902

پیام صادرشده:

استفاده از متد منسوخ‌شده %s()

توضیحات:

این متد به عنوان منسوخ‌شده علامت‌گذاری شده است و در آینده حذف خواهد شد.

کد دارای مشکل:

import logging
logging.warn("I'm coming, world !")  # [deprecated-method]

کد صحیح:

import logging
logging.warning("I'm coming, world !")

جزئیات تکمیلی:

جایگزین واقعی باید به‌صورت موردی و با خواندن هشدار منسوخ‌شدن یا یادداشت‌های انتشار بررسی شود.

ایجادشده توسط بررسی‌کننده stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py.

deprecated-module / W4901

پیام صادرشده:

ماژول منسوخ‌شده %r

توضیحات:

ماژولی که به عنوان منسوخ‌شده علامت‌گذاری شده است، درون‌ریزی شده است.

کد دارای مشکل:

import distutils  # [deprecated-module]
import whatever_you_want  # [deprecated-module]

کد صحیح:

import setuptools
import whatever_replacement_you_want

فایل پیکربندی:

[main]
py-version=3.7
deprecated-modules=whatever_you_want

جزئیات تکمیلی:

جایگزین واقعی باید به‌صورت موردی و با خواندن هشدار منسوخ‌شدن یا یادداشت‌های انتشار بررسی شود.

ایجادشده توسط بررسی‌کننده imports https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/imports.py..SS deprecated-typing-alias / W6001

پیام صادرشده:

'%s' منسوخ شده است، به جای آن از '%s' استفاده کنید

توضیحات:

هنگامی صادر می‌شود که از یک نام مستعار منسوخ‌شده برای typing استفاده شود.

کد دارای مشکل:

import typing
item_to_number_of_item: typing.Dict[str, int]  # [deprecated-typing-alias]

کد درست:

item_to_number_of_item: dict[str, int]

فایل پیکربندی:

[main]
load-plugins = pylint.extensions.typing

نکته:

ایجادشده توسط بررسی‌کننده typing https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/typing.py.

differing-param-doc / W9017

پیام صادرشده:

مغایرت "%s" در مستندسازی پارامتر

توضیحات:

لطفاً نام‌های پارامتر را در اعلان‌ها بررسی کنید.

کد دارای مشکل:

def add(x, y):  # [differing-param-doc]
    """Add two numbers.
    :param int x: x value.
    :param int z: z value.
    """
    return x + y

کد درست:

def add(x, y):
    """Add two numbers.
    :param int x: x value.
    :param int y: y value.
    """
    return x + y

فایل پیکربندی:

[MAIN]
load-plugins = pylint.extensions.docparams

نکته:

ایجادشده توسط بررسی‌کننده parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py..SS differing-type-doc / W9018

پیام صادرشده:

تفاوت "%s" در مستندسازی نوع پارامتر

توضیحات:

لطفاً نام پارامترها را در اعلان‌های نوع بررسی کنید.

کد دارای مشکل:

def add(x: int, y: int):  # [differing-type-doc]
    """Add two numbers.
    :param int xy: x value.
    :param str y: y value.
    """
    return x + y

کد صحیح:

def add(x, y):
    """Add two numbers.
    :param int x: x value.
    :param int y: y value.
    """
    return x + y

فایل پیکربندی:

[MAIN]
load-plugins = pylint.extensions.docparams

نکته:

ایجادشده توسط بررسی‌کنندهٔ parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py.

duplicate-except / W0705

پیام صادرشده:

گرفتن نوع استثنای %s که پیش‌تر گرفته شده است

توضیحات:

هنگامی استفاده می‌شود که یک except نوعی را دریافت کند که پیش‌تر توسط یک گردانندهٔ قبلی گرفته شده است.

کد دارای مشکل:

try:
    1 / 0
except ZeroDivisionError:
    pass
except ZeroDivisionError:  # [duplicate-except]
    pass

کد صحیح:

try:
    1 / 0
except ZeroDivisionError:
    pass

ایجادشده توسط بررسی‌کنندهٔ exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py..SS duplicate-key / W0109

پیام صادرشده:

کلید تکراری %r در دیکشنری

توضیحات:

هنگامی استفاده می‌شود که یک عبارت دیکشنری، یک کلید یکسان را چندین بار مقید کند.

کد مشکل‌دار:

test_score = {"Mathematics": 85, "Biology": 90, "Mathematics": 75}  # [duplicate-key]

کد درست:

test_score = {"Mathematics": 85, "Biology": 90, "History": 75}

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py.

duplicate-string-formatting-argument / W1308

پیام صادرشده:

آرگومان تکراری قالب‌بندی رشته %r، ارسال به عنوان آرگومان نام‌دار را مد نظر قرار دهید

توضیحات:

هنگامی استفاده می‌شود که تشخیص دهیم در یک قالب‌بندی رشته، به‌جای استفاده از آرگومان‌های نام‌دار رشته، یک آرگومان تکرار شده است

کد مشکل‌دار:

# pylint: disable=missing-docstring, consider-using-f-string
SEE = "see 👀"
SEA = "sea 🌊"
# +1: [duplicate-string-formatting-argument,duplicate-string-formatting-argument]
CONST = """
A sailor went to {}, {}, {}
To {} what he could {}, {}, {}
But all that he could {}, {}, {}
Was the bottom of the deep blue {}, {}, {}!
""".format(
    SEA,
    SEA,
    SEA,
    SEE,
    SEE,
    SEE,
    SEE,
    SEE,
    SEE,
    SEE,
    SEA,
    SEA,
    SEA,
)

کد درست:

# pylint: disable=missing-docstring, consider-using-f-string
SEE = "see 👀"
SEA = "sea 🌊"
CONST = """
A sailor went to {sea}, {sea}, {sea}
To {see} what he could {see}, {see}, {see}
But all that he could {see}, {see}, {see}
Was the bottom of the deep blue {sea}, {sea}, {sea}!
""".format(
    sea=SEA, see=SEE
)

ایجادشده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py..SS duplicate-value / W0130

پیام صادرشده:

مقدار تکراری %r در مجموعه

توضیحات:

این پیام زمانی صادر می‌شود که یک مجموعه دارای مقداری یکسان، دو بار یا بیشتر باشد.

کد دارای مشکل:

incorrect_set = {"value1", 23, 5, "value1"}  # [duplicate-value]

کد صحیح:

correct_set = {"value1", 23, 5}

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py.

eq-without-hash / W1641

پیام صادرشده:

پیاده‌سازی __eq__ بدون پیاده‌سازی هم‌زمان __hash__

توضیحات:

زمانی استفاده می‌شود که یک کلاس __eq__ را پیاده‌سازی کند اما __hash__ را خیر. در صورتی که اشیاء __eq__ را پیاده‌سازی کنند، مقدار پیش‌فرض پیاده‌سازی __hash__ آن‌ها برابر با None قرار می‌گیرد.

کد دارای مشکل:

class Fruit:  # [eq-without-hash]
    def __init__(self) -> None:
        self.name = "apple"
    def __eq__(self, other: object) -> bool:
        return isinstance(other, Fruit) and other.name == self.name

کد صحیح:

class Fruit:
    def __init__(self) -> None:
        self.name = "apple"
    def __eq__(self, other: object) -> bool:
        return isinstance(other, Fruit) and other.name == self.name
    def __hash__(self) -> int:
        return hash(self.name)

فایل پیکربندی:

[MAIN]
load-plugins=pylint.extensions.eq_without_hash,

نکته:

ایجادشده توسط بررسی‌کننده eq-without-hash https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/eq_without_hash.py..SS eval-used / W0123

پیام صادرشده:

Use of eval

توضیحات:

هنگامی که از تابع "eval" استفاده می‌شود، برای جلوگیری از به‌کارگیری آن صادر می‌شود. برای ارزیابی امن رشته‌های حاوی عبارات پایتون از منابع غیرقابل‌اعتماد، استفاده از `ast.literal_eval` را مد نظر قرار دهید.

کد دارای مشکل:

eval("[1, 2, 3]")  # [eval-used]

کد صحیح:

from ast import literal_eval
literal_eval("[1, 2, 3]")

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py.

exec-used / W0122

پیام صادرشده:

Use of exec

توضیحات:

هنگامی که دستور 'exec' به کار می‌رود صادر می‌شود. استفاده از این تابع برای ورودی‌های کاربر خطرناک است و به‌طور کلی نیز از کد واقعی کُندتر عمل می‌کند. این بدان معنا نیست که هرگز نباید از آن استفاده کنید، بلکه باید ابتدا راهکارهای جایگزین را بررسی کرده و توابع در دسترس را محدود نمایید.

کد دارای مشکل:

username = "Ada"
code_to_execute = f"""input('Enter code to be executed please, {username}: ')"""
program = exec(code_to_execute)  # [exec-used]
exec(program)  # [exec-used]

کد صحیح:

def get_user_code(name):
    return input(f"Enter code to be executed please, {name}: ")
username = "Ada"
# If the globals dictionary does not contain a value for the key __builtins__,
# all builtins are allowed. You need to be explicit about it being disallowed.
allowed_globals = {"__builtins__": {}}
allowed_locals = {}
# pylint: disable-next=exec-used
exec(get_user_code(username), allowed_globals, allowed_locals)

جزئیات بیشتر:

متدها و متغیرهای دردسترسِ استفاده‌شده در exec() ممکن است یک رخنهٔ امنیتی ایجاد کنند. می‌توانید با ارسال پارامترهای اختیاریِ globals و locals (دیکشنری‌ها) به متد exec()، استفاده از این متغیرها و متدها را محدود کنید.

با این حال، در صورتی که توابعی مانند __import__ یا open مجاز باشند، استفاده از exec() همچنان ناامن است. برای نمونه، فراخوانی زیر را در نظر بگیرید که فایلی را روی سیستم کاربر می‌نویسد و سپس کدی را اجرا می‌کند که توسط پارامترهای allowed_globals یا allowed_locals مهار نشده است:

import textwrap
def forbid_print(*args):
    raise ValueError("This is raised when a print is used")
allowed_globals = {
    "__builtins__": {
        "__import__": __builtins__.__import__,
        "open": __builtins__.open,
        "print": forbid_print,
    }
}
exec(
    textwrap.dedent(
        """
    import textwrap
    with open("nefarious.py", "w") as f:
        f.write(textwrap.dedent('''
            def connive():
                print("Here's some code as nefarious as imaginable")
        '''))
    import nefarious
    nefarious.connive()  # This will NOT raise a ValueError
    """
    ),
    allowed_globals,
)

در این حالت، import صرفاً برای خوانایی مثال به کار رفته است اما می‌تواند توابع خطرناکی را وارد کند:

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py..SS expression-not-assigned / W0106

پیام صادرشده:

عبارت "%s" به هیچ چیزی انتساب نیافته است

توضیحات:

زمانی استفاده می‌شود که عبارتی که فراخوانی تابع نیست، به هیچ چیزی تخصیص داده نشده باشد. احتمالاً منظور چیز دیگری بوده است.

کد دارای مشکل:

str(42) == "42"  # [expression-not-assigned]

کد درست:

are_equal: bool = str(42) == "42"

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py.

f-string-without-interpolation / W1309

پیام صادرشده:

استفاده از یک f-string که فاقد هرگونه متغیر درون‌یابی‌شده است

توضیحات:

هنگامی استفاده می‌شود که یک f-string بدون هیچ متغیر درون‌یابی‌شده‌ای شناسایی شود، که در این صورت می‌تواند یک رشتهٔ عادی یا یک اشکال در کد باشد.

کد دارای مشکل:

x = 1
y = 2
print(f"x + y = x + y")  # [f-string-without-interpolation]

کد درست:

x = 1
y = 2
print(f"{x} + {y} = {x + y}")

ایجادشده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py.

fixme / W0511

پیام صادرشده:

%s

توضیحات:

هنگامی استفاده می‌شود که یادداشت هشداری مانند FIXME یا XXX شناسایی شود.

کد دارای مشکل:

# TODO: We should fix this at some point  # [fixme]

کد درست:

bug_tracker.py:

# The issue was added to the bug tracker: no longer need the comment

fixed.py:

# The issue was fixed: no longer need the comment

no_fix.py:

# We no longer want to fix this: no longer need the comment

جزئیات بیشتر:

می‌توانید از عبارت‌های باقاعده و گزینهٔ notes-rgx برای ایجاد محدودیت‌هایی برای این پیام استفاده کنید. برای مشاهدهٔ چند مثال، موضوع https://github.com/pylint-dev/pylint/issues/2874 را ببینید.

ایجادشده توسط بررسی‌کننده miscellaneous https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/misc.py..SS forgotten-debug-statement / W1515

پیام صادرشده:

باقی گذاشتن توابعی که نقطه توقف ایجاد می‌کنند در کد عملیاتی توصیه نمی‌شود

توضیحات:

فراخوانی‌های breakpoint()، sys.breakpointhook() و pdb.set_trace() باید از کدی که فعالانه اشکال‌زدایی نمی‌شود حذف شوند.

کد دارای مشکل:

import pdb
def find_the_treasure(clues):
    for clue in clues:
        pdb.set_trace()  # [forgotten-debug-statement]
        if "treasure" in clue:
            return True
    return False
treasure_hunt = [
    "Dead Man's Chest",
    "X marks the spot",
    "The treasure is buried near the palm tree",
]
find_the_treasure(treasure_hunt)

کد صحیح:

def find_the_treasure(clues):
    for clue in clues:
        if "treasure" in clue:
            return True
    return False
treasure_hunt = [
    "Dead Man's Chest",
    "X marks the spot",
    "The treasure is buried near the palm tree",
]
find_the_treasure(treasure_hunt)

ایجاد شده توسط بررسی‌کننده stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py.

format-combined-specification / W1305

پیام صادرشده:

رشته قالب‌بندی شامل هر دو حالت شماره‌گذاری خودکار فیلدها و تعیین دستی فیلد است

توضیحات:

هنگامی استفاده می‌شود که یک رشته قالب‌بندی بر اساس PEP 3101 هم شامل شماره‌گذاری خودکار فیلد (مانند '{}') و هم تعیین دستی فیلد (مانند '{0}') باشد.

کد دارای مشکل:

print("{} {1}".format("hello", "world"))  # [format-combined-specification]

کد صحیح:

index_formatting.py:

print("{0} {1}".format("hello", "world"))

order_formatting.py:

print("{} {}".format("hello", "world"))

ایجاد شده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py..SS format-string-without-interpolation / W1310

پیام صادرشده:

استفاده از قالب‌بندی برای رشته‌ای که فاقد هرگونه متغیر درون‌یابی‌شده است

توضیحات:

هنگامی استفاده می‌شود که رشته‌ای فاقد هرگونه متغیر درون‌یابی شناسایی شود؛ در این صورت می‌تواند یک رشته معمولی بدون قالب‌بندی یا یک باگ در کد باشد.

کد دارای ایراد:

print("number".format(1))  # [format-string-without-interpolation]

کد صحیح:

print("number: {}".format(1))

ایجادشده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py.

global-at-module-level / W0604

پیام صادرشده:

استفاده از دستور global در سطح ماژول

توضیحات:

هنگامی استفاده می‌شود که از دستور "global" در سطح ماژول استفاده کنید، زیرا این کار هیچ تأثیری ندارد.

کد دارای ایراد:

price = 25
global price  # [global-at-module-level]

کد صحیح:

price = 25

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py.

global-statement / W0603

پیام صادرشده:

استفاده از دستور global

توضیحات:

هنگامی استفاده می‌شود که از دستور "global" برای به‌روزرسانی یک متغیر سراسری استفاده کنید. Pylint استفاده از آن را توصیه نمی‌کند. البته این بدان معنا نیست که نمی‌توانید از آن استفاده کنید!

کد دارای ایراد:

var = 1
def foo():
    global var  # [global-statement]
    var = 10
    print(var)
foo()
print(var)

کد صحیح:

var = 1
def foo():
    print(var)
    return 10
var = foo()
print(var)

ایجادشده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py..SS global-variable-not-assigned / W0602

پیام صادرشده:

استفاده از global برای %r اما هیچ انتسابی انجام نشده است

توضیحات:

هنگامی که متغیری تعریف‌شده در دامنه سراسری در یک دامنه درونی تغییر داده می‌شود، کلمه کلیدی 'global' در دامنه درونی تنها در صورتی مورد نیاز است که عملیات انتساب در آن دامنه درونی انجام شده باشد.

کد مشکل‌دار:

TOMATO = "black cherry"
def update_tomato():
    global TOMATO  # [global-variable-not-assigned]
    print(TOMATO)

کد صحیح:

TOMATO = "black cherry"
def update_tomato():
    global TOMATO
    TOMATO = "moneymaker"

ایجادشده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py.

global-variable-undefined / W0601

پیام صادرشده:

متغیر سراسری %r در سطح ماژول تعریف نشده است

توضیحات:

زمانی استفاده می‌شود که متغیری از طریق دستور "global" تعریف شده باشد اما متغیر در دامنه ماژول تعریف نشده باشد.

کد مشکل‌دار:

def update_tomato():
    global TOMATO  # [global-variable-undefined]
    TOMATO = "moneymaker"

کد صحیح:

TOMATO = "black cherry"
def update_tomato():
    global TOMATO
    TOMATO = "moneymaker"

ایجادشده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py..SS implicit-flag-alias / W0213

پیام صادرشده:

عضو پرچم %(overlap)s جایگاه‌های بیتی مشترکی با %(sources)s دارد

توضیحات:

زمانی استفاده می‌شود که چندین مقدار عدد صحیحِ تعریف‌شده درون یک کلاس enum.IntFlag دارای یک موقعیت بیتی مشترک باشند.

کد دارای مشکل:

from enum import IntFlag
class FilePermissions(IntFlag):
    READ = 1
    WRITE = 2
    EXECUTE = 3  # [implicit-flag-alias]

کد درست:

from enum import IntFlag
class FilePermissions(IntFlag):
    READ = 1
    WRITE = 2
    EXECUTE = 4

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

implicit-str-concat / W1404

پیام صادرشده:

الحاق ضمنی رشته در %s یافت شد

توضیحات:

لیترال‌های رشته‌ای به‌طور ضمنی در تعریف لیترال یک پیمایش‌پذیر الحاق شده‌اند: شاید یک ویرگول جا افتاده است؟

کد دارای مشکل:

list.py:

x = ["a" "b"]  # [implicit-str-concat]

open.py:

with open("hello.txt" "r") as f:  # [implicit-str-concat]
    print(f.read())

کد درست:

list.py:

x = ["a", "b"]

open.py:

with open("hello.txt", "r") as f:
    print(f.read())

جزئیات بیشتر:

به‌طور پیش‌فرض، تشخیص الحاق ضمنی رشته در شکست خطوط غیرفعال است. بنابراین کد زیر این قاعده را فعال نخواهد کرد:

SEQ = ('a', 'b'
            'c')

به‌منظور تشخیص این حالت، باید check-str-concat-over-line-jumps را فعال کنید:

[STRING_CONSTANT]
check-str-concat-over-line-jumps = true

با این حال، ایراد این تنظیم این است که برای پارامترهای رشته‌ای که در چند سطر در فراخوانی توابع ارسال می‌شوند، مثبت کاذب ایجاد خواهد کرد:

warnings.warn(
    "rotate() is deprecated and will be removed in a future release. "
    "Use the rotation() context manager instead.",
    DeprecationWarning,
    stacklevel=3,
)

اگر الحاق مورد نظر را با پرانتز مشخص کنید، هیچ پیامی صادر نخواهد شد:

warnings.warn(
    (
        "rotate() is deprecated and will be removed in a future release. "
        "Use the rotation() context manager instead."
    ),
    DeprecationWarning,
    stacklevel=3,
)

ایجادشده توسط بررسی‌کنندهٔ string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py..SS import-self / W0406

پیام صادرشده:

ماژول خود را وارد (import) می‌کند

توضیحات:

زمانی استفاده می‌شود که یک ماژول خود را import می‌کند.

جزئیات بیشتر:

فرض کنید فایلی به نام my_file.py دارید. خطای import-self در کد زیر صادر خواهد شد:

from my_file import a_function  # [import-self]
def a_function():
    pass

راهکار این است که import حذف شود:

def a_function():
    pass

ایجادشده توسط بررسی‌کننده imports https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/imports.py.

inconsistent-quotes / W1405

پیام صادرشده:

جداکننده نقل‌قول %s با سایر بخش‌های فایل ناسازگار است

توضیحات:

جداکننده‌های نقل‌قول در سرتاسر یک ماژول به‌طور یکدست استفاده نشده‌اند (با در نظر گرفتن مواردی جهت جلوگیری از escape کردن‌های غیرضروری).

کد دارای اشکال:

import datetime
print('Current year: ', datetime.date.today().strftime("%Y")) # [inconsistent-quotes]

کد صحیح:

import datetime
print("Current year: ", datetime.date.today().strftime("%Y"))

فایل پیکربندی:

[main]
check-quote-consistency=yes

ایجادشده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py..SS invalid-envvar-default / W1508

پیام صادرشده:

نوع پیش‌فرض %s برابر %s است. str یا None مورد انتظار بود.

توضیحات:

توابع دستکاری متغیرهای محیطی مقادیر None یا str را بازمی‌گردانند. ارسال هر مقداری به جز این‌ها به عنوان پیش‌فرض ممکن است باعث بروز باگ شود. ببینید: https://docs.python.org/3/library/os.html#os.getenv.

کد مشکل‌دار:

import os
env = os.getenv("SECRET_KEY", 1)  # [invalid-envvar-default]

کد صحیح:

import os
env = os.getenv("SECRET_KEY", "1")

ایجادشده توسط بررسی‌کننده stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py.

invalid-format-index / W1307

پیام صادرشده:

استفاده از کلید جستجوی نامعتبر %r در مشخص‌کننده قالب %r

توضیحات:

هنگامی استفاده می‌شود که یک رشته قالب‌بندی PEP 3101 از یک مشخص‌کننده جستجو ({a[1]}) استفاده کند، اما آرگومان ارسال‌شده برای قالب‌بندی فاقد آن کلید باشد یا آن کلید را به عنوان یک صفت نداشته باشد.

کد مشکل‌دار:

not_enough_fruits = ["apple"]
print('The second fruit is a {fruits[1]}'.format(fruits=not_enough_fruits))  # [invalid-format-index]

کد صحیح:

enough_fruits = ["apple", "banana"]
print("The second fruit is a {fruits[1]}".format(fruits=enough_fruits))

ایجادشده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py.

invalid-overridden-method / W0236

پیام صادرشده:

انتظار می‌رفت متد %r به صورت %r باشد، اما در عوض %r یافت شد

توضیحات:

هنگامی استفاده می‌شود که تشخیص داده شود یک متد به شیوه‌ای بازنویسی شده است که با کلاس پایه خود همخوانی ندارد، که می‌تواند منجر به باگ‌های بالقوه در زمان اجرا شود.

کد مشکل‌دار:

class Fruit:
    async def bore(self, insect):
        insect.eat(self)
class Apple(Fruit):
    def bore(self, insect):  # [invalid-overridden-method]
        insect.eat(self)

کد صحیح:

class Fruit:
    async def bore(self, insect):
        insect.eat(self)
class Apple(Fruit):
    async def bore(self, insect):
        insect.eat(self)

ایجادشده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS isinstance-second-argument-not-valid-type / W1116

پیام صادرشده:

آرگومان دوم isinstance یک نوع نیست

توضیحات:

هنگامی صادر می‌شود که آرگومان دوم یک فراخوانی isinstance یک نوع (type) نباشد.

کد دارای مشکل:

isinstance("apples and oranges", hex)  # [isinstance-second-argument-not-valid-type]

کد درست:

isinstance("apples and oranges", str)

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

keyword-arg-before-vararg / W1113

پیام صادرشده:

آرگومان کلیدواژه‌ای پیش از فهرست آرگومان‌های مکانی متغیر در تعریف تابع %s

توضیحات:

هنگام تعریف یک آرگومان کلیدواژه‌ای پیش از آرگومان‌های مکانی متغیر، در صورتی که تابع یا متد با آرگومان‌های کلیدواژه‌ای فراخوانی شود، ممکن است چندین مقدار برای پارامتر مذکور ارسال شود.

کد دارای مشکل:

def func(x=None, *args):  # [keyword-arg-before-vararg]
    return [x, *args]

کد درست:

def func(*args, x=None):
    return [*args, x]

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

kwarg-superseded-by-positional-arg / W1117

پیام صادرشده:

مقدار %r در %r گنجانده خواهد شد، زیرا پارامتری فقط-مکانی با همین نام از قبل وجود دارد

توضیحات:

هنگامی صادر می‌شود که تابعی با یک آرگومان کلیدواژه‌ای هم‌نام با یک پارامتر فقط-مکانی فراخوانی شود و تابع دارای یک دیکشنری از پارامترهای متغیر کلیدواژه‌ای باشد.

کد دارای مشکل:

def print_name(name="Sarah", /, **kwds):
    print(name)
print_name(name="Jacob")  # [kwarg-superseded-by-positional-arg]
# Will print "Sarah"

کد درست:

def print_name(name="Sarah", /, **kwds):
    print(name)
print_name("Jacob")
# Will print "Jacob"

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py..SS logging-format-interpolation / W1202

پیام صادرشده:

از قالب‌بندی %s در توابع logging استفاده کنید

توضیحات:

زمانی استفاده می‌شود که یک عبارت logging به شکل فراخوانی "logging.<logging method>(format_string.format(format_args...))" باشد. به‌جای آن از نوع دیگری از قالب‌بندی رشته استفاده کنید. می‌توانید از قالب‌بندی % استفاده کنید اما با ارسال پارامترها به‌عنوان آرگومان، درون‌یابی را به تابع logging واگذار نمایید. اگر logging-fstring-interpolation غیرفعال باشد، می‌توانید از قالب‌بندی fstring استفاده کنید. اگر logging-not-lazy غیرفعال باشد، می‌توانید طبق روال معمول از قالب‌بندی % استفاده کنید.

کد دارای مشکل:

import logging
import sys
# +1: [logging-format-interpolation]
logging.error("Python version: {}".format(sys.version))

کد درست:

import logging
import sys
logging.error("Python version: %s", sys.version)

جزئیات بیشتر:

یک گزینهٔ معقول دیگر استفاده از f-string است. اگر قصد انجام این کار را دارید، باید logging-format-interpolation را فعال و logging-fstring-interpolation را غیرفعال کنید.

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ logging https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/logging.py.

logging-fstring-interpolation / W1203

پیام صادرشده:

از قالب‌بندی %s در توابع logging استفاده کنید

توضیحات:

زمانی استفاده می‌شود که یک عبارت logging به شکل فراخوانی "logging.<logging method>(f"...")" باشد. به‌جای آن از نوع دیگری از قالب‌بندی رشته استفاده کنید. می‌توانید از قالب‌بندی % استفاده کنید اما با ارسال پارامترها به‌عنوان آرگومان، درون‌یابی را به تابع logging واگذار نمایید. اگر logging-format-interpolation غیرفعال باشد، می‌توانید از str.format استفاده کنید. اگر logging-not-lazy غیرفعال باشد، می‌توانید طبق روال معمول از قالب‌بندی % استفاده کنید.

کد دارای مشکل:

import logging
import sys
logging.error(f"Python version: {sys.version}")  # [logging-fstring-interpolation]

کد درست:

import logging
import sys
logging.error("Python version: %s", sys.version)

جزئیات بیشتر:

این پیام امکان مجاز دانستن f-string در logging را فراهم می‌کند در حالی که همچنان در صورت وقوع logging-format-interpolation هشدار می‌دهد.

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ logging https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/logging.py..SS logging-not-lazy / W1201

پیام صادرشده:

از قالب‌بندی %s در توابع logging استفاده کنید

توضیحات:

زمانی استفاده می‌شود که یک عبارت logging فراخوانی‌ای به شکل "logging.<logging method>(format_string % (format_args...))" داشته باشد. به‌جای آن از نوع دیگری از قالب‌بندی رشته استفاده کنید. می‌توانید از قالب‌بندی % استفاده کنید اما با ارسال پارامترها به‌عنوان آرگومان، درون‌یابی (interpolation) را به تابع logging بسپارید. اگر logging-fstring-interpolation غیرفعال باشد می‌توانید از قالب‌بندی fstring استفاده کنید. اگر logging-format-interpolation غیرفعال باشد می‌توانید از str.format استفاده کنید.

کد دارای اشکال:

import logging
try:
    function()
except Exception as e:
    logging.error("Error occurred: %s" % e)  # [logging-not-lazy]
    raise

کد درست:

import logging
try:
    function()
except Exception as e:
    logging.error("Error occurred: %s", e)
    raise

جزئیات بیشتر:

گزینهٔ معقول دیگر استفاده از f-string است. اگر قصد انجام این کار را دارید، باید logging-not-lazy را فعال و logging-fstring-interpolation را غیرفعال کنید.

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ logging https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/logging.py.

lost-exception / W0150

پیام صادرشده:

دستور %s در بلوک finally ممکن است استثنا را ببلعد

توضیحات:

زمانی استفاده می‌شود که یک دستور break یا return درون بند finally از یک بلوک try...finally یافت شود: استثناهای رخ‌داده در بند try به‌جای برانگیخته شدن مجدد (re-raised)، در سکوت بلعیده و نادیده گرفته خواهند شد.

کد دارای اشکال:

class FasterThanTheSpeedOfLightError(ZeroDivisionError):
    def __init__(self):
        super().__init__("You can't go faster than the speed of light !")
def calculate_speed(distance: float, time: float) -> float:
    try:
        return distance / time
    except ZeroDivisionError as e:
        raise FasterThanTheSpeedOfLightError() from e
    finally:
        return 299792458  # [lost-exception]

کد درست:

class FasterThanTheSpeedOfLightError(ZeroDivisionError):
    def __init__(self):
        super().__init__("You can't go faster than the speed of light !")
def calculate_speed(distance: float, time: float) -> float:
    try:
        return distance / time
    except ZeroDivisionError as e:
        raise FasterThanTheSpeedOfLightError() from e

ایجادشده توسط بررسی‌کنندهٔ basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py..SS method-cache-max-size-none / W1518

پیام صادرشده:

عبارت 'lru_cache(maxsize=None)' یا 'cache' تمام آرگومان‌های متد، از جمله 'self' را تا ابد زنده نگه می‌دارد

توضیحات:

با استفاده از دکوراتور lru_cache یا cache روی یک متد، آرگومان 'self' به تابع پیوند خورده و در نتیجه هرگز زباله‌روبی (garbage collected) نخواهد شد. مگر اینکه نمونه شیء شما هرگز نیازی به بازیافت حافظه نداشته باشد (تک‌نمونه یا singleton)، توصیه می‌شود کد را بازنویسی کرده تا از این الگو پرهیز شود یا یک maxsize به حافظه پنهان (cache) بیفزایید. مقدار پیش‌فرض برای maxsize برابر 128 است.

کد دارای مشکل:

import functools
class Fibonnaci:
    def __init__(self):
        self.result = []
    @functools.lru_cache(maxsize=None)  # [method-cache-max-size-none]
    def fibonacci(self, n):
        if n in {0, 1}:
            self.result.append(n)
        self.result.append(self.fibonacci(n - 1) + self.fibonacci(n - 2))

کد صحیح:

import functools
@functools.cache
def cached_fibonacci(n):
    if n in {0, 1}:
        return n
    return cached_fibonacci(n - 1) + cached_fibonacci(n - 2)
class Fibonnaci:
    def __init__(self):
        self.result = []
    def fibonacci(self, n):
        self.result.append(cached_fibonacci(n))

ایجاد شده توسط بررسی‌کننده stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py.

misplaced-future / W0410

پیام صادرشده:

واردسازی __future__ نخستین عبارت غیر docstring نیست

توضیحات:

پایتون 2.5 و بالاتر نیازمند این است که واردسازی __future__ نخستین دستور غیر docstring در ماژول باشد.

کد دارای مشکل:

import sys
from __future__ import print_function  # [misplaced-future]

کد صحیح:

from __future__ import print_function
import sys

جزئیات بیشتر:

یک عبارت raise خالی آخرین استثنای فعال در حوزه (scope) جاری را مجدداً برمی‌انگیزد (re-raise). اگر دستور raise درون یک بلوک except یا finally نباشد، به‌جای آن یک RuntimeError صادر خواهد شد.

ایجاد شده توسط بررسی‌کننده imports https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/imports.py..SS missing-any-param-doc / W9021

پیام صادرشده:

نبود هرگونه مستندات در "%s"

توضیحات:

لطفاً مستندات پارامتر و/یا نوع را اضافه کنید.

کد دارای مشکل:

def puppies(head, tail):  # [missing-any-param-doc]
    """Print puppy's details."""
    print(head, tail)

کد درست:

def puppies(head: str, tail: str):
    """Print puppy's details.
    :param head: description of the head of the dog
    :param tail: description of the tail of the dog
    """
    print(head, tail)

فایل پیکربندی:

[main]
load-plugins = pylint.extensions.docparams
accept-no-param-doc = false

نکته:

ایجادشده توسط بررسی‌کننده parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py.

missing-format-argument-key / W1303

پیام صادرشده:

نبود آرگومان کلیدواژه‌ای %r برای رشته قالب‌بندی

توضیحات:

زمانی استفاده می‌شود که یک رشته قالب‌بندی PEP 3101 که از فیلدهای نام‌گذاری‌شده استفاده می‌کند، یک یا چند کلیدواژه لازم را دریافت نکند.

کد دارای مشکل:

print("My name is {first} {last}".format(first="John"))  # [missing-format-argument-key]

کد درست:

print("My name is {first} {last}".format(first="John", last="Wick"))

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py..SS missing-format-attribute / W1306

پیام صادرشده:

ویژگی قالب‌بندی %r در مشخص‌کننده قالب %r وجود ندارد

توضیحات:

زمانی استفاده می‌شود که یک رشته قالب‌بندی PEP 3101 از یک مشخص‌کننده ویژگی ({0.length}) استفاده کند، اما آرگومان ارسال‌شده برای قالب‌بندی فاقد آن ویژگی باشد.

کد دارای مشکل:

print("{0.real}".format("1"))  # [missing-format-attribute]

کد صحیح:

print("{0.real}".format(1))

ایجادشده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py.

missing-param-doc / W9015

پیام صادرشده:

"%s" در مستندات پارامتر وجود ندارد

توضیحات:

لطفاً اعلان پارامترها را برای همه پارامترها اضافه کنید.

کد دارای مشکل:

def integer_sum(a: int, b):  # [missing-param-doc]
    """Returns sum of two integers
    :param a: first integer
    """
    return a + b

کد صحیح:

def integer_sum(a: int, b: int):
    """Returns sum of two integers
    :param a: first integer
    :param b: second integer
    """
    return a + b

فایل پیکربندی:

[MAIN]
load-plugins = pylint.extensions.docparams

نکته:

ایجادشده توسط بررسی‌کننده parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py..SS missing-parentheses-for-call-in-test / W0126

پیام صادرشده:

استفاده از یک عبارت شرطی با فراخوانی احتمالاً اشتباه تابع یا متد به دلیل نبود پرانتز

توضیحات:

زمانی صادر می‌شود که به نظر برسد یک عبارت شرطی (If یا if سه‌تایی) به دلیل نبود پرانتز تابعی را به اشتباه فراخوانی می‌کند

کد دارای مشکل:

import random
def is_it_a_good_day():
    return random.choice([True, False])
if is_it_a_good_day:  # [missing-parentheses-for-call-in-test]
    print("Today is a good day!")

کد صحیح:

import random
def is_it_a_good_day():
    return random.choice([True, False])
if is_it_a_good_day():
    print("Today is a good day!")

ایجاد شده توسط بررسی‌کنندهٔ basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py.

missing-raises-doc / W9006

پیام صادرشده:

"%s" به عنوان پرتاب‌شده مستند نشده است

توضیحات:

لطفاً استثناها را برای تمام انواع استثناهای پرتاب‌شده مستندسازی کنید.

کد دارای مشکل:

def integer_sum(a: int, b: int):  # [missing-raises-doc]
    """Returns sum of two integers
    :param a: first integer
    :param b: second integer
    """
    if not (isinstance(a, int) and isinstance(b, int)):
        raise ValueError("Function supports only integer parameters.")
    return a + b

کد صحیح:

def integer_sum(a: int, b: int):
    """Returns sum of two integers
    :param a: first integer
    :param b: second integer
    :raises ValueError: One of the parameters is not an integer.
    """
    if not (isinstance(a, int) and isinstance(b, int)):
        raise ValueError("Function supports only integer parameters.")
    return a + b

فایل پیکربندی:

[MAIN]
load-plugins = pylint.extensions.docparams
[BASIC]
accept-no-raise-doc = no

نکته:

ایجاد شده توسط بررسی‌کنندهٔ parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py..SS missing-return-doc / W9011

پیام صادرشده:

Missing return documentation (مستندات مقدار بازگشتی وجود ندارد)

توضیحات:

لطفاً مستنداتی دربارهٔ آنچه این متد بازمی‌گرداند اضافه کنید.

کد دارای مشکل:

def integer_sum(a: int, b: int):  # [missing-return-doc]
    """Returns sum of two integers
    :param a: first integer
    :param b: second integer
    """
    return a + b

کد درست:

def integer_sum(a: int, b: int) -> int:
    """Returns sum of two integers
    :param a: first integer
    :param b: second integer
    :return: sum of parameters a and b
    """
    return a + b

فایل پیکربندی:

[main]
load-plugins=pylint.extensions.docparams
[Parameter_documentation]
accept-no-return-doc=no

جزئیات بیشتر:

این پیام تنها زمانی صادر می‌شود که پارامتر accept-no-return-doc روی no تنظیم شده باشد.

نکته:

ایجادشده توسط بررسی‌کنندهٔ parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py.

missing-return-type-doc / W9012

پیام صادرشده:

Missing return type documentation (مستندات نوع مقدار بازگشتی وجود ندارد)

توضیحات:

لطفاً نوع مقدار بازگشتی این متد را مستند کنید.

کد دارای مشکل:

def integer_sum(a: int, b: int):  # [missing-return-type-doc]
    """Returns sum of two integers
    :param a: first integer
    :param b: second integer
    :return: sum of parameters a and b
    """
    return a + b

کد درست:

def integer_sum(a: int, b: int) -> int:
    """Returns sum of two integers
    :param a: first integer
    :param b: second integer
    :return: sum of parameters a and b
    """
    return a + b

فایل پیکربندی:

[main]
load-plugins=pylint.extensions.docparams
[Parameter_documentation]
accept-no-return-doc=no

جزئیات بیشتر:

این پیام تنها زمانی صادر می‌شود که پارامتر accept-no-return-doc روی no تنظیم شده باشد.

نکته:

ایجادشده توسط بررسی‌کنندهٔ parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py..SS missing-timeout / W3101

پیام صادرشده:

نبود آرگومان timeout برای متد '%s' می‌تواند باعث قفل شدن نامحدود برنامه شما شود

توضیحات:

زمانی استفاده می‌شود که یک متد برای جلوگیری از انتظار طولانی‌مدت به پارامتر 'timeout' نیاز دارد. اگر هیچ مهلت زمانی به‌طور صریح مشخص نشود، مقدار پیش‌فرض استفاده خواهد شد. به عنوان مثال برای 'requests'، برنامه هرگز با اتمام مهلت زمانی مواجه نمی‌شود (یعنی به‌طور نامحدود قفل می‌کند).

کد دارای مشکل:

import requests
requests.post("http://localhost")  # [missing-timeout]

کد صحیح:

import requests
requests.post("http://localhost", timeout=10)

جزئیات بیشتر:

می‌توانید متدهای جدیدی را که باید دارای یک آرگومان تعریف‌شدهٔ `timeout باشند، به‌صورت نام‌های واجد شرایط (qualified names) در گزینهٔ timeout-methods اضافه کنید؛ به عنوان مثال:

ایجاد شده توسط بازرس method_args https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/method_args.py.

missing-type-doc / W9016

پیام صادرشده:

"%s" در مستندات نوع پارامتر وجود ندارد

توضیحات:

لطفاً تعریف نوع پارامتر را برای همهٔ پارامترها اضافه کنید.

کد دارای مشکل:

def integer_sum(a: int, b):  # [missing-type-doc]
    """Returns sum of two integers
    :param a: first integer
    :param b: second integer
    """
    return a + b

کد صحیح:

def integer_sum(a: int, b: int):
    """Returns sum of two integers
    :param a: first integer
    :param b: second integer
    """
    return a + b

فایل پیکربندی:

[MAIN]
load-plugins = pylint.extensions.docparams

نکته:

ایجاد شده توسط بازرس parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py..SS missing-yield-doc / W9013

پیام صادرشده:

مستندات yield وجود ندارد

توضیحات:

لطفاً مستنداتی درباره آنچه این مولد (generator) با yield تولید می‌کند اضافه کنید.

کد دارای اشکال:

def even_number_under(n: int):  # [missing-yield-doc]
    """Prints even numbers smaller than n.
    Args:
        n: Upper limit of even numbers.
    """
    for i in range(n):
        if i % 2 == 1:
            continue
        yield i

کد اصلاح‌شده:

from typing import Iterator
def even_number_under(n: int) -> Iterator[int]:
    """Prints even numbers smaller than n.
    Args:
        n: Upper limit of even numbers.
    Yields:
        even numbers
    """
    for i in range(n):
        if i % 2 == 1:
            continue
        yield i

فایل پیکربندی:

[main]
load-plugins=pylint.extensions.docparams
[Parameter_documentation]
accept-no-yields-doc=no

جزئیات تکمیلی:

این پیام تنها زمانی ایجاد می‌شود که پارامتر accept-no-yields-doc روی no تنظیم شده باشد.

نکته:

ایجاد شده توسط بررسی‌کننده parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py..SS missing-yield-type-doc / W9014

پیام صادرشده:

مستندات نوع yield موجود نیست (Missing yield type documentation)

توضیحات:

لطفاً نوع بازگردانده‌شده توسط این متد با yield را مستندسازی کنید.

کد دارای مشکل:

def even_number_under(n: int):  # [missing-yield-type-doc]
    """Prints even numbers smaller than n.
    Args:
        n: Upper limit of even numbers.
    Yields:
        even numbers
    """
    for i in range(n):
        if i % 2 == 1:
            continue
        yield i

کد صحیح:

from typing import Iterator
def even_number_under(n: int) -> Iterator[int]:
    """Prints even numbers smaller than n.
    Args:
        n: Upper limit of even numbers.
    Yields:
        even numbers
    """
    for i in range(n):
        if i % 2 == 1:
            continue
        yield i

فایل پیکربندی:

[main]
load-plugins=pylint.extensions.docparams
[Parameter_documentation]
accept-no-yields-doc=no

جزئیات تکمیلی:

این پیام تنها زمانی صادر می‌شود که پارامتر accept-no-yields-doc بر روی no تنظیم شده باشد.

نکته:

ایجادشده توسط بررسی‌کننده parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py..SS modified-iterating-list / W4701

پیام صادرشده:

لیست در حال پیمایش '%s' درون بدنه حلقه for در حال تغییر است، در عوض پیمایش روی یک کپی از آن را در نظر بگیرید.

توضیحات:

زمانی صادر می‌شود که مواردی به لیستی که در حال پیمایش است افزوده یا از آن حذف شوند. انجام این کار می‌تواند منجر به رفتاری غیرمنتظره شود، به همین دلیل ترجیح داده می‌شود که از یک کپی از لیست استفاده شود.

کد دارای مشکل:

fruits = ["apple", "orange", "mango"]
for fruit in fruits:
    fruits.append("pineapple")  # [modified-iterating-list]

کد درست:

fruits = ["apple", "orange", "mango"]
for fruit in fruits.copy():
    fruits.append("pineapple")

ایجادشده توسط بررسی‌کننده modified_iteration https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/modified_iterating_checker.py.

multiple-constructor-doc / W9005

پیام صادرشده:

"%s" پارامترهای سازنده را در کلاس و __init__ مستند کرده است

توضیحات:

لطفاً اعلان‌های پارامتر را در کلاس یا سازنده حذف کنید.

کد دارای مشکل:

class Point:  # [multiple-constructor-doc]
    """Represents a point in the xy-coordinate plane.
    :param x: coordinate
    :param y: coordinate
    """
    def __init__(self, x, y):
        """Represents a point in the xy-coordinate plane.
        :param x: coordinate
        :param y: coordinate
        """
        self.x = x
        self.y = y

کد درست:

class Point:
    def __init__(self, x, y):
        """Represents a point in the xy-coordinate plane.
        :param x: x coordinate
        :param y: y coordinate
        """
        self.x = x
        self.y = y

فایل پیکربندی:

[main]
load-plugins=pylint.extensions.docparams
[Parameter_documentation]
no-docstring-rgx=^(?!__init__$)_

جزئیات بیشتر:

هر دو docstring قابل قبول هستند اما نه هر دو به‌طور هم‌زمان.

نکته:

ایجادشده توسط بررسی‌کننده parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py..SS named-expr-without-context / W0131

پیام صادرشده:

عبارت نام‌گذاری‌شده بدون زمینه به کار رفته است

توضیحات:

زمانی صادر می‌شود که یک عبارت نام‌گذاری‌شده برای انجام انتساب عادی، بیرون از زمینه‌هایی مانند if، for، while یا یک comprehension به کار رود.

کد دارای اشکال:

(a := 42)  # [named-expr-without-context]

کد درست:

if a := 42:
    print("Success")

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py.

nan-comparison / W0177

پیام صادرشده:

مقایسه %s باید %s باشد

توضیحات:

زمانی استفاده می‌شود که یک عبارت با مقادیر NaN مانند numpy.NaN و float('nan') مقایسه شود.

کد دارای اشکال:

import numpy as np
def both_nan(x, y) -> bool:
    return x == np.NaN and y == float("nan")  # [nan-comparison, nan-comparison]

کد درست:

import numpy as np
def both_nan(x, y) -> bool:
    return np.isnan(x) and np.isnan(y)

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/comparison_checker.py.

nested-min-max / W3301

پیام صادرشده:

از فراخوانی تو در توی '%s' استفاده نکنید؛ امکان استفاده از '%s' به‌جای آن وجود دارد

توضیحات:

فراخوانی‌های تو در تو مانند ``min(1, min(2, 3))`` را می‌توان به‌صورت ``min(1, 2, 3)`` بازنویسی کرد.

کد دارای اشکال:

print(min(1, min(2, 3)))  # [nested-min-max]

کد درست:

print(min(1, 2, 3))

ایجادشده توسط بررسی‌کننده nested_min_max https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/nested_min_max.py..SS non-ascii-file-name / W2402

پیام صادرشده:

نام %s "%s" شامل یک نویسه غیر ASCII است.

توضیحات:

در نسخه‌های پیش از Python 3.5، استاندارد PEP 3131 شناسه‌های غیر ASCII را مجاز می‌دانست، اما نام‌های فایل غیر ASCII را خیر. از Python 3.5 به بعد، با وجود اینکه Python از فایل‌های UTF-8 پشتیبانی می‌کند، برخی از ویرایشگرها یا ابزارها از آن پشتیبانی نمی‌کنند.

کد دارای مشکل:

bàd.py:

# [non-ascii-file-name]

not_bétter.py:

# [non-ascii-file-name]

کد درست:

__init__.py:

bad.py:

not_better.py:

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ nonascii-checker https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/non_ascii_names.py.

non-parent-init-called / W0233

پیام صادرشده:

متد __init__ از یک کلاس پایه غیرمستقیم %r فراخوانی شده است

توضیحات:

زمانی استفاده می‌شود که یک متد __init__ روی کلاسی فراخوانی شود که در میان نیاکان مستقیم کلاس تحلیل‌شده قرار ندارد.

کد دارای مشکل:

class Animal:
    def __init__(self):
        self.is_multicellular = True
class Vertebrate(Animal):
    def __init__(self):
        super().__init__()
        self.has_vertebrae = True
class Cat(Vertebrate):
    def __init__(self):
        Animal.__init__(self)  # [non-parent-init-called]
        self.is_adorable = True

کد درست:

class Animal:
    def __init__(self):
        self.is_multicellular = True
class Vertebrate(Animal):
    def __init__(self):
        super().__init__()
        self.has_vertebrae = True
class Cat(Vertebrate):
    def __init__(self):
        super().__init__()
        self.is_adorable = True

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS non-str-assignment-to-dunder-name / W1115

پیام صادرشده:

مقدار غیررشته‌ای به __name__ انتساب داده شده است

توضیحات:

هنگامی صادر می‌شود که یک مقدار غیررشته‌ای به __name__ اختصاص یابد

کد دارای مشکل:

class Fruit:
    pass
Fruit.__name__ = 1  # [non-str-assignment-to-dunder-name]

کد درست:

class Fruit:
    pass
Fruit.__name__ = "FRUIT"

ایجادشده توسط بررسی‌کننده typecheck https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/typecheck.py.

overlapping-except / W0714

پیام صادرشده:

استثناهای دارای هم‌پوشانی (%s)

توضیحات:

زمانی استفاده می‌شود که استثناها در مدیریت‌کننده (handler) هم‌پوشانی داشته یا یکسان باشند

کد دارای مشکل:

def divide_x_by_y(x: float, y: float):
    try:
        print(x / y)
    except (ArithmeticError, FloatingPointError) as e:  # [overlapping-except]
        print(f"There was an issue: {e}")

کد درست:

less_generic_first.py:

def divide_x_by_y(x: float, y: float):
    try:
        print(x / y)
    except FloatingPointError as e:
        print(f"There was a FloatingPointError: {e}")
    except ArithmeticError as e:
        # FloatingPointError  were already caught at this point
        print(f"There was an OverflowError or a ZeroDivisionError: {e}")

only_generic.py:

def divide_x_by_y(x: float, y: float):
    try:
        print(x / y)
    except ArithmeticError as e:
        print(
            f"There was an OverflowError, a ZeroDivisionError or a FloatingPointError: {e}"
        )

فایل پیکربندی:

[MAIN]
load-plugins=pylint.extensions.overlapping_exceptions,

پیوندهای مرتبط:

نکته:

ایجادشده توسط بررسی‌کننده overlap-except https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/overlapping_exceptions.py..SS overridden-final-method / W0239

پیام صادرشده:

متد %r متدی را که با typing.final تزیین شده و در کلاس %r تعریف شده است، بازنویسی می‌کند

توضیحات:

زمانی استفاده می‌شود که یک متد تزیین‌شده با typing.final بازنویسی شده باشد.

کد دارای مشکل:

from typing import final
class Animal:
    @final
    def can_breathe(self):
        return True
class Cat(Animal):
    def can_breathe(self):  # [overridden-final-method]
        pass

کد درست:

from typing import final
class Animal:
    @final
    def can_breathe(self):
        return True
class Cat(Animal):
    def can_purr(self):
        return True

فایل پیکربندی:

[MAIN]
py-version=3.8

جزئیات تکمیلی:

این پیام هنگام استفاده از Python < 3.8 صادر نمی‌شود.

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py.

pointless-exception-statement / W0133

پیام صادرشده:

دستور استثنا هیچ اثری ندارد

توضیحات:

زمانی استفاده می‌شود که یک استثنا ایجاد شده باشد بدون آنکه انتساب یابد، صادر (raise) شود یا برای استفاده‌های بعدی در جای دیگری بازگردانده شود.

کد دارای مشکل:

Exception("This exception is a statement.")  # [pointless-exception-statement]

کد درست:

raise Exception("This will raise.")

ایجاد شده توسط بررسی‌کنندهٔ basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py..SS pointless-statement / W0104

پیام صادرشده:

به‌نظر می‌رسد دستور هیچ تأثیری ندارد

توضیحات:

زمانی استفاده می‌شود که یک دستور هیچ تأثیری نداشته باشد (یا دست‌کم این‌طور به‌نظر برسد).

کد دارای مشکل:

[1, 2, 3]  # [pointless-statement]

کد درست:

NUMBERS = [1, 2, 3]
print(NUMBERS)

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py.

pointless-string-statement / W0105

پیام صادرشده:

دستور رشته‌ای هیچ تأثیری ندارد

توضیحات:

زمانی استفاده می‌شود که یک رشته به‌عنوان یک دستور استفاده شود (که البته هیچ تأثیری ندارد). این یک حالت خاص از W0104 با پیام مختص به خود است تا اگر از این رشته‌ها به‌جای کامنت‌ها برای مستندسازی استفاده می‌کنید، بتوانید به‌سادگی آن را غیرفعال کنید.

کد دارای مشکل:

"""This is a docstring which describes the module"""
"""This is not a docstring"""  # [pointless-string-statement]

کد درست:

"""This is a docstring which describes the module"""
# This is comment which describes a particular part of the module.

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py.

possibly-unused-variable / W0641

پیام صادرشده:

احتمالاً متغیر %r استفاده نشده است

توضیحات:

زمانی استفاده می‌شود که یک متغیر تعریف شده باشد اما ممکن است استفاده نشود. این احتمال از این واقعیت ناشی می‌شود که ممکن است locals() استفاده شده باشد، که می‌تواند متغیر مذکور را مصرف کند یا نکند.

کد دارای مشکل:

def choose_fruits(fruits):
    print(fruits)
    color = "red"  # [possibly-unused-variable]
    return locals()

کد درست:

def choose_fruits(fruits):
    current_locals = locals()
    print(fruits)
    color = "red"
    print(color)
    return current_locals

ایجادشده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py..SS preferred-module / W0407

پیام صادرشده:

وارد کردن %r به جای %r ترجیح داده می‌شود

توضیحات:

زمانی استفاده می‌شود که یک ماژول واردشده، ماژول جایگزین ترجیحی داشته باشد.

کد دارای اشکال:

import urllib  # [preferred-module]

کد صحیح:

import requests

فایل پیکربندی:

[IMPORTS]
preferred-modules=urllib:requests,

ایجادشده توسط بررسی‌کننده imports https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/imports.py.

protected-access / W0212

پیام صادرشده:

دسترسی به عضو محافظت‌شده %s از یک کلاس کلاینت

توضیحات:

زمانی استفاده می‌شود که به یک عضو محافظت‌شده (یعنی عضوی از کلاس با نامی که با یک زیرخط آغاز می‌شود) در خارج از کلاس یا نوادگان کلاسی که در آن تعریف شده است، دسترسی پیدا شود.

کد دارای اشکال:

class Worm:
    def __swallow(self):
        pass
jim = Worm()
jim.__swallow()  # [protected-access]

کد صحیح:

class Worm:
    def __swallow(self):
        pass
    def eat(self):
        return self.__swallow()
jim = Worm()
jim.eat()

ایجادشده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS raise-missing-from / W0707

پیام صادرشده:

طرح مجدد صریح با استفاده از %s'%s from %s' را مد نظر قرار دهید

توضیحات:

زنجیره‌سازی استثناها در پایتون، هم گزارش ردیابی (traceback) استثنای فعلی و هم استثنای اصلی را نشان می‌دهد. هنگامی که پس از گرفتن یک استثنا، استثنای جدیدی را raise می‌کنید، احتمال دارد استثنای دوم یک بسته‌بندی مجددِ کاربرپسند از استثنای نخست باشد. در چنین مواردی، `raise from` پیوند بهتری میان دو traceback در خطای نهایی ایجاد می‌کند.

کد دارای اشکال:

try:
    1 / 0
except ZeroDivisionError as e:
    raise ValueError("Rectangle Area cannot be zero")  # [raise-missing-from]

کد درست:

try:
    1 / 0
except ZeroDivisionError as e:
    raise ValueError("Rectangle Area cannot be zero") from e

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py.

raising-format-tuple / W0715

پیام صادرشده:

آرگومان‌های استثنا نشان می‌دهند که احتمالاً قالب‌بندی رشته مد نظر بوده است

توضیحات:

هنگامی استفاده می‌شود که چندین آرگومان به سازندهٔ یک استثنا ارسال شود و اولین آرگومان، یک لیترال رشته‌ای حاوی مواردی باشد که به نظر می‌رسد جای‌نگه‌دارهایی برای قالب‌بندی باشند

کد دارای اشکال:

raise RuntimeError("This looks wrong %s %s", ("a", "b"))  # [raising-format-tuple]

کد درست:

raise RuntimeError("This looks wrong %s %s" % ("a", "b"))

ایجادشده توسط بررسی‌کننده exceptions https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/exceptions.py.

redeclared-assigned-name / W0128

پیام صادرشده:

اعلان مجدد متغیر %r در انتساب

توضیحات:

زمانی صادر می‌شود که تشخیص داده شود یک متغیر در همان انتساب دوباره اعلان شده است.

کد دارای اشکال:

FIRST, FIRST = (1, 2)  # [redeclared-assigned-name]

کد درست:

FIRST, SECOND = (1, 2)

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py..SS redefined-builtin / W0622

پیام صادرشده:

بازتعریف شناسهٔ توکار %r

توضیحات:

هنگامی استفاده می‌شود که یک متغیر یا تابع، یک شناسهٔ توکار را بازنویسی کند.

کد دارای مشکل:

def map():  # [redefined-builtin]
    pass

کد صحیح:

def map_iterable():
    pass

جزئیات بیشتر:

گزینهٔ allowed-redefined-builtins <#variables-options> به شما امکان می‌دهد نام‌هایی را مشخص کنید که مجاز به پوشاندن شناسه‌های توکار هستند.

با این حال، این گزینه برای بازتعریف‌ها در سطح ماژول یا متغیرهای سراسری مؤثر نیست. برای مثال:

بازتعریف‌ها در سطح ماژول:

# module_level_redefine.py
id = 1  # Shadows the built-in `id`

بازتعریف‌های متغیرهای سراسری:

# global_variable_redefine.py
def my_func():
    global len
    len = 1  # Shadows the built-in `len`

دلیل:

پوشاندن شناسه‌های توکار در حوزهٔ سراسری توصیه نمی‌شود، زیرا رفتار آن‌ها را در سراسر ماژول مبهم می‌سازد و خطر بروز باگ‌های ظریف را هنگامی که در جای دیگری از ماژول به آن شناسه نیاز باشد، افزایش می‌دهد. در مقابل، بازتعریف‌های محلی قابل‌قبول هستند چرا که تأثیر آن‌ها به یک حوزهٔ مشخص محدود می‌شود، عوارض جانبی ناخواسته را کاهش می‌دهد و اشکال‌زدایی را ساده‌تر می‌کند.

ایجادشده توسط بررسی‌کنندهٔ variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py.

redefined-loop-name / W2901

پیام صادرشده:

بازتعریف %r از حلقه (خط %s)

توضیحات:

هنگامی استفاده می‌شود که متغیر حلقه در بدنهٔ حلقه بازنویسی شود.

کد دارای مشکل:

def normalize_names(names):
    for name in names:
        name = name.lower()  # [redefined-loop-name]

کد صحیح:

def normalize_names(names):
    for name in names:
        lowercased_name = name.lower()

فایل پیکربندی:

[MAIN]
load-plugins=pylint.extensions.redefined_loop_name,

نکته:

ایجادشده توسط بررسی‌کنندهٔ redefined-loop-name https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/redefined_loop_name.py..SS redefined-outer-name / W0621

پیام صادرشده:

بازتعریف نام %r از دامنه بیرونی (خط %s)

توضیحات:

زمانی استفاده می‌شود که نام یک متغیر، نام تعریف‌شده در یک دامنه بیرونی یا گرداننده استثنا (except handler) را بپوشاند.

کد دارای مشکل:

count = 10
def count_it(count):  # [redefined-outer-name]
    for i in range(count):
        print(i)

کد درست:

count = 10
def count_it(limit):
    for i in range(limit):
        print(i)

جزئیات تکمیلی:

یک مشکل رایج این است که این پیام هنگام استفاده از فیکسچرهای pytest فعال می‌شود https://docs.pytest.org/en/7.1.x/how-to/fixtures.html:

import pytest
@pytest.fixture
def setup():
    ...
def test_something(setup):  # [redefined-outer-name]
    ...

یک راه‌حل برای این مشکل، نام‌گذاری صریح فیکسچر است:

@pytest.fixture(name="setup")
def setup_fixture():
    ...

به عنوان روش دیگر، می‌توان از افزونه‌های pylint مانند pylint-pytest https://pypi.org/project/pylint-pytest استفاده کرد.

ایجاد شده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py.

redefined-slots-in-subclass / W0244

پیام صادرشده:

بازتعریف اسلات‌های %r در زیرکلاس

توضیحات:

زمانی استفاده می‌شود که یک slot در یک زیرکلاس دوباره تعریف شود.

کد دارای مشکل:

class Base:
    __slots__ = ("a", "b")
class Subclass(Base):
    __slots__ = ("a", "d")  # [redefined-slots-in-subclass]

کد درست:

class Base:
    __slots__ = ("a", "b")
class Subclass(Base):
    __slots__ = ("d",)

ایجاد شده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS redundant-returns-doc / W9008

پیام صادرشده:

مستندات بازگشت مازاد

توضیحات:

لطفاً مستندات return/rtype را از این متد حذف کنید.

کد دارای مشکل:

def print_fruits(fruits):  # [redundant-returns-doc]
    """Print list of fruits
    Returns
    -------
        str
    """
    print(fruits)
    return None

کد صحیح:

def print_fruits(fruits):
    """Print list of fruits
    Returns
    -------
        str
    """
    print(fruits)
    return ",".join(fruits)

فایل پیکربندی:

[MAIN]
load-plugins = pylint.extensions.docparams

نکته:

ایجادشده توسط بررسی‌کننده parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py.

redundant-u-string-prefix / W1406

پیام صادرشده:

پیشوند u برای رشته‌ها در Python >=3.0 دیگر ضروری نیست

توضیحات:

هنگامی استفاده می‌شود که رشته‌ای با پیشوند u شناسایی شود. این پیشوندها در Python 2 برای مشخص کردن اینکه یک رشته Unicode است لازم بودند، اما از Python 3.0 به بعد رشته‌ها به صورت پیش‌فرض Unicode هستند.

کد دارای مشکل:

def print_fruit():
    print(u"Apple")  # [redundant-u-string-prefix]

کد صحیح:

def print_fruit():
    print("Apple")

ایجادشده توسط بررسی‌کننده string https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/strings.py..SS redundant-unittest-assert / W1503

پیام صادرشده:

استفادهٔ زائد از %s با مقدار ثابت %r

توضیحات:

نخستین آرگومان assertTrue و assertFalse یک شرط است. اگر یک مقدار ثابت به عنوان پارامتر ارسال شود، آن شرط همواره درست خواهد بود. در این حالت باید یک هشدار صادر شود.

کد مشکل‌دار:

import unittest
class DummyTestCase(unittest.TestCase):
    def test_dummy(self):
        self.assertTrue("foo")  # [redundant-unittest-assert]

کد صحیح:

import unittest
class DummyTestCase(unittest.TestCase):
    def test_dummy(self):
        actual = "test_result"
        self.assertEqual(actual, "expected")

جزئیات تکمیلی:

اعتبارسنجی مستقیم یک رشتهٔ لفظی (string literal) همواره با موفقیت همراه خواهد بود. راه‌حل این است که چیزی را که امکان شکست در آن وجود دارد آزمایش کنید، یا اصلاً هیچ اعتبارسنجی‌ای انجام ندهید.

برای اعتبارسنجی‌ها با استفاده از assert، پیام‌های مشابهی وجود دارند: assert-on-string-literal / W0129 <#assert-on-string-literal> و assert-on-tuple / W0199 <#assert-on-tuple>.

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py.

redundant-yields-doc / W9010

پیام صادرشده:

مستندسازی زائد yields

توضیحات:

لطفاً مستندسازی yields را از این متد حذف کنید.

کد مشکل‌دار:

def give_fruits(fruits):  # [redundant-yields-doc]
    """Something about fruits
    Yields
    -------
        list
            fruits
    """
    return fruits

کد صحیح:

def give_fruits(fruits):
    """Something about fruits
    Yields
    -------
        str
            fruit
    """
    for fruit in fruits:
        yield fruit

فایل پیکربندی:

[MAIN]
load-plugins = pylint.extensions.docparams

نکته:

ایجادشده توسط بررسی‌کنندهٔ parameter_documentation https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/extensions/docparams.py..SS reimported / W0404

پیام صادرشده:

وارد کردن مجدد %r (واردشده در خط %s)

توضیحات:

هنگامی استفاده می‌شود که یک ماژول بیش از یک بار وارد شده باشد.

کد دارای مشکل:

import re
import re  # [reimported]

کد درست:

import re

ایجادشده توسط بررسی‌کنندهٔ imports https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/imports.py.

return-in-finally / W0134

پیام صادرشده:

'return' توسط بند 'finally' تحت‌الشعاع قرار گرفته است.

توضیحات:

هنگامی صادر می‌شود که یک دستور 'return' در یک بلوک 'finally' یافت شود. این کار مقدار بازگشتی تابع را رونویسی خواهد کرد و باید از آن خودداری شود.

کد دارای مشکل:

def second_favorite():
    fruits = ["kiwi", "pineapple"]
    try:
        return fruits[1]
    finally:
        # because of this `return` statement, this function will always return "kiwi"
        return fruits[0]  # [return-in-finally]

کد درست:

def second_favorite():
    fruits = ["kiwi", "pineapple"]
    try:
        return fruits[1]
    except KeyError:
        ...
    return fruits[0]

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کنندهٔ basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py..SS self-assigning-variable / W0127

پیام صادرشده:

انتساب متغیر یکسان %r به خودش

توضیحات:

زمانی صادر می‌شود که تشخیص داده شود یک متغیر به خودش منتسب شده است

کد دارای مشکل:

year = 2000
year = year  # [self-assigning-variable]

کد درست:

year = 2000

پیوندهای مرتبط:

ایجادشده توسط بررسی‌کننده basic https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/base/basic_checker.py.

self-cls-assignment / W0642

پیام صادرشده:

انتساب نامعتبر به %s در متد

توضیحات:

انتساب نامعتبر به self یا cls به ترتیب در متد نمونه یا متد کلاس.

کد دارای مشکل:

class Fruit:
    @classmethod
    def list_fruits(cls):
        cls = "apple"  # [self-cls-assignment]
    def print_color(self, *colors):
        self = "red"  # [self-cls-assignment]
        color = colors[1]
        print(color)

کد درست:

class Fruit:
    @classmethod
    def list_fruits(cls):
        fruit = "apple"
        print(fruit)
    def print_color(self, *colors):
        color = colors[1]
        print(color)

ایجادشده توسط بررسی‌کننده variables https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/variables.py..SS shadowed-import / W0416

پیام صادرشده:

پوشانده‌شدن %r (واردشده در خط %s)

توضیحات:

زمانی استفاده می‌شود که برای یک ماژول نام مستعاری تعیین شود که یک import دیگر را می‌پوشاند.

کد مشکل‌دار:

from pathlib import Path
import FastAPI.Path as Path  # [shadowed-import]

کد درست:

from pathlib import Path
import FastAPI.Path as FastApiPath

ایجادشده توسط بررسی‌کنندهٔ imports https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/imports.py.

shallow-copy-environ / W1507

پیام صادرشده:

استفاده از copy.copy(os.environ). به‌جای آن از os.environ.copy() استفاده کنید.

توضیحات:

متغیر os.environ یک شیء dict نیست بلکه یک شیء پروکسی است، بنابراین کپی سطحی (shallow copy) همچنان بر شیء اصلی اثر می‌گذارد. برای مرجع، https://bugs.python.org/issue15373 را ببینید.

کد مشکل‌دار:

import copy
import os
copied_env = copy.copy(os.environ)  # [shallow-copy-environ]

کد درست:

import os
copied_env = os.environ.copy()

ایجادشده توسط بررسی‌کنندهٔ stdlib https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/stdlib.py.

signature-differs / W0222

پیام صادرشده:

امضا با متد %s %r متفاوت است

توضیحات:

زمانی استفاده می‌شود که امضای یک متد با امضای موجود در رابط پیاده‌سازی‌شده یا متد بازنویسی‌شده متفاوت باشد.

کد مشکل‌دار:

class Animal:
    def run(self, distance=0):
        print(f"Ran {distance} km!")
class Dog(Animal):
    def run(self, distance):  # [signature-differs]
        super(Animal, self).run(distance)
        print("Fetched that stick, wuff !")

کد درست:

class Animal:
    def run(self, distance=0):
        print(f"Ran {distance} km!")
class Dog(Animal):
    def run(self, distance=0):
        super(Animal, self).run(distance)
        print("Fetched that stick, wuff !")

ایجادشده توسط بررسی‌کنندهٔ classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS subclassed-final-class / W0240

پیام صادرشده:

کلاس %r زیرکلاسی از یک کلاس تزیین‌شده با typing.final است: %r

توضیحات:

زمانی استفاده می‌شود که کلاسی با دکوراتور typing.final زیرکلاس‌بندی (ارث‌بری) شده باشد.

کد دارای مشکل:

from typing import final
@final
class PlatypusData:
    """General Platypus data."""
    average_length = 46
    average_body_temperature = 32
class FluorescentPlaytipus(PlatypusData):  # [subclassed-final-class]
    """Playtipus with fluorescent fur."""

کد صحیح:

from typing import final
@final
class PlatypusData:
    """General Platypus data."""
    average_length = 46
    average_body_temperature = 32
def print_average_length_platypus():
    output = f"The average length of a platypus is: {PlatypusData.average_length}cm"
    print(output)

فایل پیکربندی:

[MAIN]
py-version=3.8

جزئیات بیشتر:

این پیام زمانی صادر می‌شود که از کلاسی تزیین‌شده با final زیرکلاس ایجاد شود؛ این دکوراتور نشان می‌دهد که کلاس نباید ارث‌بری یا گسترش داده شود.

توجه داشته باشید که این پیام هنگام استفاده از Python < 3.8 صادر نمی‌شود.

پیوندهای مرتبط:

ایجاد شده توسط بررسی‌کننده classes https://github.com/pylint-dev/pylint/blob/main/build/lib/pylint/checkers/classes/class_checker.py..SS subprocess-popen-preexec-fn / W1509

پیام صادرشده:

استفاده از کلیدواژه preexec_fn که ممکن است در حضور threadها ناامن باشد

توضیحات:

استفاده از پارامتر preexec_fn در صورت وجود threadها در برنامه شما ایمن نیست. فرآیند فرزند (child process) ممکن است پیش از فراخوانی exec دچار بن‌بست (deadlock) شود. اگر مجبور به استفاده از آن هستید، آن را بسیار ساده نگه دارید! تعداد کتابخانه‌هایی را که فراخوانی می‌کنید به حداقل برسانید. ببینید: https://docs.python.org/3/library/subprocess.html#popen-constructor