this post was submitted on 21 Nov 2023
10 points (100.0% liked)

Python

6360 readers
12 users here now

Welcome to the Python community on the programming.dev Lemmy instance!

πŸ“… Events

PastNovember 2023

October 2023

July 2023

August 2023

September 2023

🐍 Python project:
πŸ’“ Python Community:
✨ Python Ecosystem:
🌌 Fediverse
Communities
Projects
Feeds

founded 1 year ago
MODERATORS
erlingur@programming.dev
jnovinger@programming.dev
norambna@programming.dev
10
is there a way to prevent or alert in case a member is imported from within a module? (self.python)
submitted 11 months ago* (last edited 11 months ago) by fixmycode to c/python@programming.dev
13 comments fedilink hide all child comments
 

Let's say I have the following structure:

my_module/
  __init__.py
  utilities.py

and __init__.py contains

from .utilities import SomeUtilityFunction

Is there a way to prevent or alert developers when they do

from my_module.utilities import SomeUtilityFunction

instead of

from my_module import SomeUtilityFunction

The problem arose when a few modules started using a function that was imported inside a module in which it wasn't used, while also being available on the module's __init__.py, so after linting the file and removing the unused import my tests started failing.

any other advice for situations like this?

top 13 comments
sorted by: hot top controversial new old
[–] Chais@sh.itjust.works 3 points 11 months ago* (last edited 11 months ago) (1 children)

You could guard it.
__init__.py:

_GUARD_SOME_UTILITY_FUNCTION = True
from .utilities import SomeUtilityFunction

utilities.py:

def SomeUtilityFunction():
    if not _GUARD_SOME_UTILITY_FUNCTION:
        raise SomeException("Helpful error message")

Take this with a grain of salt, as I'm typing this on my phone and haven't actually tried it.

Alternatively there's the import-guard package on PyPI. No idea if it's any good, though. Just something a quick search brought up.

Edit:
Ok, I tried my suggestion and it doesn't work.

[–] sebsch@discuss.tchncs.de 2 points 11 months ago* (last edited 11 months ago) (1 children)

This approach seems quite overkomplex. Instead of having these errors on runtime, stuff like this should sit in linter rules of any kind.

[–] Chais@sh.itjust.works 2 points 11 months ago

It's only useful during development there.

[–] benc@mastodon.hawaga.org.uk 1 points 11 months ago (1 children)

@fixmycode mypy type checking can report this error in your code:

iox3.py:3: error: Module "iox2" does not explicitly export attribute "y" [attr-defined]

which I think is roughly the problem you are encountering: an attribute in an imported module that wasn't explicitly defined in that module, but instead came from somewhere else.

[–] fixmycode 1 points 11 months ago

I think this is the more sensitive approach, I'll take a look at putting mypy in my pipeline

[–] sebsch@discuss.tchncs.de -1 points 11 months ago (1 children)

I am normally define the interface to models while defining __all__.

Defined in the __init__ it allows to define a whitelist what can be Imported from the outside.

https://docs.python.org/3/tutorial/modules.html#importing-from-a-package

[–] Chais@sh.itjust.works 1 points 11 months ago (2 children)

That's not correct. __all__ is not a whitelist. It is only the list used for

from module import *

If you have a module with submodules foo, bar and baz and __all__ = ["foo", "bar"] it will not prevent you from importing baz manually. It just won't do it automatically.

[–] sebsch@discuss.tchncs.de 0 points 11 months ago* (last edited 11 months ago) (1 children)

It works exactly like one. You get a warning if you try to import something not defined in it. The docs are just very confusing here ;)

[–] Chais@sh.itjust.works 0 points 11 months ago* (last edited 11 months ago) (1 children)

Bullshit!

module/__init__.py:

__all__ = ["foo", "bar"]

module/foo.py:

def foo():
    print("foo")

module/bar.py:

def bar():
    print("bar")

module/baz.py:

def baz():
    print("baz")

main.py:

from module import *
from module import baz

if __name__ == "__main__":
    print("main")
    foo.foo()
    bar.bar()
    baz.baz()

Output:

$ python main.py 
main
foo
bar
baz

No errors, warnings or anything.

[–] sebsch@discuss.tchncs.de 0 points 11 months ago (1 children)

You're running python without linters? Interesting approach.

[–] Chais@sh.itjust.works 1 points 11 months ago

You can't expect the user to have one.

[–] twoframesperminute@mastodon.social -1 points 11 months ago (1 children)

@Chais from module import \* should almost never be used anyway, so...

[–] Chais@sh.itjust.works 2 points 11 months ago* (last edited 11 months ago)

Renders correctly for me
Screenshot_20231121-134426_Trebuchet_1