commit 7f4b7a93d2ff55388a8566919fc19baf2f1a48df Author: Damian Johnson <atagar@torproject.org> Date: Sat Mar 9 22:47:05 2013 -0800 Marking the log, proc, term, and tor_tools utils as being private More modules that I'd rather not yet vend to stem users. They're more than welcome to use them, but I can't yet promise a stable API (and in many of these cases there's little reason they ever should be used outside of stem). --- docs/api.rst | 4 ---- stem/util/log.py | 4 ++++ stem/util/proc.py | 3 +++ stem/util/term.py | 3 +++ stem/util/tor_tools.py | 3 +++ 5 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 6ea028a..82dba0c 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -42,10 +42,6 @@ Utilities * `stem.util.conf <api/util/conf.html>`_ - Configuration file handling. * `stem.util.connection <api/util/connection.html>`_ - Connection and IP related utilities. * `stem.util.enum <api/util/enum.html>`_ - Enumeration class. -* `stem.util.log <api/util/log.html>`_ - Logging utilities. -* `stem.util.proc <api/util/proc.html>`_ - Tools to read a process' proc contents. * `stem.util.str_tools <api/util/str_tools.html>`_ - String utilities. * `stem.util.system <api/util/system.html>`_ - Tools related to the local system. -* `stem.util.term <api/util/term.html>`_ - Tools for interacting with the terminal. -* `stem.util.tor_tools <api/util/tor_tools.html>`_ - Helper functions for working with tor. diff --git a/stem/util/log.py b/stem/util/log.py index e32c42f..5dc54be 100644 --- a/stem/util/log.py +++ b/stem/util/log.py @@ -5,6 +5,10 @@ Functions to aid library logging. The default logging :data:`~stem.util.log.Runlevel` is usually NOTICE and above. +**Stem users are more than welcome to listen for stem events, but these +functions are not being vended to our users. They may change in the future, use +them at your own risk.** + **Module Overview:** :: diff --git a/stem/util/proc.py b/stem/util/proc.py index bf7675d..e165b89 100644 --- a/stem/util/proc.py +++ b/stem/util/proc.py @@ -12,6 +12,9 @@ The method for reading these files (and a little code) are borrowed from `psutil <https://code.google.com/p/psutil/>`_, which was written by Jay Loden, Dave Daeschler, Giampaolo Rodola' and is under the BSD license. +**These functions are not being vended to stem users. They may change in the +future, use them at your own risk.** + **Module Overview:** :: diff --git a/stem/util/term.py b/stem/util/term.py index fee7596..5f54b5d 100644 --- a/stem/util/term.py +++ b/stem/util/term.py @@ -4,6 +4,9 @@ """ Utilities for working with the terminal. +**These functions are not being vended to stem users. They may change in the +future, use them at your own risk.** + **Module Overview:** :: diff --git a/stem/util/tor_tools.py b/stem/util/tor_tools.py index 9c0f572..3f6ab79 100644 --- a/stem/util/tor_tools.py +++ b/stem/util/tor_tools.py @@ -5,6 +5,9 @@ """ Miscellaneous utility functions for working with tor. +**These functions are not being vended to stem users. They may change in the +future, use them at your own risk.** + **Module Overview:** ::