docs/source/conf.py

@@ -22,7 +22,7 @@ copyright = '2022, imacat'
 author = 'imacat'
 
 # The full version, including alpha/beta/rc tags
-release = '0.3.0'
+release = '0.2.4'
 
 
 # -- General configuration ---------------------------------------------------

setup.cfg

@@ -17,7 +17,7 @@
 
 [metadata]
 name = flask-digest-auth
-version = 0.3.0
+version = 0.2.4
 author = imacat
 author_email = imacat@mail.imacat.idv.tw
 description = The Flask HTTP Digest Authentication project.

src/flask_digest_auth/algo.py

@@ -28,7 +28,7 @@ def make_password_hash(realm: str, username: str, password: str) -> str:
     """Calculates the password hash for the HTTP digest authentication.
     Use this function to set the password for the user.
 
-    :Example:
+    For example:
 
     ::
 
@@ -54,7 +54,7 @@ def calc_response(
     :param uri: The request URI.
     :param password_hash: The password hash for the HTTP digest authentication.
     :param nonce: The nonce.
-    :param qop: The quality of protection, either ``auth`` or ``auth-int``.
+    :param qop: the quality of protection, either ``auth`` or ``auth-int``.
     :param algorithm: The algorithm, either ``MD5`` or ``MD5-sess``.
     :param cnonce: The client nonce, which must exists when qop exists or
         algorithm is ``MD5-sess``.

src/flask_digest_auth/auth.py

@@ -45,7 +45,7 @@ class DigestAuth:
             = URLSafeTimedSerializer(token_urlsafe(32))
         self.realm: str = "" if realm is None else realm
         """The realm.  Default is an empty string."""
-        self.algorithm: t.Optional[t.Literal["MD5", "MD5-sess"]] = None
+        self.algorithm: t.Optional[str] = None
         """The algorithm, either None, ``MD5``, or ``MD5-sess``.  Default is
         None."""
         self.use_opaque: bool = True
@@ -53,8 +53,7 @@ class DigestAuth:
         self.__domain: t.List[str] = []
         """A list of directories that this username and password applies to.
         Default is empty."""
-        self.__qop: t.List[t.Literal["auth", "auth-int"]] \
-            = ["auth", "auth-int"]
+        self.__qop: t.List[str] = ["auth", "auth-int"]
         """A list of supported quality of protection supported, either
         ``qop``, ``auth-int``, both, or empty.  Default is both."""
         self.app: t.Optional[Flask] = None
@@ -67,7 +66,7 @@ class DigestAuth:
     def login_required(self, view) -> t.Callable:
         """The view decorator for HTTP digest authentication.
 
-        :Example:
+        For example:
 
         ::
 
@@ -234,7 +233,7 @@ class DigestAuth:
             -> None:
         """The decorator to register the callback to obtain the password hash.
 
-        :Example:
+        For example:
 
         ::
 
@@ -266,7 +265,7 @@ class DigestAuth:
             -> None:
         """The decorator to register the callback to obtain the user.
 
-        :Example:
+        For example:
 
         ::
 
@@ -296,7 +295,7 @@ class DigestAuth:
     def register_on_login(self, func: t.Callable[[t.Any], None]) -> None:
         """The decorator to register the callback to run when the user logs in.
 
-        :Example:
+        For example:
 
         ::
 
@@ -325,7 +324,7 @@ class DigestAuth:
     def init_app(self, app: Flask) -> None:
         """Initializes the Flask application.
 
-        :Example:
+        For example:
 
         ::
 
@@ -389,7 +388,7 @@ class DigestAuth:
         This actually causes the next authentication to fail, which forces
         the browser to ask the user for the username and password again.
 
-        :Example:
+        For example:
 
         ::
 

src/flask_digest_auth/test.py

@@ -31,9 +31,7 @@ from flask_digest_auth.algo import calc_response, make_password_hash
 class Client(WerkzeugClient):
     """The test client with HTTP digest authentication enabled.
 
-    :Example:
-
-    For unittest_:
+    For unittest example:
 
     ::
 
@@ -54,7 +52,7 @@ class Client(WerkzeugClient):
                     "/admin", digest_auth=("my_name", "my_pass"))
                 self.assertEqual(response.status_code, 200)
 
-    For pytest_:
+    For pytest example:
 
     ::
 
@@ -78,19 +76,12 @@ class Client(WerkzeugClient):
                 response = client.get(
                     "/admin", digest_auth=("my_name", "my_pass"))
                 assert response.status_code == 200
-
-    .. _unittest: https://docs.python.org/3/library/unittest.html
-    .. _pytest: https://pytest.org
     """
 
     def open(self, *args, digest_auth: t.Optional[t.Tuple[str, str]] = None,
              **kwargs) -> TestResponse:
         """Opens a request.
 
-        .. warning::
-            This is to override the parent ``open`` method.  You should call
-            the ``get``, ``post``, ``put``, and ``delete`` methods instead.
-
         :param args: The arguments.
         :param digest_auth: A tuple of the username and password for the HTTP
             digest authentication.
@@ -115,9 +106,6 @@ class Client(WerkzeugClient):
                            username: str, password: str) -> Authorization:
         """Composes and returns the request authorization.
 
-        .. warning::
-            This method is not for public.
-
         :param www_authenticate: The ``WWW-Authenticate`` response.
         :param uri: The request URI.
         :param username: The username.