Использование Pylint с Django

Я очень хотел бы интегрировать pylint в процесс сборки для моих проектов python, но я столкнулся с одним show-stopper: один из типов ошибок, которые я считаю чрезвычайно полезными -: - E1101: *%s %r has no %r member*постоянно сообщает об ошибках при использовании общих полей django , например:

E1101:125:get_user_tags: Class 'Tag' has no 'objects' member

что вызвано этим кодом:

def get_user_tags(username):
   """
   Gets all the tags that username has used.

   Returns a query set.
   """
   return Tag.objects.filter(  ## This line triggers the error.
       tagownership__users__username__exact=username).distinct()

# Here is the Tag class, models.Model is provided by Django:
class Tag(models.Model):
   """
   Model for user-defined strings that help categorize Events on
   on a per-user basis.
   """
   name = models.CharField(max_length=500, null=False, unique=True)

   def __unicode__(self):
       return self.name

Как настроить Pylint для правильного учета таких полей, как объекты? (Я также изучил исходный код Django, и мне не удалось найти реализацию objects, поэтому я подозреваю, что это не «просто» поле класса. С другой стороны, я новичок в python, поэтому я вполне мог что-то пропустить.)

Изменить: единственный способ, который я нашел, чтобы сообщить pylint не предупреждать об этих предупреждениях, - это заблокировать все ошибки типа (E1101), что не является приемлемым решением, поскольку это (на мой взгляд) чрезвычайно полезная ошибка. Если есть другой способ, без дополнения источника pylint, укажите мне конкретику :)

См. Здесь краткое изложение проблем, с которыми я столкнулся, pycheckerи pyflakes- они оказались очень нестабильными для общего использования. (В случае pychecker сбои возникли в коде pychecker, а не в источнике, который он загружал / вызывал.)

Не отключайте и не ослабляйте функциональность Pylint, добавляя ignoresили generated-members.
Используйте активно разрабатываемый плагин Pylint, который понимает Django.
Этот плагин Pylint для Django работает неплохо:

pip install pylint-django

и при запуске pylint добавьте к команде следующий флаг:

--load-plugins pylint_django

Подробное сообщение в блоге здесь .

Я использую следующее: pylint --generated-members=objects

Если вы используете Visual Studio Code, сделайте следующее:

pip install pylint-django

И добавляем в конфиг VSC:

"python.linting.pylintArgs": [
    "--load-plugins=pylint_django"
],

Мой ~ / .pylintrc содержит

[TYPECHECK]
generated-members=REQUEST,acl_users,aq_parent,objects,_meta,id

последние два предназначены специально для Django.

Обратите внимание, что в PyLint 0.21.1 есть ошибка, которую нужно исправить, чтобы это работало.

Изменить: немного поработав с этим, я решил немного взломать PyLint, чтобы позволить мне расширить приведенное выше до:

[TYPECHECK]
generated-members=REQUEST,acl_users,aq_parent,objects,_meta,id,[a-zA-Z]+_set

Я просто добавил:

    import re
    for pattern in self.config.generated_members:
        if re.match(pattern, node.attrname):
            return

после исправления, упомянутого в отчете об ошибке (т. е. в строке 129).

Счастливые дни!

django-lint - хороший инструмент, который обертывает pylint специфическими настройками django: http://chris-lamb.co.uk/projects/django-lint/

проект github: https://github.com/lamby/django-lint

Из-за того, как работает pylint (он проверяет сам исходный код, не позволяя Python выполнить его на самом деле), для pylint очень сложно выяснить, как метаклассы и сложные базовые классы на самом деле влияют на класс и его экземпляры. «Pychecker» инструмент немного лучше в этом отношении, потому что он делает на самом деле пусть Python выполнения кода; он импортирует модули и проверяет полученные объекты. Однако у этого подхода есть другие проблемы, потому что он действительно позволяет Python выполнять код :-)

Вы можете расширить pylint, чтобы научить его магии, которую использует Django, или чтобы он лучше понимал метаклассы или сложные базовые классы, или просто игнорировал такие случаи после обнаружения одной или нескольких функций, которые он не совсем понимает. Не думаю, что это будет особенно легко. Вы также можете просто указать pylint не предупреждать об этих вещах с помощью специальных комментариев в исходном коде, параметров командной строки или файла .pylintrc.

Я отказался от использования pylint / pychecker в пользу использования pyflakes с кодом Django - он просто пытается импортировать модуль и сообщает о любых обнаруженных проблемах, таких как неиспользуемый импорт или неинициализированные локальные имена.

Это не решение, но вы можете добавлять objects = models.Manager()в свои модели Django, не меняя поведения.

Я сам использую только pyflakes, в первую очередь из-за некоторых глупых значений по умолчанию в pylint и моей лени (не желая искать, как изменить значения по умолчанию).

Попробуйте запустить pylint с

pylint --ignored-classes=Tags

Если это сработает, добавьте все остальные классы Django - возможно, используя скрипт, скажем, python: P

Документация для --ignore-classes:

--ignored-classes=<members names>
Список имен классов, атрибуты членов которых не следует проверять (полезно для классов с динамически установленными атрибутами). [текущий:% по умолчанию]

Я должен добавить, что это не особо элегантное решение, на мой взгляд, но оно должно работать.

Решение, предложенное в этом другом вопросе, - просто добавить get_attr в ваш класс Tag. Некрасиво, но работает.

Пока я не нашел реального решения для этого, но работаю:

• В нашей компании нам требуется оценка pylint> 8. Это позволяет практикам кодирования, которые pylint не понимает, при этом гарантируя, что код не будет слишком «необычным». До сих пор мы не видели ни одного случая, когда E1101 не позволял нам набрать 8 или больше баллов.
• Наши цели 'make check' отфильтровывают сообщения «for has no 'objects' member», чтобы убрать большую часть отвлекающих факторов, вызванных тем, что pylint не понимает Django.

Для neovim & vim8использования w0rp's aleплагина. Если вы установили все правильно в том числе w0rp's ale, pylintи pylint-django. В вашем vimrcдобавить следующую строку и весело провести время разработки веб - приложений с использованием Django. Спасибо.

let g:ale_python_pylint_options = '--load-plugins pylint_django'