IDLE: warn if save-as name matches stdlib name #69708

Activity

1. terryjreedy commented on Oct 31, 2015

   

   terryjreedy

   on Oct 31, 2015

   MemberAuthor

   More actions

   When users 'saveas', warn if name matches that of a stdlib modules. Note that shadowing is opposite for lib and binary (builtin) modules, so message needs to be different. I am not worrying about 3rd party modules on the search path (ie, site-packages), which would be shadowed like lib modules. Rough outline of code to add to IOBinding.

   from os,path import dirname
   import sys

   # this part on initiallzation or first saveas call
   def libmodules():
       with open(dirname(dirname(__file__))) as lib:
           for f in lib:
               if <directory containing __init__.py#> or f.endswith(.py):
                   yield f
   # test.test__all__ has this code
   
   islibmodule = frozenset(libmodules()).__contains__
   isbinmodule = frozenset(sys.builtin_module_names).__contains__
   
   # this part after saveas dialog returns
   if islibmodule(name):
       go = warn("This name matches a stdlib name in /Lib. If you run python in this directory, you will not be able to import the stdlib module.  Continue?".)
   elif isbinmodule(name):
       go = warn("This name matches a builtin stdlib name.  You will not be able to import this file.  Continue?".)
   else:
       go = True
   if go:
       <save as requested>
   else:
      (get name again>  # or put in while not go loop
2. terryjreedy

   added

   type-featureA feature request or enhancementA feature request or enhancement

   on Oct 31, 2015
3. terryjreedy commented on Oct 31, 2015

   

   terryjreedy

   on Oct 31, 2015

   MemberAuthor

   More actions

   The lib messages should say "Neither you nor python will be able to import the stdlib module". Example of python-imported lib names that a beginner might write are abc, io, os, nt, and stat.
4. lac commented on Nov 1, 2015

   

   lacmannequin

   on Nov 1, 2015

   Mannequin

   More actions

   I'm not sure about "Neither you nor Python will be able to import
   the stdlib." Depending on what the file is, you may be able to import
   it later. I'd prefer:

   "If you run Python in this directory, your version of <stdlibname>
   will be used instead of the one in the standard library. This may cause Idle to behave strangely, or possibly not run at all."
5. lac commented on Nov 1, 2015

   

   lacmannequin

   on Nov 1, 2015

   Mannequin

   More actions

   Do we need a full path name here as well? Probably not.
6. terryjreedy

   added

   topic-IDLE

   3.7 (EOL)end of lifeend of life

   on Jun 19, 2017
7. terryjreedy

   self-assigned this

   on Jun 19, 2017
8. terryjreedy commented on Jan 18, 2019

   

   terryjreedy

   on Jan 18, 2019

   MemberAuthor

   More actions

   Also check if the name is not an identifier and therefore could not be imported. Example:

   >>> exec('import abc--bb')
       import abc--bb
                 ^
   SyntaxError: invalid syntax
9. vedgar commented on Jan 18, 2019

   

   vedgarmannequin

   on Jan 18, 2019

   Mannequin

   More actions

   Many beginners don't write files in order to import them. For them, these name-checking is simply adding noise. If you want to do something in this area, I think a much more useful (and difficult) course of action would be to check on the opposite end. If an AttributeError "module blah has no attribute foo" is raised, then check whether a file in the current directory (or simply the current file) is named blah, and there is also a stdlib blah that has fool.
10. terryjreedy commented on Jan 24, 2019

    

    terryjreedy

    on Jan 24, 2019

    MemberAuthor

    More actions

    Beginners import stdlib files such as random. And they save scripts with such name, and accidentally import the script when not desired.

    Beginners should learn how to test a script by running a test file provided by an instructor or written themselves. In either case, they *will* have to import the script.
11. ZackerySpytz commented on Nov 5, 2019

    

    ZackerySpytzmannequin

    on Nov 5, 2019

    Mannequin

    More actions

    I have created a pull request for this issue.
12. ezio-melotti

    transferred this issue fromon Apr 10, 2022
13. terryjreedy

    added this to IDLE Issueson Jul 23, 2022
14. erlend-aasland

    moved this to In Progress in IDLE Issueson Jul 27, 2022
15. terryjreedy

    removed

    3.7 (EOL)end of lifeend of life

    on Aug 6, 2024