style(ruff): initial support

Author: Lujeni

.github/workflows/testing.yml

@@ -28,6 +28,8 @@ jobs:
     - name: Pre-commit
       run: |
         pre-commit run --all-files
+    - name: Run Ruff
+      run: ruff check --output-format=github .
     - name: Test with pytest
       run: |
         pytest

.gitignore

@@ -60,4 +60,4 @@ Session.vim
 # virtualenv
 .venv*
 venv*
-src/
+src/

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+default_language_version:
+  python: python3.8
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v2.42.1
+    hooks:
+      - id: commitizen

docs/Makefile

@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source/_templates/sidebarlogo.html

@@ -1,4 +1,3 @@
 <p class="logo"><a href="{{ pathto(master_doc) }}">
   <img class="logo" src="https://raw.githubusercontent.com/numberly/flask-stupe/master/artwork/stupeflask.png" alt="Logo"/>
 </a></p>
-

flask_stupe/app.py

@@ -61,13 +61,13 @@ def register_blueprints(self, package, **options):
         It means that if a file called `foo.py` has an exportable variable
         called `foo`, it will try to register that variable as a blueprint.
         """
-        prefix = package.__name__ + '.'
+        prefix = package.__name__ + "."
         for importer, name, is_pkg in iter_modules(package.__path__, prefix):
             module = importer.find_module(name).load_module(name)
-            blueprint_name = name.rsplit('.')[-1]
+            blueprint_name = name.rsplit(".")[-1]
             blueprint = getattr(module, blueprint_name, None)
             if blueprint and isinstance(blueprint, Blueprint):
-                log.info(' * Registering blueprint {}'.format(name))
+                log.info(" * Registering blueprint {}".format(name))
                 blueprint.name = name
                 self.register_blueprint(blueprint, **options)
             elif is_pkg:

flask_stupe/auth.py

@@ -22,11 +22,13 @@ def get_user():
     A view decorated with :func:`auth_required` will be aborted with a status
     code 401 if the user making the request is not authenticated.
     """
+
     @functools.wraps(function)
     def __inner(*args, **kwargs):
         if not request.user:
             abort(401)
         return function(*args, **kwargs)
+
     return __inner
 
 
@@ -47,6 +49,7 @@ def permission_required(*permissions):
     You can apply this decorator multiple times if you need several permissions
     at once to access a view.
     """
+
     def __decorator(function):
         @functools.wraps(function)
         def __inner(*args, **kwargs):
@@ -59,7 +62,9 @@ def __inner(*args, **kwargs):
                 if fnmatch.filter(permissions, user_group):
                     return function(*args, **kwargs)
             abort(403)
+
         return auth_required(__inner)
+
     return __decorator
 
 

flask_stupe/config.py

@@ -14,7 +14,6 @@ def _str2list(v):
 
 
 class Config(FlaskConfig):
-
     def from_env(self):
         """Try to overload the config with the environment.
 

flask_stupe/converters.py

@@ -6,8 +6,9 @@
 
 
 if bson:
+
     class ObjectIdConverter(BaseConverter):
-        regex = r'[A-Fa-f0-9]{24}'
+        regex = r"[A-Fa-f0-9]{24}"
 
         def to_python(self, value):
             return bson.ObjectId(value)