How will we update pylint?

[tannewt]

I like that this is centralized but would like us to update pylint at some point. How can we do that piecemeal when the install for it is here?

No rush, just something to consider.

[makermelissa]

I think the idea was to just have one place to do it rather than dig into lots of repos. Why do you think it needs to be done piecemeal?

[tannewt]

If the individual repos require changes from switch from 1 to 2 then you won't be able to it. If the changes for are backwards compatible you can do it but then it isn't enforced until this version is flipped.

[makermelissa]

I think if we need any to stay on an older version, we could set an environment variable in the Github Actions workflow for that page and add a check in this script.

[siddacious]

This is a good discussion point. My half-considered medium term plans for actions on the libs is to add some hooks to the workflow to allow libs to override the defaults. I'm going to think deeper about this when I work on my CP 2020 post tonight

[tannewt]

Sounds good! Thank you both.

[tannewt]

Any more thoughts? I don't think pylint 1.9.2 works on Python 3.7 so I'd like us to start using newer pylint soon.

[siddacious]

I haven't had any more substantial thoughts on this directly but moving to pylint 2.x is high on @dherrada 's list, I believe just after a super secret project that he hasn't been told about yet. This will have to be solved as part of that. I'll try and nail down some specifics with @sommersoft before we get to that point

[makermelissa]

No more thoughts on this from me either. I still think adding the ability to set something in the Github Actions workflow to a specific version of pylint to override the default is the right approach and then just set the default here.

[tannewt]

Ok, perfect. We'll likely want a way to move individual repos at a time. I'm pretty sure I've found a pylint bug so making it easy for us to update would be great. That way I can fix it upstream and then update. :-) Thanks!

[jerryneedell]

FYI - on my Raspberry Pi -- I have updated Pylint and it still seems to be working OK with the library I am working on (RFM9x)

[evaherrada]

@siddacious 🕵️‍♂️

[makermelissa]

Ok, I did have some more thoughts on this. I usually run a newer version of pylint locally and I usually have to ignore some of the checks that are failing because they don't fail when uploaded. This means that if we update to a newer version, some repos that were previously passing may fail and it may mean updating the .pylintrc file on those to ignore checks that we aren't concerned about. The cookie cutter will probably need to be updated soon too. This is good in the long run because it will show more consistently between running locally and remotely, but may be a bit annoying until we get there in the short-term.

[sommersoft]

@kattni and I had a small discussion concerning this, and I know that there are internal discussions on-going. But, I wanted to offer an approach that I came up with.

• Process:

  • Adabot patch all .pylintrc files with the following comment at the top: # pylint_version: 1.9.2

  • Update the Install Dependancies script to parse the pylint_version from .pylintrc, and pip install the respective version. This will fallback to a default of the current version 2.4.4 if the version is not parsed. I have a proof-of-concept:

    • Install deps changes here: https://github.com/sommersoft/actions-ci-circuitpython-libs/blob/pick_a_pylint/install.sh
    • Here are some test runs (failures on purpose so I can re-run them at will). See the Install deps log; debug info is printed on the first few lines, and the final pip results are near the end.
      • Install 1.9.2 explicitly: https://github.com/sommersoft/actions_testing/runs/444714583?check_suite_focus=true
      • Install fallback of 2.4.4 (version number removed from # pylint_version:): https://github.com/sommersoft/actions_testing/runs/444723888?check_suite_focus=true

  • As a library is brought up to a new pylint version, update or remove the pylint_version comment from .pylintrc.

• Advantages:

  • Visibility of progress. Adabot can check the pylint_version of each library by peeking at the .pylintrc file, and report accordingly. This would provide a daily list of libraries needing to be updated on circuitpython.org/contributing.
  • Limited shuffling of the Actions workflows on each library. Any future updates are also confined to the install.sh script.
  • The .pylintrc file will ostensibly stay the same with the version updates, but if it does need changes those changes can most likely be applied at the same time as the pylint_version patch. (There may be a few unique .pylintrcs out there…)

• Disadvantages:

  • There is a bit of complexity with this approach.
  • Requires each library to be touched at minimum to update the pylint_version. (Although, it could likely be scripted.)
  • If .pylintrc is mistakenly not updated with pylint upgrading, the old version is still pinned.

Butcher this idea at will. It was kind of off-the-cuff, and as I'm wont to do, it focuses on Adabot a lot. 😄 🤖

[makermelissa]

I like it. Having adabot doing all the work makes it an easy implementation. :)

[siddacious]

Sounds good to me!

…

On Thu, Feb 13, 2020 at 7:16 PM Melissa LeBlanc-Williams < ***@***.***> wrote: I like it. Having adabot doing all the work makes it an easy implementation. :) — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2?email_source=notifications&email_token=AAJBB4MIVQ2QQQZQ7BTLWXTRCYEIDA5CNFSM4KEBNX3KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOELXNQMA#issuecomment-586078256>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJBB4MIBFZRNWSVLAECIHLRCYEIDANCNFSM4KEBNX3A> .