Evaluating ruff

.devcontainer/devcontainer.json

@@ -1,7 +1,7 @@
 {
 	"name": "Python 3",
 	"build": {
-		"dockerfile": "Dockerfile",
+		"dockerfile": "Dockerfile"
 	},
 	"customizations": {
 		"vscode": {
@@ -22,7 +22,8 @@
 				"streetsidesoftware.code-spell-checker",
 				"streetsidesoftware.code-spell-checker-swedish",
 				"ms-vscode.makefile-tools",
-				"ms-python.isort"
+				"ms-python.isort",
+				"charliermarsh.ruff"
 			]
 		}
 	},

requirements/test_requirements.in

@@ -14,3 +14,4 @@ pytest-cov
 respx
 pip-tools
 motor-types
+ruff

ruff.toml

@@ -0,0 +1,3 @@
+# Set the maximum line length to 120.
+line-length = 120
+target-version = "py310"

src/eduid/common/clients/__init__.py

@@ -2,3 +2,5 @@
 
 from eduid.common.clients.gnap_client import AsyncGNAPClient, GNAPClient
 from eduid.common.clients.scim_client import SCIMClient
+
+__all__ = ['AsyncGNAPClient', 'GNAPClient', 'SCIMClient']

src/eduid/common/clients/gnap_client/__init__.py

@@ -2,3 +2,5 @@
 
 from eduid.common.clients.gnap_client.async_client import AsyncGNAPClient
 from eduid.common.clients.gnap_client.sync_client import GNAPClient
+
+__all__ = ['GNAPClient', 'AsyncGNAPClient']

src/eduid/common/clients/scim_client/__init__.py

@@ -1,3 +1,5 @@
 __author__ = "lundberg"
 
 from eduid.common.clients.scim_client.scim_client import SCIMClient
+
+__all__ = ['SCIMClient']

src/eduid/common/models/bearer_token.py

@@ -3,7 +3,7 @@
 from enum import Enum
 from typing import Any, Mapping, Optional
 
-from pydantic import BaseModel, Field, StrictInt, field_validator, model_validator, validator
+from pydantic import BaseModel, Field, StrictInt, field_validator, model_validator
 from pydantic_core.core_schema import ValidationInfo
 
 from eduid.common.config.base import AuthnBearerTokenConfig, DataOwnerName, ScopeName

src/eduid/common/models/scim_invite.py

@@ -1,8 +1,7 @@
-from datetime import datetime
-from typing import Any, Optional
+from typing import Optional
 from uuid import UUID
 
-from pydantic import Field, model_validator, root_validator
+from pydantic import Field, model_validator
 from typing_extensions import Self
 
 from eduid.common.models.scim_base import (

src/eduid/graphdb/__init__.py

@@ -1,3 +1,8 @@
 from eduid.graphdb.db import BaseGraphDB, Neo4jDB
 
+__all__ = [
+    'BaseGraphDB',
+    'Neo4jDB',
+]
+
 __author__ = "lundberg"

src/eduid/graphdb/groupdb/__init__.py

@@ -2,4 +2,10 @@
 from eduid.graphdb.groupdb.group import Group
 from eduid.graphdb.groupdb.user import User
 
+__all__ = [
+    'GroupDB',
+    'Group',
+    'User',
+]
+
 __author__ = "lundberg"

src/eduid/maccapi/helpers.py

@@ -10,7 +10,7 @@
 from eduid.userdb.exceptions import UserDoesNotExist, UserOutOfSync
 from eduid.userdb.logs.element import ManagedAccountLogElement
 from eduid.userdb.maccapi import ManagedAccount
-from eduid.vccs.client import VCCSClient, VCCSClientHTTPError, VCCSPasswordFactor, VCCSRevokeFactor
+from eduid.vccs.client import VCCSClientHTTPError, VCCSPasswordFactor, VCCSRevokeFactor
 
 
 class UnableToCreateUniqueEppn(Exception):

src/eduid/maccapi/middleware.py

@@ -73,15 +73,15 @@ async def dispatch(self, request: Request, call_next: RequestResponseEndpoint) -
         try:
             token.validate_auth_source()
         except RequestedAccessDenied as e:
-            self.context.logger.error("Access denied: {e}")
+            self.context.logger.error(f"Access denied: {e}")
             return return_error_response(
                 status_code=status.HTTP_401_UNAUTHORIZED, detail="Authentication source or assurance level invalid"
             )
 
         try:
             data_owner = token.get_data_owner()
         except RequestedAccessDenied as e:
-            self.context.logger.error("Access denied: {e}")
+            self.context.logger.error(f"Access denied: {e}")
             return return_error_response(
                 status_code=status.HTTP_401_UNAUTHORIZED, detail="Data owner requested in access token denied"
             )

src/eduid/maccapi/testing.py

@@ -1,6 +1,6 @@
 import os
 import unittest
-from typing import Any, Optional, cast
+from typing import Any, cast
 
 import pkg_resources
 from starlette.testclient import TestClient
@@ -9,7 +9,6 @@
 from eduid.maccapi.app import init_api
 from eduid.maccapi.config import MAccApiConfig
 from eduid.maccapi.context import Context
-from eduid.userdb.maccapi import ManagedAccount
 from eduid.userdb.testing import MongoTemporaryInstance
 from eduid.vccs.client import VCCSClient
 from eduid.webapp.common.authn.testing import MockVCCSClient

src/eduid/maccapi/util.py

@@ -1,9 +1,7 @@
 import logging
 import math
-from uuid import uuid4
 
 from jwcrypto import jwk
-from pwgen import pwgen
 
 from eduid.common.config.exceptions import BadConfiguration
 from eduid.maccapi.config import MAccApiConfig

src/eduid/queue/db/__init__.py

@@ -2,4 +2,13 @@
 from eduid.queue.db.payload import Payload, RawPayload, TestPayload
 from eduid.queue.db.queue_item import QueueItem, SenderInfo
 
+__all__ = [
+    'QueueDB',
+    'Payload',
+    'RawPayload',
+    'TestPayload',
+    'QueueItem',
+    'SenderInfo',
+]
+
 __author__ = "lundberg"

src/eduid/queue/db/message/__init__.py

@@ -1,4 +1,10 @@
 from eduid.queue.db.message.db import MessageDB
 from eduid.queue.db.message.payload import EduidInviteEmail, EduidSignupEmail
 
+__all__ = [
+    'MessageDB',
+    'EduidInviteEmail',
+    'EduidSignupEmail',
+]
+
 __author__ = "lundberg"

src/eduid/scimapi/models/event.py

@@ -1,4 +1,3 @@
-from datetime import datetime
 from typing import Any, Optional
 from uuid import UUID
 

src/eduid/userdb/__init__.py

@@ -11,9 +11,9 @@
 __license__ = "BSD"
 __authors__ = ["Fredrik Thulin"]
 
-import eduid.userdb.exceptions
-import eduid.userdb.mail
-import eduid.userdb.phone
+#import eduid.userdb.exceptions
+#import eduid.userdb.mail
+#import eduid.userdb.phone
 from eduid.userdb.db import MongoDB
 from eduid.userdb.event import EventList
 from eduid.userdb.identity import EIDASIdentity, NinIdentity, SvipeIdentity
@@ -26,3 +26,23 @@
 from eduid.userdb.tou import ToUEvent
 from eduid.userdb.user import User
 from eduid.userdb.userdb import AmDB, UserDB
+
+__all__ = [
+    'User',
+    'UserDB',
+    'AmDB',
+    'EventList',
+    'ToUEvent',
+    'Profile',
+    'Nin',
+    'NinIdentity',
+    'SvipeIdentity',
+    'EIDASIdentity',
+    'MailAddress',
+    'PhoneNumber',
+    'OidcIdToken',
+    'OidcAuthorization',
+    'Orcid',
+    'LockedIdentityList',
+    'MongoDB',
+]

src/eduid/userdb/actions/tou/__init__.py

@@ -2,3 +2,8 @@
 
 from .user import ToUUser
 from .userdb import ToUUserDB
+
+__all__ = [
+    "ToUUser",
+    "ToUUserDB",
+]

src/eduid/userdb/credentials/__init__.py

@@ -2,3 +2,13 @@
 from eduid.userdb.credentials.fido import U2F, FidoCredential, Webauthn
 from eduid.userdb.credentials.list import CredentialList
 from eduid.userdb.credentials.password import Password
+
+__all__ = [
+    'Credential',
+    'CredentialList',
+    'Password',
+    'U2F',
+    'FidoCredential',
+    'Webauthn',
+    'CredentialProofingMethod',
+]

src/eduid/userdb/db/__init__.py

@@ -2,3 +2,10 @@
 
 # Keep existing imports working
 from eduid.userdb.db.sync_db import BaseDB, MongoDB, SaveResult, TUserDbDocument
+
+__all__ =  [
+    'BaseDB',
+    'MongoDB',
+    'SaveResult',
+    'TUserDbDocument',
+]

src/eduid/userdb/group_management/__init__.py

@@ -1,4 +1,10 @@
 from eduid.userdb.group_management.db import GroupManagementInviteStateDB
 from eduid.userdb.group_management.state import GroupInviteState, GroupRole
 
+__all__ = [
+    'GroupManagementInviteStateDB',
+    'GroupInviteState',
+    'GroupRole',
+]
+
 __author__ = "lundberg"

src/eduid/userdb/idp/__init__.py

@@ -1,2 +1,7 @@
 from .db import IdPUserDb
 from .user import IdPUser
+
+__all__ =  [
+    'IdPUser',
+    'IdPUserDb',
+]

src/eduid/userdb/logs/__init__.py

@@ -12,4 +12,18 @@
     TeleAdressProofingRelation,
 )
 
+__all__ =  [
+    'ProofingLog',
+    'LetterProofing',
+    'MailAddressProofing',
+    'MFATokenProofing',
+    'OrcidProofing',
+    'PhoneNumberProofing',
+    'SeLegProofing',
+    'SeLegProofingFrejaEid',
+    'SwedenConnectProofing',
+    'TeleAdressProofing',
+    'TeleAdressProofingRelation',
+]
+
 __author__ = "lundberg"

src/eduid/userdb/maccapi/__init__.py

@@ -1 +1,6 @@
 from eduid.userdb.maccapi.userdb import ManagedAccount, ManagedAccountDB
+
+__all__ = [
+    'ManagedAccount',
+    'ManagedAccountDB',
+]

src/eduid/userdb/personal_data/__init__.py

@@ -1,4 +1,9 @@
 from eduid.userdb.personal_data.db import PersonalDataUserDB
 from eduid.userdb.personal_data.user import PersonalDataUser
 
+__all__ = [
+    'PersonalDataUserDB',
+    'PersonalDataUser',
+]
+
 __author__ = "lundberg"

src/eduid/userdb/proofing/__init__.py

@@ -12,6 +12,9 @@
     PhoneProofingStateDB,
     PhoneProofingUserDB,
 )
+
+
+
 from eduid.userdb.proofing.element import EmailProofingElement, NinProofingElement, PhoneProofingElement
 from eduid.userdb.proofing.state import (
     EmailProofingState,
@@ -21,3 +24,27 @@
     PhoneProofingState,
 )
 from eduid.userdb.proofing.user import ProofingUser
+
+__all__ = [
+    'EidasProofingUserDB',
+    'EmailProofingStateDB',
+    'EmailProofingUserDB',
+    'LetterProofingStateDB',
+    'LetterProofingUserDB',
+    'LookupMobileProofingUserDB',
+    'OidcProofingStateDB',
+    'OidcProofingUserDB',
+    'OrcidProofingStateDB',
+    'OrcidProofingUserDB',
+    'PhoneProofingStateDB',
+    'PhoneProofingUserDB',
+    'ProofingUser',
+    'LetterProofingState',
+    'EmailProofingState',
+    'OidcProofingState',
+    'OrcidProofingState',
+    'PhoneProofingState',
+    'EmailProofingElement',
+    'NinProofingElement',
+    'PhoneProofingElement',
+]

src/eduid/userdb/reset_password/__init__.py

@@ -5,3 +5,12 @@
     ResetPasswordState,
 )
 from eduid.userdb.reset_password.user import ResetPasswordUser
+
+__all__ = [
+    'ResetPasswordStateDB',
+    'ResetPasswordUserDB',
+    'ResetPasswordState',
+    'ResetPasswordEmailState',
+    'ResetPasswordEmailAndPhoneState',
+    'ResetPasswordUser',
+]

src/eduid/userdb/scimapi/__init__.py

@@ -17,3 +17,22 @@
 )
 from eduid.userdb.scimapi.groupdb import GroupExtensions, ScimApiGroup, ScimApiGroupDB
 from eduid.userdb.scimapi.userdb import ScimApiUser, ScimApiUserDB
+
+__all__ = [
+    'ScimApiUser',
+    'ScimApiUserDB',
+    'ScimApiGroup',
+    'ScimApiGroupDB',
+    'ScimApiEvent',
+    'ScimApiEventDB',
+    'ScimApiEventResource',
+    'ScimApiResourceBase',
+    'ScimApiName',
+    'ScimApiEmail',
+    'ScimApiPhoneNumber',
+    'ScimApiProfile',
+    'ScimApiLinkedAccount',
+    'EventLevel',
+    'EventStatus',
+    'GroupExtensions',
+]

src/eduid/userdb/security/__init__.py

@@ -2,4 +2,13 @@
 from eduid.userdb.security.state import PasswordResetEmailAndPhoneState, PasswordResetEmailState, PasswordResetState
 from eduid.userdb.security.user import SecurityUser
 
+__all__ = [
+    'PasswordResetState',
+    'PasswordResetEmailState',
+    'PasswordResetEmailAndPhoneState',
+    'PasswordResetStateDB',
+    'SecurityUser',
+    'SecurityUserDB',
+]
+
 __author__ = "lundberg"