May 2014 - tor-commits - lists.torproject.org

[bridgedb/master] Update bridgedb.parse package docstring.
by isis＠torproject.org 16 May '14

16 May '14

commit 6cb45e1cf623fe942c7e9a018192132909eba386 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:13:29 2014 +0000 Update bridgedb.parse package docstring. --- lib/bridgedb/parse/__init__.py | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) diff --git a/lib/bridgedb/parse/__init__.py b/lib/bridgedb/parse/__init__.py index 0618dae..90698ed 100644 --- a/lib/bridgedb/parse/__init__.py +++ b/lib/bridgedb/parse/__init__.py @@ -9,22 +9,11 @@ # (c) 2007-2013, all entities within the AUTHORS file # :license: 3-clause BSD, see included LICENSE for information -"""Modules for parsing data. - -** Package Overview: ** - -.. - parse - ||_ parse.addr - | |_ isIPAddress - Check if an arbitrary string is an IP address. - | |_ isIPv4 - Check if an arbitrary string is an IPv4 address. - | |_ isIPv6 - Check if an arbitrary string is an IPv6 address. - | \_ isValidIP - Check that an IP address is valid. - | - |__ :mod:`bridgedbparse.headers` - |__ :mod:`bridgedb.parse.options` - \__ :mod:`bridgedb.parse.versions` -""" +'''Package containing modules for parsing data. + +.. py:module:: bridgedb.parse + :synopsis: Package containing modules for parsing data. +''' from __future__ import absolute_import from __future__ import print_function

1 0

[bridgedb/master] Update module attribute docstrings in bridgedb.parse.addr.
by isis＠torproject.org 16 May '14

16 May '14

commit 451289fa36d6ea48c55e42f66e0bd63563535f6d Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:15:41 2014 +0000 Update module attribute docstrings in bridgedb.parse.addr. --- lib/bridgedb/parse/addr.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/bridgedb/parse/addr.py b/lib/bridgedb/parse/addr.py index a9c62cc..26632ac 100644 --- a/lib/bridgedb/parse/addr.py +++ b/lib/bridgedb/parse/addr.py @@ -184,15 +184,17 @@ import ipaddr #: These are the special characters which RFC2822 allows within email addresses: -#ASPECIAL = '!#$%&*+-/=?^_`{|}~' + "\\\'" -#: These are the ones we're pretty sure we can handle right: +#: ASPECIAL = '!#$%&*+-/=?^_`{|}~' + "\\\'" +#: …But these are the only ones we're confident that we can handle correctly: +#: ASPECIAL = '-_+/=_~' ASPECIAL = '-_+/=_~' ACHAR = r'[\w%s]' % "".join("\\%s" % c for c in ASPECIAL) DOTATOM = r'%s+(?:\.%s+)*' % (ACHAR, ACHAR) DOMAIN = r'\w+(?:\.\w+)*' ADDRSPEC = r'(%s)\@(%s)' % (DOTATOM, DOMAIN) +# A compiled regexp which matches on any type and ammount of whitespace: SPACE_PAT = re.compile(r'\s+') -#: A compiled regex with matches RFC2822 email address strings: +# A compiled regexp which matches RFC2822 email address strings: ADDRSPEC_PAT = re.compile(ADDRSPEC)

1 0

[bridgedb/master] Update Sphinx formatting in docstrings in bridgedb.parse.headers.
by isis＠torproject.org 16 May '14

16 May '14

commit bee3de9793a093cd705a276e00c6a4c31f8fe00b Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:16:47 2014 +0000 Update Sphinx formatting in docstrings in bridgedb.parse.headers. --- lib/bridgedb/parse/headers.py | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/lib/bridgedb/parse/headers.py b/lib/bridgedb/parse/headers.py index b557372..5c3597a 100644 --- a/lib/bridgedb/parse/headers.py +++ b/lib/bridgedb/parse/headers.py @@ -9,14 +9,17 @@ # (c) 2007-2013, all entities within the AUTHORS file # :license: 3-clause BSD, see included LICENSE for information -"""bridgedb.parse.headers -- Parsers for HTTP and Email headers. +"""Parsers for HTTP and Email headers. -** Module Overview: ** +.. py:module:: bridgedb.parse.headers + :synopsis: Parsers for HTTP and Email headers. +bridgedb.parse.headers +======================= :: parseAcceptLanguage - Parse the contents of a client 'Accept-Language' header - +.. """ def parseAcceptLanguage(header): @@ -24,15 +27,15 @@ def parseAcceptLanguage(header): Parse the header in the following manner: - 0. If ``header`` is None or an empty string, return an empty list. - 1. Split the ``header`` string on any commas. - 2. Chop of the RFC2616 quality/level suffix. We ignore these, and just - use the order of the list as the preference order, without any - parsing of quality/level assignments. - 3. Add a fallback language of the same type if it is missing. For - example, if we only got ['es-ES', 'de-DE'], add 'es' after 'es-ES' - and add 'de' after 'de-DE'. - 4. Change all hyphens to underscores. + 1. If ``header`` is None or an empty string, return an empty list. + 2. Split the ``header`` string on any commas. + 3. Chop of the RFC2616 quality/level suffix. We ignore these, and just + use the order of the list as the preference order, without any + parsing of quality/level assignments. + 4. Add a fallback language of the same type if it is missing. For + example, if we only got ['es-ES', 'de-DE'], add 'es' after 'es-ES' + and add 'de' after 'de-DE'. + 5. Change all hyphens to underscores. :param string header: The contents of an 'Accept-Language' header, i.e. as if taken from :api:`twisted.web.server.Request.getHeader`.

1 0

[bridgedb/master] Update bridgedb.parse.padBase64() docstring.
by isis＠torproject.org 16 May '14

16 May '14

commit 06c2a831dcad901e7dbc94374fcedd4caad9cf99 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:14:26 2014 +0000 Update bridgedb.parse.padBase64() docstring. --- lib/bridgedb/parse/__init__.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/bridgedb/parse/__init__.py b/lib/bridgedb/parse/__init__.py index e8b8069..ae9b559 100644 --- a/lib/bridgedb/parse/__init__.py +++ b/lib/bridgedb/parse/__init__.py @@ -30,10 +30,10 @@ def padBase64(b64string): """Re-add any stripped equals sign character padding to a b64 string. :param string b64string: A base64-encoded string which might have had its - trailing equals sign padding removed. - :raises: :exc:`ValueError` if there was any error while manipulating the + trailing equals sign (``=``) padding removed. + :raises ValueError: if there was any error while manipulating the string. + :returns: A properly-padded (according to the base64 spec: :rfc:`4648`) string. - :returns: A properly-padded (according to base64) string. """ addchars = 0 try:

1 0

[bridgedb/master] PEP8 whitespace fixes on module docstring bridgedb.parse.versions.
by isis＠torproject.org 16 May '14

16 May '14

commit 77f5da56ed877b79a9420478f43003aa5309036d Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:19:34 2014 +0000 PEP8 whitespace fixes on module docstring bridgedb.parse.versions. --- lib/bridgedb/parse/versions.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/parse/versions.py b/lib/bridgedb/parse/versions.py index e71df97..1d05ae1 100644 --- a/lib/bridgedb/parse/versions.py +++ b/lib/bridgedb/parse/versions.py @@ -12,13 +12,14 @@ """Parsers for Tor version number strings. .. py:module:: bridgedb.parse.versions - :synopsis: Parsers for Tor version number strings. + :synopsis: Parsers for Tor version number strings. bridgedb.parse.versions ======================= :: - Version - Holds, parses, and does comparison operations for package version numbers. + Version - Holds, parses, and does comparison operations for package + version numbers. .. """

1 0

[bridgedb/master] Update bridgedb.parse.addr.extractEmailAddress docstring.
by isis＠torproject.org 16 May '14

16 May '14

commit 17cbc0a0eb10e84401d72ddcae8bb871c16a7c13 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:16:11 2014 +0000 Update bridgedb.parse.addr.extractEmailAddress docstring. --- lib/bridgedb/parse/addr.py | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/lib/bridgedb/parse/addr.py b/lib/bridgedb/parse/addr.py index 26632ac..a354387 100644 --- a/lib/bridgedb/parse/addr.py +++ b/lib/bridgedb/parse/addr.py @@ -242,15 +242,15 @@ def canonicalizeEmailDomain(domain, domainmap): return permitted def extractEmailAddress(emailaddr): - """Given an email address, obtained, for example, via a ``From:`` or + """Given an email address, obtained for example, via a ``From:`` or ``Sender:`` email header, try to extract and parse (according to - :rfc:2822) the username and domain portions. Returns ``(username, - domain)`` on success; raises BadEmail on failure. + :rfc:`2822`) the local and domain portions. We only allow the following form:: - ADDRSPEC := LOCAL_PART "@" DOMAIN + LOCAL_PART := DOTATOM DOMAIN := DOTATOM + ADDRSPEC := LOCAL_PART "@" DOMAIN In particular, we are disallowing: obs-local-part, obs-domain, comment, and obs-FWS. Other forms exist, but none of the incoming services we @@ -258,10 +258,9 @@ def extractEmailAddress(emailaddr): :param emailaddr: An email address to validate. :raises BadEmail: if the **emailaddr** couldn't be validated or parsed. - :rtype: tuple :returns: A tuple of the validated email address, containing the mail - username and the domain:: - (LOCALPART, DOMAIN) + local part and the domain:: + (LOCAL_PART, DOMAIN) """ orig = emailaddr

1 0

[bridgedb/master] Merge branch 'hotfix/11522-gpg-signing' into develop
by isis＠torproject.org 16 May '14

16 May '14

commit e1b5588e0ca71834c062cd7b7633871993fd0bf9 Merge: 77f5da5 fafbdc7 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Apr 23 01:46:38 2014 +0000 Merge branch 'hotfix/11522-gpg-signing' into develop lib/bridgedb/crypto.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)

1 0

[bridgedb/master] Add module docstring for bridgedb.parse.options.
by isis＠torproject.org 16 May '14

16 May '14

commit 6cbf20b0442206ff777cdddfb2de123e03e82ff1 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:18:02 2014 +0000 Add module docstring for bridgedb.parse.options. --- lib/bridgedb/parse/options.py | 35 +++++++++++++++++++++++++++++++---- 1 file changed, 31 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/parse/options.py b/lib/bridgedb/parse/options.py index 0285184..3b1004d 100644 --- a/lib/bridgedb/parse/options.py +++ b/lib/bridgedb/parse/options.py @@ -8,10 +8,37 @@ # (c) 2007-2013, all entities within the AUTHORS file # :license: 3-clause BSD, see included LICENSE for information -"""Classes for commandline options parsing. - -** Module Overview: ** - +"""Parsers for BridgeDB commandline options. + +.. py:module:: bridgedb.parse.options + :synopsis: Parsers for BridgeDB commandline options. + + +bridgedb.parse.options +====================== +:: + + bridgedb.parse.options + |__ setConfig() + |__ getConfig() - Set/Get the config file path. + |__ setRundir() + |__ getRundir() - Set/Get the runtime directory. + |__ parseOptions() - Create the main options parser for BridgeDB. + | + \_ BaseOptions - Base options, included in all other options menus. + || + |\__ findRundirAndConfigFile() - Find the absolute path of the config + | file and runtime directory, or find + | suitable defaults. + | + |__ SIGHUPOptions - Menu to explain SIGHUP signal handling and usage. + |__ SIGUSR1Options - Menu to explain SIGUSR1 handling and usage. + | + |__ MockOptions - Suboptions for creating fake bridge descriptors for + | testing purposes. + |__ TestOptions - Suboptions for running twisted.trial based unittests. + \__ MainOptions - Main commandline options parser for BridgeDB. +.. """ from __future__ import print_function

1 0

[bridgedb/master] Fix typo in b.p.o.BaseOptions.findRundirAndConfigFile() docstring.
by isis＠torproject.org 16 May '14

16 May '14

commit c8b2da1b4ae8bb6ffe4a053704e4fc8c2fa8d0bd Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:18:34 2014 +0000 Fix typo in b.p.o.BaseOptions.findRundirAndConfigFile() docstring. --- lib/bridgedb/parse/options.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/parse/options.py b/lib/bridgedb/parse/options.py index 3b1004d..5664460 100644 --- a/lib/bridgedb/parse/options.py +++ b/lib/bridgedb/parse/options.py @@ -174,8 +174,8 @@ class BaseOptions(usage.Options): @staticmethod def findRundirAndConfigFile(rundir=None, config=None): - """Find the abspath of the config file and runtime directory, or find - suitable defaults. + """Find the absolute path of the config file and runtime directory, or + find suitable defaults. Attempts to set the absolute path of the runtime directory. If the config path is relative, its absolute path is set relative to the

1 0

[bridgedb/master] Update bridgedb.parse.parseUnpaddedBase64() docstring.
by isis＠torproject.org 16 May '14

16 May '14

commit 67d1301ab9769e804687fc8be52f60dc50e29818 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:14:45 2014 +0000 Update bridgedb.parse.parseUnpaddedBase64() docstring. --- lib/bridgedb/parse/__init__.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/bridgedb/parse/__init__.py b/lib/bridgedb/parse/__init__.py index ae9b559..0f3f20d 100644 --- a/lib/bridgedb/parse/__init__.py +++ b/lib/bridgedb/parse/__init__.py @@ -56,9 +56,9 @@ def parseUnpaddedBase64(field): The **field** will be re-padded, if need be, and then base64 decoded. :param str field: Should be some base64-encoded thing, with any trailing - '=' characters removed. - :raises: :exc:`InvalidBase64`, if there is an error in either unpadding or - decoding **field**. + ``=``-characters removed. + :raises InvalidBase64: if there is an error in either unpadding or decoding + **field**. :rtype: str :returns: The base64-decoded **field**. """

1 0