mne-tools / mne-python

MNE: Magnetoencephalography (MEG) and Electroencephalography (EEG) in Python
https://mne.tools
BSD 3-Clause "New" or "Revised" License
2.7k stars 1.31k forks source link

Register mne-python with scientific-python for lazy_loader adoption #12388

Open bjlittle opened 8 months ago

bjlittle commented 8 months ago

Proposed documentation enhancement

@larsoner et al

Just thought I'd suggest that you guys add yourselves to https://github.com/scientific-python/lazy_loader/issues/50, since you're leveraging the awesome benefits of the lazy_loader package 👍

welcome[bot] commented 8 months ago

Hello! 👋 Thanks for opening your first issue here! ❤️ We will try to get back to you soon. 🚴

drammock commented 8 months ago

Just thought I'd suggest that you guys add yourselves to scientific-python/lazy_loader#50

Sure, feel free to add us there if it's helpful to the lazy loader devs to do so. IIRC we're already listed on the relevant SPEC website as an adopter.

cbrnr commented 8 months ago

To be honest, I'm really not convinced that the benefits of this package outweigh its issues. The adoption has been controversial, and I specifically don't like to further encourage other projects to adopt it without any specific reason.

hoechenberger commented 8 months ago

I'm not sure why this would capture anyone's interest 😅 Since MNE-Python isn't listed as a core project, I'm puzzled about the significance of understanding whether it employs lazy-loading or not, except perhaps for the users of MNE-Python itself.

Not veto-ing an addition to the list; I just don't think it serves any useful purpose.

drammock commented 8 months ago

@hoechenberger and @cbrnr did you look at the issue that @bjlittle linked to? Its purpose is for lazy loader devs to know who to check with if they are considering API changes. I doubt it will have the effect of encouraging others to adopt it

bjlittle commented 8 months ago

Thanks guys. It's genuinely interesting to hear the back story here to lazy_loader and your experiences.

If you don't mind, can you summarise the controversy on mne-python surrounding adoption? Even, your general personal objections, or not, would be super useful to know.

Many thanks 👍

drammock commented 8 months ago

@bjlittle we started with #11838 (but did it a dumb way, without .pyi files). This caused problems with IDE completion hints etc, as discussed in #12059 (that's where all the opinions are aired). The IDE problem was fixed by #12072.

hoechenberger commented 8 months ago

@drammock Indeed I misunderstood the purpose of this issue – I thought it's to gather a list of projects to be publicized on the website! My bad.