Merge pull request #290 from eclecticiq/add-black-format

Add standard format

Author: eric-eclecticiq

.flake8

@@ -1,3 +1,4 @@
 [flake8]
 max-line-length=120
 exclude = docs/*,.tox/*
+ignore = E203, W503, W504, E704

.git-blame-ignore-revs

@@ -0,0 +1,5 @@
+# Initial commit to format the codebase with black
+e454428fdf5b3d32f8ffbe9bded3878a80e7b169
+# Initial commit to sort import on the codebase
+2d69e4fb6daf037cb2f4358fde0c6c96e3f7ca16
+ 

.github/workflows/format.yml

@@ -0,0 +1,19 @@
+name: Check format
+
+on:
+  - pull_request
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install deps
+        run: pip install -r requirements-dev.txt
+      - name: Run black
+        run: black --check opentaxii/ tests/
+      - name: Run isort
+        run: isort --check-only opentaxii/ tests/

docs/conf.py

@@ -13,8 +13,9 @@
 # serve to show the default.
 
 import datetime
-import sys
 import os
+import sys
+
 import sphinx_rtd_theme
 
 # If extensions (or modules to document with autodoc) are in another directory,

docs/update_db_schema_diagram.py

@@ -5,9 +5,10 @@
 current_dir = os.path.dirname(__file__)
 sys.path.append(os.path.abspath(os.path.join(current_dir, "..")))
 
-from opentaxii.persistence.sqldb.models import Base
 from sqla_graphs import TableGrapher
 
+from opentaxii.persistence.sqldb.models import Base
+
 grapher = TableGrapher(
     style={"node_table_header": {"bgcolor": "#000080"}},
     graph_options={"size": "30,30!"},  # inches, this maps to 2880px

examples/hooks.py

@@ -1,6 +1,8 @@
 
 from opentaxii.signals import (
-    CONTENT_BLOCK_CREATED, INBOX_MESSAGE_CREATED, SUBSCRIPTION_CREATED
+    CONTENT_BLOCK_CREATED,
+    INBOX_MESSAGE_CREATED,
+    SUBSCRIPTION_CREATED,
 )
 
 

opentaxii/__init__.py

@@ -1,11 +1,11 @@
 '''
-    OpenTAXII, TAXII server implementation from EclecticIQ.
+OpenTAXII, TAXII server implementation from EclecticIQ.
 '''
+
 # flake8: noqa
 
 from ._version import __version__
-from .server import TAXIIServer
 from .config import ServerConfig
 from .entities import Account
-
 from .local import context
+from .server import TAXIIServer

opentaxii/auth/api.py

@@ -1,4 +1,3 @@
-
 class OpenTAXIIAuthAPI:
     '''Abstract class that represents OpenTAXII Authentication API.
 

opentaxii/auth/manager.py

@@ -47,9 +47,7 @@ def update_account(self, account, password):
         for colname, permission in list(account.permissions.items()):
             collection = self.server.servers.taxii1.persistence.get_collection(colname)
             if not collection:
-                log.warning(
-                    "update_account.unknown_collection",
-                    collection=colname)
+                log.warning("update_account.unknown_collection", collection=colname)
                 account.permissions.pop(colname)
         account = self.api.update_account(account, password)
         return account

opentaxii/auth/sqldb/api.py

@@ -2,10 +2,11 @@
 
 import jwt
 import structlog
+from sqlalchemy.orm import exc
+
 from opentaxii.auth import OpenTAXIIAuthAPI
 from opentaxii.common.sqldb import BaseSQLDatabaseAPI
 from opentaxii.entities import Account as AccountEntity
-from sqlalchemy.orm import exc
 
 from .models import Account, Base
 
@@ -32,16 +33,19 @@ class SQLDatabaseAPI(BaseSQLDatabaseAPI, OpenTAXIIAuthAPI):
     BASEMODEL = Base
 
     def __init__(
-            self,
-            db_connection,
-            create_tables=False,
-            secret=None,
-            token_ttl_secs=None,
-            **engine_parameters):
+        self,
+        db_connection,
+        create_tables=False,
+        secret=None,
+        token_ttl_secs=None,
+        **engine_parameters,
+    ):
         super().__init__(db_connection, create_tables, **engine_parameters)
         if not secret:
-            raise ValueError('Secret is not defined for %s.%s' % (
-                self.__module__, self.__class__.__name__))
+            raise ValueError(
+                'Secret is not defined for %s.%s'
+                % (self.__module__, self.__class__.__name__)
+            )
         self.secret = secret
         self.token_ttl_secs = token_ttl_secs or 60 * 60  # 60min
 
@@ -71,18 +75,25 @@ def get_account(self, token):
         return account_to_account_entity(account)
 
     def delete_account(self, username):
-        account = self.db.session.query(Account).filter_by(username=username).one_or_none()
+        account = (
+            self.db.session.query(Account).filter_by(username=username).one_or_none()
+        )
         if account:
             self.db.session.delete(account)
             self.db.session.commit()
 
     def get_accounts(self):
         return [
             account_to_account_entity(account)
-            for account in self.db.session.query(Account).all()]
+            for account in self.db.session.query(Account).all()
+        ]
 
     def update_account(self, obj, password=None):
-        account = self.db.session.query(Account).filter_by(username=obj.username).one_or_none()
+        account = (
+            self.db.session.query(Account)
+            .filter_by(username=obj.username)
+            .one_or_none()
+        )
         if not account:
             account = Account(username=obj.username)
             self.db.session.add(account)
@@ -120,4 +131,5 @@ def account_to_account_entity(account):
         id=account.id,
         username=account.username,
         is_admin=account.is_admin,
-        permissions=account.permissions)
+        permissions=account.permissions,
+    )