taichi-dev/taichi

Enable pylint for python/taichi folder

Open

#3,107 opened on Oct 8, 2021

View on GitHub
 (2 comments) (2 reactions) (1 assignee)C++ (28,195 stars) (2,384 forks)batch import
enhancementgood first issuewelcome contribution

Description

Currently if you run pylint python/taichi/ there're a lot of warnings/errors. We'd like to get rid of these and run pylint in CI. Also in .pylintrc we skip a few checkers but it'd be nice to enable some of them back, e.g. import-outside-toplevel.

This work is good for new contributors, and you're welcome to submit one PR per pylint checker/rule.

  • singleton comparison (C0121)
  • import outside top level (C0415)
  • redefined-outer-name (W0621)
  • redefined-builtins (W0622)
  • consider using from import (R0402)
  • use f-string (C0209)
  • no-self-use (R0201)
  • useless-super-delegation (W0235)
  • redefined-outer-name (W0621)
  • unused-variable (W0612)
  • no-else-return (R1705)
  • reimport (W0404)
  • unused-import (W0611)
  • wildcard-import (W0401)

Reference: https://pylint.pycqa.org/en/latest/technical_reference/features.html

Contributor guide

Tech stack
python
Domain
developer experienceci cd
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python basicspylint usageGit fundamentals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Start by reviewing the `.pylintrc` file in the root of the repository. Then pick an unchecked pylint rule from the checklist in the issue (e.g., 'redefined outer name'). Enable the rule in `.pylintrc` and fix all resulting warnings in the `python/taichi/` directory. Ensure that the changes pass existing tests before creating a pull request. Refer to the pylint documentation for detailed rule descriptions.