Merge pull request #250 from statisticsnorway/reset_auth

Author: aecorn

.pre-commit-config.yaml

@@ -1,76 +1,41 @@
 default_language_version:
-  python: python3.10
+  python: python3.11
 repos:
-  - repo: local
+  # Pre-commit maintained utility hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
     hooks:
-      # General file checkers
       - id: check-added-large-files
-        name: Check added large files
-        entry: check-added-large-files
-        language: system
       - id: check-merge-conflict
-        name: Check for merge conflict strings
-        entry: check-merge-conflict
-        language: system
       - id: check-case-conflict
-        name: Check for problematic file names
-        entry: check-case-conflict
-        language: system
-
-      # General text checkers
       - id: end-of-file-fixer
-        name: Fix End of Files
-        entry: end-of-file-fixer
-        language: system
         types: [text]
       - id: trailing-whitespace
-        name: Trim Trailing Whitespace
-        entry: trailing-whitespace-fixer
-        language: system
         types: [text]
       - id: mixed-line-ending
-        name: Mixed Line Ending
-        entry: mixed-line-ending
-        language: system
         types: [text]
-
-      # Serialization format checkers
       - id: check-yaml
-        name: Check Yaml
-        entry: check-yaml
-        language: system
-        types: [yaml]
       - id: check-json
-        name: Check JSON
-        entry: check-json
-        language: system
-        types: [json]
       - id: check-toml
-        name: Check Toml
-        entry: check-toml
-        language: system
-        types: [toml]
-
-      # Python tools
       - id: check-ast
-        name: Check Python syntax
-        entry: check-ast
-        language: system
-        types: [python]
+
+  # Darglint docstring checker
+  - repo: https://github.com/terrencepreilly/darglint
+    rev: v1.8.1
+    hooks:
       - id: darglint
-        name: darglint
-        entry: darglint
-        language: system
-        types: [python]
+
+  # Ruff linter
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
       - id: ruff
-        name: ruff
-        entry: ruff check --fix --exit-non-zero-on-fix
-        language: system
-        types_or: [python, jupyter]
+        args: ["--fix", "--exit-non-zero-on-fix"]
         require_serial: true
+
+  # Black formatter
+  - repo: https://github.com/psf/black
+    rev: 24.10.0
+    hooks:
       - id: black
-        name: black
-        entry: black
-        language: system
-        types_or: [python, jupyter]
         require_serial: true

CONTRIBUTING.md

@@ -119,6 +119,68 @@ To run linting and code formatting checks before committing your change, you can
 nox --session=pre-commit -- install
 ```
 
+
+
+
+
+## Project setup
+
+### Poetry venv
+Installing the dev-dependencies in a new environment can be done with the following command:
+```bash
+poetry install --with dev
+```
+
+Or if you want to call nox with poetry and pass pytest flags through...
+```bash
+poetry run nox -p 3.11
+```
+
+The marker "integration_dapla" is for running specific tests locally on a dapla. They are placed in tests/test_integration_dapla.py .\
+Use this flag in the command-line call to avoid running them on other platforms.
+
+
+### Pytest coverage
+```bash
+poetry run nox -s tests ypy -p 3.11
+```
+Run this when developing tests.
+If you achieve a higher testing coverage make sure to increase the threshold in the workflow.
+.github/workflows/tests.yml
+(at the bottom)
+
+### Running the pre-commit hooks locally
+```bash
+poetry run nox -s pre-commit -p 3.11
+```
+Several of the pre-commit hooks will try to modify the files on a fail. Re-running the command might therefore result in a different result the second time.
+
+### Type-checking with Mypy
+```bash
+poetry run nox -s mypy -p 3.11
+```
+
+## Publish new version of package to Pypi
+
+The action to publish to Pypi is connected with a workflow to releases from Github.
+So to publish to Pypi, make sure everything is done, and in the main branch, bump the version in pyproject.toml, add a tag and release on Github.
+
+## Rebuild docs
+Necessary if you have changed the package at the submodule-level.
+
+The content of the {eval-rst} block below is generated by the command:
+```bash
+poetry run sphinx-apidoc -T -f -t ./docs/templates -o ./docs ./src
+```
+from the root directory.
+
+
+
+### Bump version
+```bash
+poetry version patch
+```
+
 It is recommended to open an issue before starting work on anything.
 This will allow a chance to talk it over with the owners and validate your approach.
 

DEV_README.md

@@ -6,7 +6,7 @@
 #       extension: .py
 #       format_name: percent
 #       format_version: '1.3'
-#       jupytext_version: 1.15.2
+#       jupytext_version: 1.18.1
 #   kernelspec:
 #     display_name: dapla-statbank-client
 #     language: python

demo/01_enkleste_bruk.py

@@ -64,14 +64,6 @@ statbank.globals module
    :undoc-members:
    :show-inheritance:
 
-statbank.netrc module
----------------------
-
-.. automodule:: statbank.netrc
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 statbank.response\_to\_pandas module
 ------------------------------------
 
@@ -111,3 +103,14 @@ statbank.uttrekk\_validations module
    :members:
    :undoc-members:
    :show-inheritance:
+
+statbank.writable\_netrc module
+-------------------------------
+
+.. automodule:: statbank.writable_netrc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+```

docs/reference.md

@@ -1,3 +1,37 @@
+from typing import Any
+
+import requests
+
+
+class StatbankAuthError(requests.HTTPError):
+    """Raised when authentication with Statbank fails.
+
+    Extends ``requests.HTTPError`` with an optional ``response_content`` attribute
+    that can hold parsed JSON from the response.
+
+    Args:
+        *args: Positional arguments forwarded to ``requests.HTTPError``.
+        response_content: Optional JSON-decoded payload to attach.
+        **kwargs: Keyword arguments forwarded to ``requests.HTTPError``.
+    """
+
+    def __init__(
+        self,
+        *args: Any,
+        response_content: dict[str, Any] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        """Initialize the Statbank authentication error.
+
+        Args:
+            *args: Positional arguments forwarded to ``requests.HTTPError``.
+            response_content: Optional JSON-decoded payload to attach.
+            **kwargs: Keyword arguments forwarded to ``requests.HTTPError``.
+        """
+        super().__init__(*args, **kwargs)
+        self.response_content: dict[str, Any] | None = response_content
+
+
 class StatbankApiError(Exception):
     """Base class for Statbank Api Errors."""
 

src/statbank/api_exceptions.py

@@ -18,6 +18,7 @@
 from dapla_auth_client import AuthClient
 from furl import furl
 
+from .api_exceptions import StatbankAuthError
 from .globals import DaplaEnvironment
 from .globals import DaplaRegion
 from .globals import UseDb
@@ -175,7 +176,7 @@ def _build_headers(self: Self) -> dict[str, str]:
         }
 
     def _get_auth(self) -> requests.auth.AuthBase:
-        host = cast(str, self._config.endpoint_base.host)  # noqa: TC006
+        host = cast(str, self._config.endpoint_base.host)
 
         with Netrc(self._config.netrc_path) as authfile:
             auth_record = authfile[host]
@@ -196,6 +197,50 @@ def _get_auth(self) -> requests.auth.AuthBase:
             ),  # Can be None in Python 3.10
         )
 
+    def reset_auth(self) -> None:
+        """Reset the auth by removing the entry from the .netrc-file first, then asking to enter the username and password again."""
+        self._cleanup_netrc()
+        self._auth = self._get_auth()
+
+    def _cleanup_netrc(self) -> None:
+        host = cast("str", self._config.endpoint_base.host)
+        with Netrc(self._config.netrc_path) as authfile:
+            if host in authfile:
+                del authfile[host]
+
+    def _react_to_httperror_should_retry(
+        self,
+        e: requests.HTTPError | StatbankAuthError,
+    ) -> bool:
+        default_err_msg = """Got an http-error, but it does not look like an account-lock or invalid password/username,
+        is this something we should program for?
+        If you want to reset the auth manually call StatbankClient().reset_auth() or
+        StatbankAuth().reset_auth(). Alternatively edit the .netrc file directly.""".replace(
+            "\n",
+            "",
+        )
+
+        if hasattr(e, "response_content") and e.response_content:
+            if "ORA-28000" in e.response_content.get("ExceptionMessage", ""):
+                err_msg = f'Your account has been locked. Contact kundeservice@ssb.no to unlock. Resetting auth. Errortext: {e.response_content.get("ExceptionMessage", "")}'
+                logger.error(err_msg)
+                new_err = StatbankAuthError(err_msg)
+                self._cleanup_netrc()
+                raise new_err
+            if "ORA-01017" in e.response_content.get("ExceptionMessage", ""):
+                logger.error(
+                    f"TYPE CAREFULLY - The username and password you used may have been wrong. Resetting Auth. Errortext: {e.response_content.get('ExceptionMessage', '')}",
+                )
+                self.reset_auth()
+                return True
+            logger.error(
+                f"{default_err_msg}{e.response_content.get('Exception_message', '')} - {e} ",
+            )
+        else:
+            logger.error(f"{default_err_msg}{e}.")
+
+        raise e
+
     def _encrypt_password(self: Self, password: str) -> str:
         pat = None
 
@@ -207,16 +252,16 @@ def _encrypt_password(self: Self, password: str) -> str:
 
         auth = TokenAuth(pat) if pat is not None else None
 
-        repsonse = r.post(
+        response = r.post(
             self._config.encrypt_url.url,
             auth=auth,
             json={"message": password},
             timeout=30,
         )
 
-        repsonse.raise_for_status()
+        response.raise_for_status()
 
-        data = cast(dict[Literal["message"], str], repsonse.json())  # noqa: TC006
+        data = cast('dict[Literal["message"], str]', response.json())
 
         return data["message"]