adding a minimal lgtm.yml file

[fchapoton]

This will tell LGTM to use Python3 during its code analysis.

as suggested here:

https://lgtm.com/help/lgtm/analysis-faqs#how-python-version-identified

CC: @tscrim @kiwifb @embray @vbraun

Component: scripts

Author: Frédéric Chapoton

Branch/Commit: f3640c2

Reviewer: Erik Bray

Issue created by migration from https://trac.sagemath.org/ticket/28839

[fchapoton]

Branch: u/chapoton/28839

[fchapoton]

New commits:

d6728ff

adding a .lgtm.yml file to specify the python version

[fchapoton]

Commit: d6728ff

[kiwifb]

comment:3

That looks interesting.

[fchapoton]

comment:4

The reports can be found here:

https://lgtm.com/projects/g/sagemath/sage/?mode=list

but the problem is that it only runs when "master" branch is updated..

[embray]

comment:5

I wonder if there is a setting to change the branch to track.

[fchapoton]

comment:6

the only way seems to be : change our main branch on github to be "develop"

[embray]

comment:7

Replying to @embray:

I wonder if there is a setting to change the branch to track.

ISTM that LGTM is reading from the GitHub mirror of our repo, so I just need to change its default branch to the develop branch. I don't think there will be any consequences to doing so, so I'll go ahead and do that.

[embray]

comment:8

I'm looking at this site, and while many of the alerts look useful, a great many of the "errors" reported are due to supposedly incorrect arguments to a class's __init__, except their analysis is not clever enough to consider classes which have a metaclass with a custom __call__ (e.g. our ClasscallMetaclass which is used all over the place).

So perhaps while we're adding this file it might be helpful to globally exclude this and related errors as explained here. For example, from what I'm seeing in the errors, we want at least:

queries:
    - exclude: py/call/wrong-named-class-argument
    - exclude: py/call/wrong-number-class-arguments

Of course, we can also suppress alerts on individual lines, but these two are so pervasive it would not be practical. Suppressing them globally unfortunately could hide legitimate errors, though these errors are likely to be caught by tests in most cases.

[sagetrac-git]

Changed commit from d6728ff to 84f4cd3

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

84f4cd3

more stuff in lgtm.yml

[fchapoton]

comment:10

indeed. Done

[embray]

comment:11

Heh, actually it turns out the actual majority of errors are of the class py/unsafe-cyclic-import. We should probably globally disable that one as well :)

[embray]

comment:12

If you add that too, can you please also include in your commit message a link to this discussion so that it's clearer why it was added.

[sagetrac-git]

Changed commit from 84f4cd3 to 7b76a05

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

7b76a05

more stuff in lgtm.yml

[embray]

comment:14

Turns out there was already a recent issue for false positives due to custom metaclass __call__s. I added some examples to it.

---

New commits:

7b76a05

more stuff in lgtm.yml

[embray]

comment:15

Replying to @embray:

If you add that too, can you please also include in your commit message a link to this discussion so that it's clearer why it was added.

LGTM :)

Though please consider either squashing your commits and/or adding some more details or link to this ticket. "adding stuff to this file for no apparent reason"-type commit messages are not helpful :(

[embray]

Reviewer: Erik Bray

[sagetrac-git]

Changed commit from 7b76a05 to f3640c2

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1 and set ticket back to needs_review. This was a forced push. New commits:

f3640c2

adding a minimal .lgtm.yml file

[fchapoton]

comment:17

ok, better like that ?

[embray]

comment:19

Thank you!

[vbraun]

Changed branch from u/chapoton/28839 to f3640c2