commit 7f6822e6860ee75cc9a431aca30fdec785df51db Author: Damian Johnson <atagar@torproject.org> Date: Sat Jun 21 15:01:20 2014 -0700 Minor hierarchy doc revisions Just a few very minor corrections for our docs. --- stem/descriptor/extrainfo_descriptor.py | 4 ++-- stem/descriptor/tordnsel.py | 4 ++++ stem/exit_policy.py | 5 ++++- stem/interpreter/__init__.py | 7 ++++++- stem/response/__init__.py | 4 ++-- 5 files changed, 18 insertions(+), 6 deletions(-) diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py index 7d562d6..5f1a974 100644 --- a/stem/descriptor/extrainfo_descriptor.py +++ b/stem/descriptor/extrainfo_descriptor.py @@ -29,8 +29,8 @@ Extra-info descriptors are available from a few sources... :: ExtraInfoDescriptor - Tor extra-info descriptor. - | |- RelayExtraInfoDescriptor - Extra-info descriptor for a relay. - | +- BridgeExtraInfoDescriptor - Extra-info descriptor for a bridge. + |- RelayExtraInfoDescriptor - Extra-info descriptor for a relay. + |- BridgeExtraInfoDescriptor - Extra-info descriptor for a bridge. | |- digest - calculates the upper-case hex digest value for our content +- get_unrecognized_lines - lines with unrecognized content diff --git a/stem/descriptor/tordnsel.py b/stem/descriptor/tordnsel.py index 07e6af4..b00edff 100644 --- a/stem/descriptor/tordnsel.py +++ b/stem/descriptor/tordnsel.py @@ -4,6 +4,10 @@ """ Parsing for `TorDNSEL <https://www.torproject.org/projects/tordnsel.html.en>`_ exit list files. + +:: + + TorDNSEL - Exit list provided by TorDNSEL """ import datetime diff --git a/stem/exit_policy.py b/stem/exit_policy.py index 7f1c052..2051995 100644 --- a/stem/exit_policy.py +++ b/stem/exit_policy.py @@ -25,7 +25,8 @@ exiting to a destination is permissible or not. For instance... :: ExitPolicy - Exit policy for a Tor relay - | + MicroExitPolicy - Microdescriptor exit policy + |- MicroExitPolicy - Microdescriptor exit policy + | |- can_exit_to - check if exiting to this destination is allowed or not |- is_exiting_allowed - check if any exiting is allowed |- summary - provides a short label, similar to a microdescriptor @@ -33,6 +34,8 @@ exiting to a destination is permissible or not. For instance... +- __iter__ - ExitPolicyRule entries that this contains ExitPolicyRule - Single rule of an exit policy chain + |- MicroExitPolicyRule - Single rule for a microdescriptor policy + | |- is_address_wildcard - checks if we'll accept any address |- is_port_wildcard - checks if we'll accept any port |- get_address_type - provides the protocol our ip address belongs to diff --git a/stem/interpreter/__init__.py b/stem/interpreter/__init__.py index 18c536e..a296163 100644 --- a/stem/interpreter/__init__.py +++ b/stem/interpreter/__init__.py @@ -6,7 +6,12 @@ Interactive interpreter for interacting with Tor directly. This adds usability features such as tab completion, history, and IRC-style functions (like /help). """ -__all__ = ['arguments', 'autocomplete', 'commands', 'help', 'msg'] +__all__ = [ + 'arguments', + 'autocomplete', + 'commands', + 'help', +] import os import sys diff --git a/stem/response/__init__.py b/stem/response/__init__.py index 98684f7..8585ac4 100644 --- a/stem/response/__init__.py +++ b/stem/response/__init__.py @@ -11,6 +11,8 @@ Parses replies from the control socket. convert - translates a ControlMessage into a particular response subclass ControlMessage - Message that's read from the control socket. + |- SingleLineResponse - Simple tor response only including a single line of information. + | |- from_str - provides a ControlMessage for the given string |- is_ok - response had a 250 status |- content - provides the parsed message content @@ -26,8 +28,6 @@ Parses replies from the control socket. |- peek_key - provides the key of the next entry |- pop - removes and returns the next entry +- pop_mapping - removes and returns the next entry as a KEY=VALUE mapping - - SingleLineResponse - Simple tor response only including a single line of information. """ __all__ = [