From: Christian Herdtweck Date: Wed, 6 Apr 2022 10:44:17 +0000 (+0200) Subject: Update deprecation warnings X-Git-Tag: v1.7.1~6 X-Git-Url: http://developer.intra2net.com/git/?p=pyi2ncommon;a=commitdiff_plain;h=b7e04a3e3b28029695838e1462b971877673ada2 Update deprecation warnings Parts of arnied_wrapper will have to stay. However, simple_cnf, mk_config and cnfline are to be removed, too. Also make other warnings a proper reST note. --- diff --git a/src/arnied_wrapper.py b/src/arnied_wrapper.py index cf51f16..e033aaf 100644 --- a/src/arnied_wrapper.py +++ b/src/arnied_wrapper.py @@ -24,8 +24,10 @@ SUMMARY ------------------------------------------------------ Guest utility to wrap arnied related functionality through python calls. -DEPRECATED! Please do not extend this or add new uses of this module, use -:py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` instead! +.. note:: Partially DEPRECATED! Use :py:mod:`pyi2ncommon.arnied_api` or + :py:mod:`pyi2ncommon.cnfvar` whenever possible. In particluar, do not + use or extend functionality regarding configuration (`get_cnf`, + `set_cnf`). Copyright: Intra2net AG diff --git a/src/cnfline/build_cnfvar.py b/src/cnfline/build_cnfvar.py index 064bf41..8402f52 100644 --- a/src/cnfline/build_cnfvar.py +++ b/src/cnfline/build_cnfvar.py @@ -18,7 +18,12 @@ # # Copyright (c) 2016-2018 Intra2net AG -"""Basic functions for on-the-fly arnied cnf-var generator""" +"""Basic functions for on-the-fly arnied cnf-var generator. + +.. note:: DEPRECATED! Please do not extend this or add new uses of this module, + use :py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` + instead! +""" from .cnfline import CnfLine diff --git a/src/cnfline/build_provider.py b/src/cnfline/build_provider.py index 3dab464..db051a1 100644 --- a/src/cnfline/build_provider.py +++ b/src/cnfline/build_provider.py @@ -20,6 +20,10 @@ """ Create provider profiles. + +.. note:: DEPRECATED! Please do not extend this or add new uses of this module, + use :py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` + instead! """ from . import build_cnfvar diff --git a/src/cnfline/build_proxy_accesslist.py b/src/cnfline/build_proxy_accesslist.py index c73a5d3..1b0a838 100644 --- a/src/cnfline/build_proxy_accesslist.py +++ b/src/cnfline/build_proxy_accesslist.py @@ -18,6 +18,12 @@ # # Copyright (c) 2016-2018 Intra2net AG +""" +.. note:: DEPRECATED! Please do not extend this or add new uses of this module, + use :py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` + instead! +""" + from .build_cnfvar import BuildCnfVar """Class to create proxy accesslists on the fly""" diff --git a/src/cnfline/build_proxy_profile.py b/src/cnfline/build_proxy_profile.py index 7a821a2..93c9ccf 100644 --- a/src/cnfline/build_proxy_profile.py +++ b/src/cnfline/build_proxy_profile.py @@ -18,6 +18,12 @@ # # Copyright (c) 2016-2018 Intra2net AG +""" +.. note:: DEPRECATED! Please do not extend this or add new uses of this module, + use :py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` + instead! +""" + from .build_cnfvar import BuildCnfVar """Class to create proxy profiles on the fly""" diff --git a/src/cnfline/build_user.py b/src/cnfline/build_user.py index d4910d1..3daf729 100644 --- a/src/cnfline/build_user.py +++ b/src/cnfline/build_user.py @@ -18,6 +18,12 @@ # # Copyright (c) 2016-2018 Intra2net AG +""" +.. note:: DEPRECATED! Please do not extend this or add new uses of this module, + use :py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` + instead! +""" + from .build_cnfvar import BuildCnfVar """Class to create user cnfvar objects on the fly""" diff --git a/src/cnfline/build_vpnconn.py b/src/cnfline/build_vpnconn.py index f7af569..5037ab2 100644 --- a/src/cnfline/build_vpnconn.py +++ b/src/cnfline/build_vpnconn.py @@ -20,6 +20,10 @@ """ Create vpn connections. + +.. note:: DEPRECATED! Please do not extend this or add new uses of this module, + use :py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` + instead! """ from . import build_cnfvar diff --git a/src/cnfline/cnfline.py b/src/cnfline/cnfline.py index 8dda1fb..fa25136 100644 --- a/src/cnfline/cnfline.py +++ b/src/cnfline/cnfline.py @@ -18,6 +18,12 @@ # # Copyright (c) 2016-2018 Intra2net AG +""" +.. note:: DEPRECATED! Please do not extend this or add new uses of this module, + use :py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` + instead! +""" + class CnfLine(object): """Represents an arnied cnfline""" diff --git a/src/cnfline/configure_proxy_antivirus.py b/src/cnfline/configure_proxy_antivirus.py index 7f5e95c..1a97ccf 100644 --- a/src/cnfline/configure_proxy_antivirus.py +++ b/src/cnfline/configure_proxy_antivirus.py @@ -18,6 +18,12 @@ # # Copyright (c) 2016-2018 Intra2net AG +""" +.. note:: DEPRECATED! Please do not extend this or add new uses of this module, + use :py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` + instead! +""" + from .build_cnfvar import BuildCnfVar """Class to configure the proxy antivirus cnfvars on the fly""" diff --git a/src/cnfline/configure_webfilter.py b/src/cnfline/configure_webfilter.py index 905039f..3aa73f0 100644 --- a/src/cnfline/configure_webfilter.py +++ b/src/cnfline/configure_webfilter.py @@ -18,6 +18,12 @@ # # Copyright (c) 2016-2018 Intra2net AG +""" +.. note:: DEPRECATED! Please do not extend this or add new uses of this module, + use :py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` + instead! +""" + from .build_cnfvar import BuildCnfVar """Class to configure the webfilter cnfvars on the fly""" diff --git a/src/cnfvar_old.py b/src/cnfvar_old.py index 29b7629..75eff5e 100644 --- a/src/cnfvar_old.py +++ b/src/cnfvar_old.py @@ -26,8 +26,9 @@ summary ------------------------------------------------------------------------------- Represent CNF_VARs as recursive structures. -DEPRECATED! Please do not extend this or add new uses of this module, use -:py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` instead! +.. note:: DEPRECATED! Please do not extend this or add new uses of this module, + use :py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` + instead! Copyright: 2014-2017 Intra2net AG License: GPLv2+ diff --git a/src/mk_config.py b/src/mk_config.py index 4bd44bc..47860d9 100644 --- a/src/mk_config.py +++ b/src/mk_config.py @@ -24,6 +24,10 @@ SUMMARY ------------------------------------------------------ Utility for one-step dynamic cnfvar configuration. +.. note:: DEPRECATED! Please do not extend this or add new uses of this module, + use :py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` + instead! + Copyright: Intra2net AG diff --git a/src/simple_cnf.py b/src/simple_cnf.py index f3a48e9..572866e 100644 --- a/src/simple_cnf.py +++ b/src/simple_cnf.py @@ -24,8 +24,9 @@ SUMMARY ------------------------------------------------------ Read / write / merge guest cnf var sets, even on host. -DEPRECATED! Please do not extend this or add new uses of this module, use -:py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` instead! +.. note:: DEPRECATED! Please do not extend this or add new uses of this module, + use :py:mod:`pyi2ncommon.arnied_api` or :py:mod:`pyi2ncommon.cnfvar` + instead! Copyright: Intra2net AG