mirror of
https://github.com/samba-team/samba.git
synced 2024-12-25 23:21:54 +03:00
Add some docstrings to credentials python module.
This commit is contained in:
Jelmer Vernooij
parent
8e4cd10e3f
commit
7b4435a68c
@ -59,36 +59,53 @@ typedef struct cli_credentials {
|
||||
return cli_credentials_init(NULL);
|
||||
}
|
||||
/* username */
|
||||
%feature("docstring") get_username "S.get_username() -> username\nObtain username.";
|
||||
const char *get_username(void);
|
||||
%feature("docstring") set_username "S.set_username(name, obtained=CRED_SPECIFIED) -> None\nChange username.";
|
||||
bool set_username(const char *value,
|
||||
enum credentials_obtained=CRED_SPECIFIED);
|
||||
enum credentials_obtained obtained=CRED_SPECIFIED);
|
||||
|
||||
/* password */
|
||||
%feature("docstring") get_password "S.get_password() -> password\n" \
|
||||
"Obtain password.";
|
||||
const char *get_password(void);
|
||||
%feature("docstring") set_password "S.set_password(password, obtained=CRED_SPECIFIED) -> None\n" \
|
||||
"Change password.";
|
||||
bool set_password(const char *val,
|
||||
enum credentials_obtained=CRED_SPECIFIED);
|
||||
enum credentials_obtained obtained=CRED_SPECIFIED);
|
||||
|
||||
/* domain */
|
||||
%feature("docstring") get_password "S.get_domain() -> domain\nObtain domain name.";
|
||||
const char *get_domain(void);
|
||||
%feature("docstring") set_domain "S.set_domain(domain, obtained=CRED_SPECIFIED) -> None\n" \
|
||||
"Change domain name.";
|
||||
bool set_domain(const char *val,
|
||||
enum credentials_obtained=CRED_SPECIFIED);
|
||||
enum credentials_obtained obtained=CRED_SPECIFIED);
|
||||
|
||||
/* realm */
|
||||
%feature("docstring") get_realm "S.get_realm() -> realm\nObtain realm name.";
|
||||
const char *get_realm(void);
|
||||
%feature("docstring") set_realm "S.set_realm(realm, obtained=CRED_SPECIFIED) -> None\n" \
|
||||
"Change realm name.";
|
||||
bool set_realm(const char *val,
|
||||
enum credentials_obtained=CRED_SPECIFIED);
|
||||
enum credentials_obtained obtained=CRED_SPECIFIED);
|
||||
|
||||
/* Kerberos */
|
||||
/* Kerberos */
|
||||
void set_kerberos_state(enum credentials_use_kerberos use_kerberos);
|
||||
|
||||
%feature("docstring") parse_string "S.parse_string(text, obtained=CRED_SPECIFIED) -> None\n" \
|
||||
"Parse credentials string.";
|
||||
void parse_string(const char *text,
|
||||
enum credentials_obtained=CRED_SPECIFIED);
|
||||
enum credentials_obtained obtained=CRED_SPECIFIED);
|
||||
|
||||
/* bind dn */
|
||||
%feature("docstring") get_bind_dn "S.get_bind_dn() -> bind dn\nObtain bind DN.";
|
||||
const char *get_bind_dn(void);
|
||||
%feature("docstring") set_bind_dn "S.set_bind_dn(bind_dn) -> None\nChange bind DN.";
|
||||
bool set_bind_dn(const char *bind_dn);
|
||||
|
||||
void set_anonymous();
|
||||
%feature("docstring") set_anonymous "S.set_anonymous() -> None\nUse anonymous credentials.";
|
||||
void set_anonymous();
|
||||
|
||||
/* workstation name */
|
||||
const char *get_workstation(void);
|
||||
@ -104,8 +121,10 @@ typedef struct cli_credentials {
|
||||
|
||||
bool authentication_requested(void);
|
||||
|
||||
%feature("docstring") wrong_password "S.wrong_password() -> bool\nIndicate the returned password was incorrect.";
|
||||
bool wrong_password(void);
|
||||
|
||||
%feature("docstring") set_cmdline_callbacks "S.set_cmdline_callbacks() -> bool\nUse command-line to obtain credentials not explicitly set.";
|
||||
bool set_cmdline_callbacks();
|
||||
}
|
||||
} cli_credentials;
|
||||
|
||||
@ -66,6 +66,97 @@ class Credentials(object):
|
||||
__repr__ = _swig_repr
|
||||
def __init__(self, *args, **kwargs):
|
||||
_credentials.Credentials_swiginit(self,_credentials.new_Credentials(*args, **kwargs))
|
||||
def get_username(*args, **kwargs):
|
||||
"""
|
||||
S.get_username() -> username
|
||||
Obtain username.
|
||||
"""
|
||||
return _credentials.Credentials_get_username(*args, **kwargs)
|
||||
|
||||
def set_username(*args, **kwargs):
|
||||
"""
|
||||
S.set_username(name, obtained=CRED_SPECIFIED) -> None
|
||||
Change username.
|
||||
"""
|
||||
return _credentials.Credentials_set_username(*args, **kwargs)
|
||||
|
||||
def get_password(*args, **kwargs):
|
||||
"""
|
||||
S.get_password() -> password
|
||||
Obtain password.
|
||||
"""
|
||||
return _credentials.Credentials_get_password(*args, **kwargs)
|
||||
|
||||
def set_password(*args, **kwargs):
|
||||
"""
|
||||
S.set_password(password, obtained=CRED_SPECIFIED) -> None
|
||||
Change password.
|
||||
"""
|
||||
return _credentials.Credentials_set_password(*args, **kwargs)
|
||||
|
||||
def set_domain(*args, **kwargs):
|
||||
"""
|
||||
S.set_domain(domain, obtained=CRED_SPECIFIED) -> None
|
||||
Change domain name.
|
||||
"""
|
||||
return _credentials.Credentials_set_domain(*args, **kwargs)
|
||||
|
||||
def get_realm(*args, **kwargs):
|
||||
"""
|
||||
S.get_realm() -> realm
|
||||
Obtain realm name.
|
||||
"""
|
||||
return _credentials.Credentials_get_realm(*args, **kwargs)
|
||||
|
||||
def set_realm(*args, **kwargs):
|
||||
"""
|
||||
S.set_realm(realm, obtained=CRED_SPECIFIED) -> None
|
||||
Change realm name.
|
||||
"""
|
||||
return _credentials.Credentials_set_realm(*args, **kwargs)
|
||||
|
||||
def parse_string(*args, **kwargs):
|
||||
"""
|
||||
S.parse_string(text, obtained=CRED_SPECIFIED) -> None
|
||||
Parse credentials string.
|
||||
"""
|
||||
return _credentials.Credentials_parse_string(*args, **kwargs)
|
||||
|
||||
def get_bind_dn(*args, **kwargs):
|
||||
"""
|
||||
S.get_bind_dn() -> bind dn
|
||||
Obtain bind DN.
|
||||
"""
|
||||
return _credentials.Credentials_get_bind_dn(*args, **kwargs)
|
||||
|
||||
def set_bind_dn(*args, **kwargs):
|
||||
"""
|
||||
S.set_bind_dn(bind_dn) -> None
|
||||
Change bind DN.
|
||||
"""
|
||||
return _credentials.Credentials_set_bind_dn(*args, **kwargs)
|
||||
|
||||
def set_anonymous(*args, **kwargs):
|
||||
"""
|
||||
S.set_anonymous() -> None
|
||||
Use anonymous credentials.
|
||||
"""
|
||||
return _credentials.Credentials_set_anonymous(*args, **kwargs)
|
||||
|
||||
def wrong_password(*args, **kwargs):
|
||||
"""
|
||||
S.wrong_password() -> bool
|
||||
Indicate the returned password was incorrect.
|
||||
"""
|
||||
return _credentials.Credentials_wrong_password(*args, **kwargs)
|
||||
|
||||
def set_cmdline_callbacks(*args, **kwargs):
|
||||
"""
|
||||
S.set_cmdline_callbacks() -> bool
|
||||
Use command-line to obtain credentials not explicitly set.
|
||||
"""
|
||||
return _credentials.Credentials_set_cmdline_callbacks(*args, **kwargs)
|
||||
|
||||
__swig_destroy__ = _credentials.delete_Credentials
|
||||
Credentials.get_username = new_instancemethod(_credentials.Credentials_get_username,None,Credentials)
|
||||
Credentials.set_username = new_instancemethod(_credentials.Credentials_set_username,None,Credentials)
|
||||
|
||||
@ -2881,7 +2881,7 @@ SWIGINTERN PyObject *_wrap_Credentials_set_username(PyObject *SWIGUNUSEDPARM(sel
|
||||
PyObject * obj1 = 0 ;
|
||||
PyObject * obj2 = 0 ;
|
||||
char * kwnames[] = {
|
||||
(char *) "self",(char *) "value",(char *)"arg3", NULL
|
||||
(char *) "self",(char *) "value",(char *) "obtained", NULL
|
||||
};
|
||||
|
||||
arg1 = NULL;
|
||||
@ -2962,7 +2962,7 @@ SWIGINTERN PyObject *_wrap_Credentials_set_password(PyObject *SWIGUNUSEDPARM(sel
|
||||
PyObject * obj1 = 0 ;
|
||||
PyObject * obj2 = 0 ;
|
||||
char * kwnames[] = {
|
||||
(char *) "self",(char *) "val",(char *)"arg3", NULL
|
||||
(char *) "self",(char *) "val",(char *) "obtained", NULL
|
||||
};
|
||||
|
||||
arg1 = NULL;
|
||||
@ -3043,7 +3043,7 @@ SWIGINTERN PyObject *_wrap_Credentials_set_domain(PyObject *SWIGUNUSEDPARM(self)
|
||||
PyObject * obj1 = 0 ;
|
||||
PyObject * obj2 = 0 ;
|
||||
char * kwnames[] = {
|
||||
(char *) "self",(char *) "val",(char *)"arg3", NULL
|
||||
(char *) "self",(char *) "val",(char *) "obtained", NULL
|
||||
};
|
||||
|
||||
arg1 = NULL;
|
||||
@ -3124,7 +3124,7 @@ SWIGINTERN PyObject *_wrap_Credentials_set_realm(PyObject *SWIGUNUSEDPARM(self),
|
||||
PyObject * obj1 = 0 ;
|
||||
PyObject * obj2 = 0 ;
|
||||
char * kwnames[] = {
|
||||
(char *) "self",(char *) "val",(char *)"arg3", NULL
|
||||
(char *) "self",(char *) "val",(char *) "obtained", NULL
|
||||
};
|
||||
|
||||
arg1 = NULL;
|
||||
@ -3214,7 +3214,7 @@ SWIGINTERN PyObject *_wrap_Credentials_parse_string(PyObject *SWIGUNUSEDPARM(sel
|
||||
PyObject * obj1 = 0 ;
|
||||
PyObject * obj2 = 0 ;
|
||||
char * kwnames[] = {
|
||||
(char *) "self",(char *) "text",(char *)"arg3", NULL
|
||||
(char *) "self",(char *) "text",(char *) "obtained", NULL
|
||||
};
|
||||
|
||||
arg1 = NULL;
|
||||
@ -3690,19 +3690,52 @@ SWIGINTERN PyObject *Credentials_swiginit(PyObject *SWIGUNUSEDPARM(self), PyObje
|
||||
|
||||
static PyMethodDef SwigMethods[] = {
|
||||
{ (char *)"new_Credentials", (PyCFunction)_wrap_new_Credentials, METH_NOARGS, NULL},
|
||||
{ (char *)"Credentials_get_username", (PyCFunction) _wrap_Credentials_get_username, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_set_username", (PyCFunction) _wrap_Credentials_set_username, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_get_password", (PyCFunction) _wrap_Credentials_get_password, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_set_password", (PyCFunction) _wrap_Credentials_set_password, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_get_username", (PyCFunction) _wrap_Credentials_get_username, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.get_username() -> username\n"
|
||||
"Obtain username.\n"
|
||||
""},
|
||||
{ (char *)"Credentials_set_username", (PyCFunction) _wrap_Credentials_set_username, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.set_username(name, obtained=CRED_SPECIFIED) -> None\n"
|
||||
"Change username.\n"
|
||||
""},
|
||||
{ (char *)"Credentials_get_password", (PyCFunction) _wrap_Credentials_get_password, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.get_password() -> password\n"
|
||||
"Obtain password.\n"
|
||||
""},
|
||||
{ (char *)"Credentials_set_password", (PyCFunction) _wrap_Credentials_set_password, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.set_password(password, obtained=CRED_SPECIFIED) -> None\n"
|
||||
"Change password.\n"
|
||||
""},
|
||||
{ (char *)"Credentials_get_domain", (PyCFunction) _wrap_Credentials_get_domain, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_set_domain", (PyCFunction) _wrap_Credentials_set_domain, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_get_realm", (PyCFunction) _wrap_Credentials_get_realm, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_set_realm", (PyCFunction) _wrap_Credentials_set_realm, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_set_domain", (PyCFunction) _wrap_Credentials_set_domain, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.set_domain(domain, obtained=CRED_SPECIFIED) -> None\n"
|
||||
"Change domain name.\n"
|
||||
""},
|
||||
{ (char *)"Credentials_get_realm", (PyCFunction) _wrap_Credentials_get_realm, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.get_realm() -> realm\n"
|
||||
"Obtain realm name.\n"
|
||||
""},
|
||||
{ (char *)"Credentials_set_realm", (PyCFunction) _wrap_Credentials_set_realm, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.set_realm(realm, obtained=CRED_SPECIFIED) -> None\n"
|
||||
"Change realm name.\n"
|
||||
""},
|
||||
{ (char *)"Credentials_set_kerberos_state", (PyCFunction) _wrap_Credentials_set_kerberos_state, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_parse_string", (PyCFunction) _wrap_Credentials_parse_string, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_get_bind_dn", (PyCFunction) _wrap_Credentials_get_bind_dn, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_set_bind_dn", (PyCFunction) _wrap_Credentials_set_bind_dn, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_set_anonymous", (PyCFunction) _wrap_Credentials_set_anonymous, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_parse_string", (PyCFunction) _wrap_Credentials_parse_string, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.parse_string(text, obtained=CRED_SPECIFIED) -> None\n"
|
||||
"Parse credentials string.\n"
|
||||
""},
|
||||
{ (char *)"Credentials_get_bind_dn", (PyCFunction) _wrap_Credentials_get_bind_dn, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.get_bind_dn() -> bind dn\n"
|
||||
"Obtain bind DN.\n"
|
||||
""},
|
||||
{ (char *)"Credentials_set_bind_dn", (PyCFunction) _wrap_Credentials_set_bind_dn, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.set_bind_dn(bind_dn) -> None\n"
|
||||
"Change bind DN.\n"
|
||||
""},
|
||||
{ (char *)"Credentials_set_anonymous", (PyCFunction) _wrap_Credentials_set_anonymous, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.set_anonymous() -> None\n"
|
||||
"Use anonymous credentials.\n"
|
||||
""},
|
||||
{ (char *)"Credentials_get_workstation", (PyCFunction) _wrap_Credentials_get_workstation, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_set_workstation", (PyCFunction) _wrap_Credentials_set_workstation, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_set_machine_account", (PyCFunction) _wrap_Credentials_set_machine_account, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
@ -3710,8 +3743,14 @@ static PyMethodDef SwigMethods[] = {
|
||||
{ (char *)"Credentials_is_anonymous", (PyCFunction) _wrap_Credentials_is_anonymous, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_get_nt_hash", (PyCFunction) _wrap_Credentials_get_nt_hash, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_authentication_requested", (PyCFunction) _wrap_Credentials_authentication_requested, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_wrong_password", (PyCFunction) _wrap_Credentials_wrong_password, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_set_cmdline_callbacks", (PyCFunction) _wrap_Credentials_set_cmdline_callbacks, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_wrong_password", (PyCFunction) _wrap_Credentials_wrong_password, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.wrong_password() -> bool\n"
|
||||
"Indicate the returned password was incorrect.\n"
|
||||
""},
|
||||
{ (char *)"Credentials_set_cmdline_callbacks", (PyCFunction) _wrap_Credentials_set_cmdline_callbacks, METH_VARARGS | METH_KEYWORDS, (char *)"\n"
|
||||
"S.set_cmdline_callbacks() -> bool\n"
|
||||
"Use command-line to obtain credentials not explicitly set.\n"
|
||||
""},
|
||||
{ (char *)"delete_Credentials", (PyCFunction) _wrap_delete_Credentials, METH_VARARGS | METH_KEYWORDS, NULL},
|
||||
{ (char *)"Credentials_swigregister", Credentials_swigregister, METH_VARARGS, NULL},
|
||||
{ (char *)"Credentials_swiginit", Credentials_swiginit, METH_VARARGS, NULL},
|
||||
|
||||
Loading…
Reference in New Issue
Block a user