isa/sudo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document how setting ModulePath affects the Python search path.

Browse Source 
Also advise the user to use a unique prefix to avoid name space
collisions with installed Python modules.  Bug #1031.
This commit is contained in:
Todd C. Miller
2022-06-06 08:39:22 -06:00
parent 96c3c28194
commit fcb5867f1d
2 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/sudo_plugin_python.man.in
View File

@@ -186,6 +186,16 @@ The path of a python file which contains the class of the sudo Python plugin.
It must be either an absolute path or a path relative to the sudo Python plugin It must be either an absolute path or a path relative to the sudo Python plugin
directory, directory,
\fI@plugindir@/python\fR. \fI@plugindir@/python\fR.
The parent directory of
\fIModulePath\fR
will be appended to Python's module search path (there is currently no
way to force Python to load a module from a fully-qualified path).
It is good practice to use a prefix for the module file that is unlikely
to conflict with other installed Python modules, for example,
\fIsudo_policy.py\fR.
Otherwise, if the there is an installed Python module with the same
file name as the sudo Python plugin file (without the directory),
the wrong file will be loaded.
.TP 6n .TP 6n
ClassName ClassName
(Optional.) The name of the class implementing the sudo Python plugin. (Optional.) The name of the class implementing the sudo Python plugin.

10
docs/sudo_plugin_python.mdoc.in
View File

@@ -157,6 +157,16 @@ The path of a python file which contains the class of the sudo Python plugin.
It must be either an absolute path or a path relative to the sudo Python plugin It must be either an absolute path or a path relative to the sudo Python plugin
directory, directory,
.Pa @plugindir@/python . .Pa @plugindir@/python .
The parent directory of
.Em ModulePath
will be appended to Python's module search path (there is currently no
way to force Python to load a module from a fully-qualified path).
It is good practice to use a prefix for the module file that is unlikely
to conflict with other installed Python modules, for example,
.Pa sudo_policy.py .
Otherwise, if the there is an installed Python module with the same
file name as the sudo Python plugin file (without the directory),
the wrong file will be loaded.
.It ClassName .It ClassName
(Optional.) The name of the class implementing the sudo Python plugin. (Optional.) The name of the class implementing the sudo Python plugin.
If not supplied, the one and only sudo.Plugin that is present in the module If not supplied, the one and only sudo.Plugin that is present in the module