Merge pull request #723 from OpenIDC/settings

Settings

Author: tpazderka

doc/conf.py

@@ -2,8 +2,12 @@
 
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
 ]
 
+autoclass_content = 'both'  # Merge the __init__ docstring into the class docstring.
+autodoc_member_order = 'bysource'  # Order by source ordering
+
 templates_path = ['_templates']
 
 source_suffix = '.rst'

doc/contrib/settings.rst

@@ -0,0 +1,6 @@
+Settings
+========
+
+.. automodule:: oic.utils.settings
+    :members:
+    :show-inheritance:

doc/index.rst

@@ -25,6 +25,7 @@ Getting a copy is simple with Pip_:
    examples/tls
 
    contrib/install
+   contrib/settings
    contrib/testing
    contrib/documentation
 

pylama.ini

@@ -1,9 +1,8 @@
 [pylama]
-linters = pyflakes,eradicate,pycodestyle,mccabe,pep257
-# D10X - Ignore complains about missing docstrings - we want to enforce style but do not want to add all docstrings
+linters = pyflakes,eradicate,pycodestyle,mccabe
 # D203/D204 and D212/D213 are mutually exclusive, pick one
 # E203 is not PEP8 compliant in pycodestyle
-ignore = D100,D101,D102,D103,D104,D105,D106,D107,D203,D212,E203
+ignore = D203,D212,E203
 
 [pylama:pycodestyle]
 max_line_length = 120

setup.cfg

@@ -0,0 +1,8 @@
+[pydocstyle]
+convention = google
+add-ignore =
+    D1,  # Ignore missing docstrings
+    D212,  # Multiline docstring not on first line
+    D413,  # No blank line after last section
+add-select =
+    D213  # Multiline docstring should start on first line

src/oic/extension/client.py

@@ -1,5 +1,6 @@
 import hashlib
 import logging
+import warnings
 
 from jwkest import b64e
 
@@ -13,6 +14,7 @@
 from oic.oauth2.message import ErrorResponse
 from oic.utils.http_util import SUCCESSFUL
 from oic.utils.sanitize import sanitize
+from oic.utils.settings import OauthClientSettings
 
 logger = logging.getLogger(__name__)
 
@@ -36,17 +38,26 @@ def __init__(
         client_id=None,
         client_authn_method=None,
         keyjar=None,
-        verify_ssl=True,
+        verify_ssl=None,
         config=None,
         message_factory=ExtensionMessageFactory,
+        settings=None,
     ):
+        self.settings = settings or OauthClientSettings()
+        if verify_ssl is not None:
+            warnings.warn(
+                "`verify_ssl` is deprecated, please use `settings` instead if you need to set a non-default value.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self.settings.verify_ssl = verify_ssl
         super().__init__(
             client_id=client_id,
             client_authn_method=client_authn_method,
             keyjar=keyjar,
-            verify_ssl=verify_ssl,
             config=config,
             message_factory=message_factory,
+            settings=self.settings,
         )
         self.allow = {}
         self.request2endpoint.update(

src/oic/oauth2/__init__.py

@@ -1,4 +1,5 @@
 import logging
+import warnings
 from typing import Any  # noqa - This is used for MyPy
 from typing import Dict
 from typing import List  # noqa - This is used for MyPy
@@ -53,6 +54,9 @@
 from oic.utils.keyio import KeyJar
 from oic.utils.sdb import SessionBackend  # noqa
 from oic.utils.sdb import session_update
+from oic.utils.settings import OauthClientSettings
+from oic.utils.settings import OauthServerSettings
+from oic.utils.settings import PyoidcSettings
 from oic.utils.time_util import utc_time_sans_frac
 
 __author__ = "rohe0002"
@@ -170,35 +174,61 @@ def __init__(
         client_id=None,
         client_authn_method=None,
         keyjar=None,
-        verify_ssl=True,
+        verify_ssl=None,
         config=None,
         client_cert=None,
-        timeout=5,
+        timeout=None,
         message_factory: Type[MessageFactory] = OauthMessageFactory,
+        settings: PyoidcSettings = None,
     ):
         """
         Initialize the instance.
 
+        Keyword Args:
+            settings
+                Instance of :class:`OauthClientSettings` with configuration options.
+                Currently used settings are:
+                 - verify_ssl
+                 - client_cert
+                 - timeout
+
         :param client_id: The client identifier
         :param client_authn_method: Methods that this client can use to
             authenticate itself. It's a dictionary with method names as
             keys and method classes as values.
         :param keyjar: The keyjar for this client.
-        :param verify_ssl: Whether the SSL certificate should be verified.
-        :param client_cert: A client certificate to use.
+        :param verify_ssl: Whether the SSL certificate should be verified. Deprecated in favor of settings.
+        :param client_cert: A client certificate to use. Deprecated in favor of settings.
         :param timeout: Timeout for requests library. Can be specified either as
             a single integer or as a tuple of integers. For more details, refer to
-            ``requests`` documentation.
+            ``requests`` documentation. Deprecated in favor of settings.
         :param: message_factory: Factory for message classes, should inherit from OauthMessageFactory
         :return: Client instance
+
         """
-        PBase.__init__(
-            self,
-            verify_ssl=verify_ssl,
-            keyjar=keyjar,
-            client_cert=client_cert,
-            timeout=timeout,
-        )
+        self.settings = settings or OauthClientSettings()
+        if verify_ssl is not None:
+            warnings.warn(
+                "`verify_ssl` is deprecated, please use `settings` instead if you need to set a non-default value.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self.settings.verify_ssl = verify_ssl
+        if client_cert is not None:
+            warnings.warn(
+                "`client_cert` is deprecated, please use `settings` instead if you need to set a non-default value.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self.settings.client_cert = client_cert
+        if timeout is not None:
+            warnings.warn(
+                "`timeout` is deprecated, please use `settings` instead if you need to set a non-default value.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self.settings.timeout = timeout
+        PBase.__init__(self, keyjar=keyjar, settings=self.settings)
 
         self.sso_db = None  # type: Optional[SessionBackend]
         self.client_id = client_id
@@ -1119,19 +1149,44 @@ class Server(PBase):
 
     def __init__(
         self,
-        verify_ssl: bool = True,
+        verify_ssl: bool = None,
         keyjar: KeyJar = None,
         client_cert: Union[str, Tuple[str, str]] = None,
-        timeout: int = 5,
+        timeout: float = None,
         message_factory: Type[MessageFactory] = OauthMessageFactory,
+        settings: PyoidcSettings = None,
     ):
-        """Initialize the server."""
-        super().__init__(
-            verify_ssl=verify_ssl,
-            keyjar=keyjar,
-            client_cert=client_cert,
-            timeout=timeout,
-        )
+        """
+        Initialize the server.
+
+        Keyword Args:
+            settings
+                Instance of :class:`OauthServerSettings` with configuration options.
+
+        """
+        self.settings = settings or OauthServerSettings()
+        if verify_ssl is not None:
+            warnings.warn(
+                "`verify_ssl` is deprecated, please use `settings` instead if you need to set a non-default value.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self.settings.verify_ssl = verify_ssl
+        if client_cert is not None:
+            warnings.warn(
+                "`client_cert` is deprecated, please use `settings` instead if you need to set a non-default value.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self.settings.client_cert = client_cert
+        if timeout is not None:
+            warnings.warn(
+                "`timeout` is deprecated, please use `settings` instead if you need to set a non-default value.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self.settings.timeout = timeout
+        super().__init__(keyjar=keyjar, settings=self.settings)
         self.message_factory = message_factory
 
     @staticmethod

src/oic/oauth2/base.py

@@ -1,6 +1,7 @@
 import copy
 import http.cookiejar as cookielib
 import logging
+import warnings
 from http.cookies import CookieError
 from http.cookies import SimpleCookie
 
@@ -10,6 +11,7 @@
 from oic.oauth2.util import set_cookie
 from oic.utils.keyio import KeyJar
 from oic.utils.sanitize import sanitize
+from oic.utils.settings import PyoidcSettings
 
 __author__ = "roland"
 
@@ -19,10 +21,22 @@
 class PBase(object):
     """Class for OAuth2 clients and servers."""
 
-    def __init__(self, verify_ssl=True, keyjar=None, client_cert=None, timeout=5):
+    def __init__(
+        self,
+        verify_ssl=None,
+        keyjar=None,
+        client_cert=None,
+        timeout=None,
+        settings: PyoidcSettings = None,
+    ):
         """
         Initialize the instance.
 
+        Keyword Args:
+            settings
+                Instance of :class:`PyoidcSettings` with configuration options.
+
+        Note that the following params are deprecated in favor of settings.
         :param verify_ssl: Control TLS server certificate validation. If set to
             True the certificate is validated against the global settings,
             if set to False, no validation is performed. If set to a filename
@@ -37,17 +51,41 @@ def __init__(self, verify_ssl=True, keyjar=None, client_cert=None, timeout=5):
         :param timeout: Timeout for requests library. Can be specified either as
             a single integer or as a tuple of integers. For more details, refer to
             ``requests`` documentation.
+
         """
-        self.keyjar = keyjar or KeyJar(verify_ssl=verify_ssl)
+        self.settings = settings or PyoidcSettings()
+        if verify_ssl is not None:
+            warnings.warn(
+                "`verify_ssl` is deprecated, please use `settings` instead if you need to set a non-default value.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self.settings.verify_ssl = verify_ssl
+        if client_cert is not None:
+            warnings.warn(
+                "`client_cert` is deprecated, please use `settings` instead if you need to set a non-default value.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self.settings.client_cert = client_cert
+        if timeout is not None:
+            warnings.warn(
+                "`timeout` is deprecated, please use `settings` instead if you need to set a non-default value.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self.settings.timeout = timeout
+
+        self.keyjar = keyjar or KeyJar(verify_ssl=self.settings.verify_ssl)
 
         self.cookiejar = cookielib.FileCookieJar()
 
         # Additional args for the requests library calls
         self.request_args = {
             "allow_redirects": False,
-            "cert": client_cert,
-            "verify": verify_ssl,
-            "timeout": timeout,
+            "cert": self.settings.client_cert,
+            "verify": self.settings.verify_ssl,
+            "timeout": self.settings.timeout,
         }
 
         # Event collector, for tracing
@@ -84,7 +122,7 @@ def http_request(self, url, method="GET", **kwargs):
 
         if self.cookiejar:
             _kwargs["cookies"] = self._cookies()
-            logger.debug("SENT {} COOKIES".format(len(_kwargs["cookies"])))
+            logger.debug("SENT %s COOKIES", len(_kwargs["cookies"]))  # type: ignore
 
         if self.req_callback is not None:
             _kwargs = self.req_callback(method, url, **_kwargs)