[tor-commits] [stem/master] Deprecate ExitPolicy's get_config_policy function

[atagar at torproject.org]

commit 9370b14bae9daae1ec917f2cd52e2d3ea6634cd1
Author: Damian Johnson <atagar at torproject.org>
Date:   Tue Apr 17 09:44:15 2018 -0700

    Deprecate ExitPolicy's get_config_policy function
    
    Great point by dmr on #25423. Now that we're no longer attempting to make sense
    of the torrc this function will become less and less reliable over time.
---
 stem/exit_policy.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/stem/exit_policy.py b/stem/exit_policy.py
index 3c13be7e..e921fb3c 100644
--- a/stem/exit_policy.py
+++ b/stem/exit_policy.py
@@ -110,6 +110,12 @@ def get_config_policy(rules, ip_address = None):
   * ports being optional
   * the 'private' keyword
 
+  .. deprecated:: 1.7.0
+
+     Tor's torrc parameters lack a formal spec, making it difficult for this
+     method to be reliable. Callers are encouraged to move to
+     :func:`~stem.control.Controller.get_exit_policy` instead.
+
   :param str,list rules: comma separated rules or list to be converted
   :param str ip_address: this relay's IP address for the 'private' policy if
     it's present, this defaults to the local address