|
| 1 | +# Frequently Asked Questions |
| 2 | + |
| 3 | +**Q.** What does safe defaults imply? |
| 4 | + |
| 5 | +**A.** The script will hopefully work first time without any changes to |
| 6 | +the settings. Changes can be done once the script has proven to work. |
| 7 | +If it does not work with changes, then you can try to isolate the changes |
| 8 | +made to find the cause. |
| 9 | +With importing many modules, no problems is good, though I know some of you |
| 10 | +may experience problems, especially with site packages from 3rd parties. |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +**Q.** `settings['import_site']=1` causes import errors that affects the |
| 15 | +script operation or generated output? |
| 16 | + |
| 17 | +**A.** Packages downloaded from [PyPI] or other can be good to import in |
| 18 | +this script, or can be an issue. |
| 19 | +This is something that the script may have no control. |
| 20 | +Success varies and I have had some that want a certain module loaded |
| 21 | +before another is loaded. |
| 22 | +To overcome this, you can try adding the module to the list of |
| 23 | +`settings['include_modules_fullname_import_first']` to load that module first. |
| 24 | +Some other modules may need to be excluded as they may be incapable of being |
| 25 | +handled by the script. |
| 26 | +You may need to be creative to overcome any issues. |
| 27 | +Which is why the setting is `settings['import_site']=0` initially to be a |
| 28 | +safe default. |
| 29 | + |
| 30 | +--- |
| 31 | + |
| 32 | +**Q.** Why are dunder methods etc. not included as the safe defaults? |
| 33 | + |
| 34 | +**A.** I consider dunder methods i.e. `__init__` etc. for advanced users. |
| 35 | +The more entries added to the calltip files, the more that the user needs |
| 36 | +to search and find what is wanted. |
| 37 | +The more entries, the more burden put on the editor to handle. |
| 38 | +You can have the dunder methods by allowing members with double underscores. |
| 39 | +If you want to see many more entries, then try |
| 40 | +`settings['inspect_members_more']=1` to get files up to 150 MB in total. |
| 41 | +This will probably slow down the editor and your coding with the excessive |
| 42 | +amount of entries. The safe default is to be just enough entries. |
| 43 | + |
| 44 | + [PyPI]: https://pypi.org/ |
0 commit comments