Unsignedio
/
python-gnupg
mirror of https://github.com/markqvist/python-gnupg.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update docstring for parsers._sanitise().

feature/documentation-builds-html
Isis Lovecruft 2013-04-15 01:22:23 +00:00
parent 2a3849e9a3
commit 1abffa966d
No known key found for this signature in database
GPG Key ID: A3ADB67A2CDB8B35
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
gnupg/parsers.py
View File

@ -354,25 +354,23 @@ def _sanitise(*args):
:returns: ``sanitised`` :returns: ``sanitised``
""" """
def _check_arg_and_value(arg, value): def _check_option(arg, value):
""" """
Check that a single :param:arg is an allowed option. If it is allowed, Check that a single :param:arg is an allowed option. If it is allowed,
quote out any escape characters in :param:values, and add the pair to quote out any escape characters in :param:values, and add the pair to
:ivar:sanitised. :ivar:sanitised.
:type arg: C{str} :param str arg: The arguments which will be passed to the GnuPG
process, and, optionally their corresponding values.
:param arg: The arguments which will be passed to the GnuPG process, The values are any additional arguments following the
and, optionally their corresponding values. The values are GnuPG option or flag. For example, if we wanted to pass
any additional arguments following the GnuPG option or "--encrypt --recipient isis@leap.se" to gpg, then
flag. For example, if we wanted to pass "--encrypt "--encrypt" would be an arg without a value, and
--recipient isis@leap.se" to gpg, then "--encrypt" would be "--recipient" would also be an arg, with a value of
an arg without a value, and "--recipient" would also be an "isis@leap.se".
arg, with a value of "isis@leap.se". :ivar list checked: The sanitised, allowed options and values.
:type checked: C{list} :rtype: str
:ivar checked: The sanitised, allowed options and values. :returns: A string of the items in ``checked`` delimited by spaces.
:rtype: C{str}
:returns: A string of the items in :ivar:`checked` delimited by spaces.
""" """
safe_values = str() safe_values = str()