support running on scripts

[Remi-Gau]

hey thanks for the great tool

I maintain a library that has a bunch of examples runnable as scripts.

I wanted to check that their complexity was very low but it turns out that complexipy only runs on functions / methods.

Out of curiosity: would supporting estimating the complexity of a script be something hard to add?

[rohaquinlop]

Hi @Remi-Gau, thank you for reaching me out!

Do you refer to things like this?

lst = []

for i in range(2, 11, 2):
  lst.append(i+1)

for i in lst:
  print(i)

[Remi-Gau]

yup exactly!

though quite longer than this: see for example

https://github.com/nilearn/nilearn/blob/main/examples/04_glm_first_level/plot_localizer_surface_analysis.py

[rohaquinlop]

I can do it, but honestly I don't know how to define the max complexity per file, on the earlier complexipy versions it was focused on files complexity, but it's not practical, so this special case still makes me wonder how to define that max complexity per file, or treat the whole file as a single function and by default set as 15 the max complexity.

[Remi-Gau]

don't sweat it if it's a headache!
I can try to have a look but I don't much bancwidth these days.
let's maybe just leave the issue open to first see, if some others would be interested.

[rohaquinlop]

I can do that, and it's not going to be really hard for me, but the only thing that makes me wonder how to do it is to define the threshold, or a quick usage would be to just return the complexities but just being informative and only if the user wants to be strict with the scripts then can set a flag, something like this:

complexipy examples/04_glm_first_level/plot_localizer_surface_analysis.py --check-script --script-strict --max-complexity 15

All the files will be treated as scripts when using the flags

The new flags would be: --check-script and --script-strict

What do you think about it?

[Remi-Gau]

oh dear: I thought I had replied to this

yes having a flag to make it run on script would be perfectly fine

FYI: no rush for implementing it, defo not urgent on my side

[mvollrath]

Maybe complexipy could treat every module, excluding e.g. class and def blocks, as a scope to be checked? It's possible for any module to have import-time logic and for it to be complex, not just files intended to be module-scoped scripts.

[ammaraslam10]

Is this still open?

[rohaquinlop]

Is this still open?

yes, I haven't worked in this issue