summaryrefslogtreecommitdiff
path: root/source4/scripting/python
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2008-05-24 04:01:57 +0200
committerJelmer Vernooij <jelmer@samba.org>2008-05-24 04:01:57 +0200
commit73b789b6d25698dba15c867c71d0cdd8c264f352 (patch)
treec6c94f7fffbd9461424a53fc9ebdbd5b11b95303 /source4/scripting/python
parentb9c3aae792d06e01802c860f9cb8a463fb2a7428 (diff)
downloadsamba-73b789b6d25698dba15c867c71d0cdd8c264f352.tar.gz
samba-73b789b6d25698dba15c867c71d0cdd8c264f352.tar.bz2
samba-73b789b6d25698dba15c867c71d0cdd8c264f352.zip
Add docstrings to a couple more python modules.
(This used to be commit b4560c90e5e8d3a35367d3a21d361dc4c9c0de23)
Diffstat (limited to 'source4/scripting/python')
-rw-r--r--source4/scripting/python/misc.i5
-rw-r--r--source4/scripting/python/misc.py12
-rw-r--r--source4/scripting/python/misc_wrap.c5
-rw-r--r--source4/scripting/python/samba/__init__.py2
-rw-r--r--source4/scripting/python/samba/provision.py4
5 files changed, 23 insertions, 5 deletions
diff --git a/source4/scripting/python/misc.i b/source4/scripting/python/misc.i
index 9a4c124121..56b862552a 100644
--- a/source4/scripting/python/misc.i
+++ b/source4/scripting/python/misc.i
@@ -16,7 +16,7 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-%module(package="samba.misc") misc
+%module(docstring="Python bindings for miscellaneous Samba functions.",package="samba.misc") misc
%{
#include "includes.h"
@@ -37,6 +37,9 @@
%import "../../libcli/security/security.i"
%import "../../libcli/util/errors.i"
+%feature("docstring") generate_random_str "S.random_password(len) -> string\n" \
+ "Generate random password with specified length.";
+
%rename(random_password) generate_random_str;
char *generate_random_str(TALLOC_CTX *mem_ctx, size_t len);
diff --git a/source4/scripting/python/misc.py b/source4/scripting/python/misc.py
index 25e8d2de8c..0c14944001 100644
--- a/source4/scripting/python/misc.py
+++ b/source4/scripting/python/misc.py
@@ -3,6 +3,10 @@
#
# Don't modify this file, modify the SWIG interface instead.
+"""
+Python bindings for miscellaneous Samba functions.
+"""
+
import _misc
import new
new_instancemethod = new.instancemethod
@@ -61,7 +65,13 @@ import ldb
import credentials
import param
import security
-random_password = _misc.random_password
+
+def random_password(*args, **kwargs):
+ """
+ S.random_password(len) -> string
+ Generate random password with specified length.
+ """
+ return _misc.random_password(*args, **kwargs)
def ldb_set_credentials(*args, **kwargs):
"""
diff --git a/source4/scripting/python/misc_wrap.c b/source4/scripting/python/misc_wrap.c
index 22a072fc6f..8c57237e5b 100644
--- a/source4/scripting/python/misc_wrap.c
+++ b/source4/scripting/python/misc_wrap.c
@@ -3216,7 +3216,10 @@ fail:
static PyMethodDef SwigMethods[] = {
- { (char *)"random_password", (PyCFunction) _wrap_random_password, METH_VARARGS | METH_KEYWORDS, NULL},
+ { (char *)"random_password", (PyCFunction) _wrap_random_password, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
+ "S.random_password(len) -> string\n"
+ "Generate random password with specified length.\n"
+ ""},
{ (char *)"ldb_set_credentials", (PyCFunction) _wrap_ldb_set_credentials, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
"S.set_credentials(credentials)\n"
"Set credentials to use when connecting.\n"
diff --git a/source4/scripting/python/samba/__init__.py b/source4/scripting/python/samba/__init__.py
index 94f9e4d005..e191227108 100644
--- a/source4/scripting/python/samba/__init__.py
+++ b/source4/scripting/python/samba/__init__.py
@@ -20,6 +20,8 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
+"""Samba 4."""
+
__docformat__ = "restructuredText"
import os
diff --git a/source4/scripting/python/samba/provision.py b/source4/scripting/python/samba/provision.py
index a4730d8a07..3914fa8376 100644
--- a/source4/scripting/python/samba/provision.py
+++ b/source4/scripting/python/samba/provision.py
@@ -22,6 +22,8 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
+"""Functions for setting up a Samba configuration."""
+
from base64 import b64encode
import os
import pwd
@@ -41,8 +43,6 @@ import urllib
from ldb import SCOPE_SUBTREE, SCOPE_ONELEVEL, SCOPE_BASE, LdbError, \
LDB_ERR_NO_SUCH_OBJECT, timestring, CHANGETYPE_MODIFY, CHANGETYPE_NONE
-"""Functions for setting up a Samba configuration."""
-
__docformat__ = "restructuredText"
DEFAULTSITE = "Default-First-Site-Name"