Merge pull request #478 from ogajduse/fix/black-formatting-202404

.gitignore

@@ -12,3 +12,4 @@ dist/
 .tox/
 AUTHORS
 ChangeLog
+vcd_sdk.log

.pre-commit-config.yaml

@@ -1,18 +1,15 @@
 ci:
   autofix_prs: false
 repos:
-  - repo: https://github.com/asottile/reorder-python-imports
-    rev: v3.12.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.3.7
     hooks:
-      - id: reorder-python-imports
-        args:
-          - --application-directories=.:wrapanapi
-  - repo: https://github.com/psf/black
-    rev: 23.12.1
-    hooks:
-      - id: black
-        args: [--safe, --quiet, --line-length, "100"]
-        require_serial: true
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
   - repo: https://github.com/PyCQA/flake8
     rev: 7.0.0
     hooks:

pyproject.toml

@@ -87,3 +87,25 @@ test = [
     "pytest-variables",
     "coveralls",
 ]
+
+[tool.ruff]
+line-length = 100
+indent-width = 4
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+[tool.ruff.lint]
+select = ["I"]
+
+ignore = []

tests/test_hawkular.py

@@ -1,4 +1,5 @@
 """Unit tests for Hawkular client."""
+
 import json
 import os
 from random import sample
@@ -8,10 +9,7 @@
 import pytest
 
 from wrapanapi.systems import HawkularSystem
-from wrapanapi.systems.hawkular import CanonicalPath
-from wrapanapi.systems.hawkular import Resource
-from wrapanapi.systems.hawkular import ResourceData
-from wrapanapi.systems.hawkular import ResourceType
+from wrapanapi.systems.hawkular import CanonicalPath, Resource, ResourceData, ResourceType
 
 
 def fake_urlopen(c_client, url, headers, params):

tests/test_vm_and_template_systems.py

@@ -6,6 +6,7 @@
 If running within a cfme venv, disable the cfme plugins like so:
    $ pytest test_vm_and_template_systems.py -p no:cfme -s
 """
+
 import datetime
 import logging
 
@@ -17,10 +18,7 @@
 from wrapanapi import VmState
 from wrapanapi.entities import StackMixin
 from wrapanapi.exceptions import MultipleItemsError
-from wrapanapi.systems.ec2 import EC2Image
-from wrapanapi.systems.ec2 import EC2Instance
-from wrapanapi.systems.ec2 import StackStates
-
+from wrapanapi.systems.ec2 import EC2Image, EC2Instance, StackStates
 
 log = logging.getLogger("wrapanapi.tests.test_vm_and_template_systems")
 

wrapanapi/clients/__init__.py

@@ -1,5 +1,4 @@
 from .rest_client import ContainerClient
-from .websocket_client import HawkularWebsocketClient
-from .websocket_client import WebsocketClient
+from .websocket_client import HawkularWebsocketClient, WebsocketClient
 
 __all__ = ["ContainerClient", "WebsocketClient", "HawkularWebsocketClient"]

wrapanapi/entities/__init__.py

@@ -1,21 +1,15 @@
 """
 wrapanapi.entities
 """
+
 from .instance import Instance
-from .network import Network
-from .network import NetworkMixin
+from .network import Network, NetworkMixin
 from .physical_container import PhysicalContainer
-from .server import Server
-from .server import ServerState
-from .stack import Stack
-from .stack import StackMixin
-from .template import Template
-from .template import TemplateMixin
-from .vm import Vm
-from .vm import VmMixin
-from .vm import VmState
-from .volume import Volume
-from .volume import VolumeMixin
+from .server import Server, ServerState
+from .stack import Stack, StackMixin
+from .template import Template, TemplateMixin
+from .vm import Vm, VmMixin, VmState
+from .volume import Volume, VolumeMixin
 
 __all__ = [
     "Template",

wrapanapi/entities/base.py

@@ -3,9 +3,8 @@
 
 Provides method/class definitions for handling any entity on a provider
 """
-from abc import ABCMeta
-from abc import abstractmethod
-from abc import abstractproperty
+
+from abc import ABCMeta, abstractmethod, abstractproperty
 from reprlib import aRepr
 
 from wrapanapi.exceptions import NotFoundError

wrapanapi/entities/instance.py

@@ -3,8 +3,8 @@
 
 Instances which run on cloud providers
 """
-from abc import ABCMeta
-from abc import abstractproperty
+
+from abc import ABCMeta, abstractproperty
 
 from .vm import Vm
 

wrapanapi/entities/network.py

@@ -3,13 +3,11 @@
 
 Networks
 """
-from abc import ABCMeta
-from abc import abstractmethod
 
-from wrapanapi.entities.base import Entity
-from wrapanapi.entities.base import EntityMixin
-from wrapanapi.exceptions import MultipleItemsError
-from wrapanapi.exceptions import NotFoundError
+from abc import ABCMeta, abstractmethod
+
+from wrapanapi.entities.base import Entity, EntityMixin
+from wrapanapi.exceptions import MultipleItemsError, NotFoundError
 
 
 class Network(Entity, metaclass=ABCMeta):

wrapanapi/entities/physical_container.py

@@ -5,6 +5,7 @@
 blocks, sleds, chassis or enclosures that contain other physical entities such
 as physical servers.
 """
+
 from abc import ABCMeta
 
 from wrapanapi.entities.base import Entity

wrapanapi/entities/server.py

@@ -3,8 +3,8 @@
 
 Implements classes and methods related to actions performed on (physical) servers
 """
-from abc import ABCMeta
-from abc import abstractmethod
+
+from abc import ABCMeta, abstractmethod
 
 from wrapanapi.entities.base import Entity
 

wrapanapi/entities/stack.py

@@ -3,13 +3,11 @@
 
 Orchestration stacks
 """
-from abc import ABCMeta
-from abc import abstractmethod
 
-from wrapanapi.entities.base import Entity
-from wrapanapi.entities.base import EntityMixin
-from wrapanapi.exceptions import MultipleItemsError
-from wrapanapi.exceptions import NotFoundError
+from abc import ABCMeta, abstractmethod
+
+from wrapanapi.entities.base import Entity, EntityMixin
+from wrapanapi.exceptions import MultipleItemsError, NotFoundError
 
 
 class Stack(Entity, metaclass=ABCMeta):

wrapanapi/entities/template.py

@@ -3,13 +3,11 @@
 
 Methods/classes pertaining to performing actions on a template
 """
-from abc import ABCMeta
-from abc import abstractmethod
 
-from wrapanapi.entities.base import Entity
-from wrapanapi.entities.base import EntityMixin
-from wrapanapi.exceptions import MultipleItemsError
-from wrapanapi.exceptions import NotFoundError
+from abc import ABCMeta, abstractmethod
+
+from wrapanapi.entities.base import Entity, EntityMixin
+from wrapanapi.exceptions import MultipleItemsError, NotFoundError
 
 
 class Template(Entity, metaclass=ABCMeta):

wrapanapi/entities/vm.py

@@ -3,20 +3,16 @@
 
 Methods/classes pertaining to performing actions on a VM/instance
 """
+
 import time
-from abc import ABCMeta
-from abc import abstractmethod
-from abc import abstractproperty
+from abc import ABCMeta, abstractmethod, abstractproperty
 
 from cached_property import cached_property_with_ttl
-from wait_for import TimedOutError
-from wait_for import wait_for
+from wait_for import TimedOutError, wait_for
 
 from wrapanapi.const import CACHED_PROPERTY_TTL
-from wrapanapi.entities.base import Entity
-from wrapanapi.entities.base import EntityMixin
-from wrapanapi.exceptions import MultipleItemsError
-from wrapanapi.exceptions import NotFoundError
+from wrapanapi.entities.base import Entity, EntityMixin
+from wrapanapi.exceptions import MultipleItemsError, NotFoundError
 
 
 class VmState:

wrapanapi/entities/volume.py

@@ -3,13 +3,11 @@
 
 Volumes
 """
-from abc import ABCMeta
-from abc import abstractmethod
 
-from wrapanapi.entities.base import Entity
-from wrapanapi.entities.base import EntityMixin
-from wrapanapi.exceptions import MultipleItemsError
-from wrapanapi.exceptions import NotFoundError
+from abc import ABCMeta, abstractmethod
+
+from wrapanapi.entities.base import Entity, EntityMixin
+from wrapanapi.exceptions import MultipleItemsError, NotFoundError
 
 
 class Volume(Entity, metaclass=ABCMeta):

wrapanapi/systems/base.py

@@ -2,9 +2,8 @@
 
 Used to communicate with providers without using CFME facilities
 """
-from abc import ABCMeta
-from abc import abstractmethod
-from abc import abstractproperty
+
+from abc import ABCMeta, abstractmethod, abstractproperty
 
 from wrapanapi.utils import LoggerMixin
 

wrapanapi/systems/container/rhopenshift.py

@@ -2,23 +2,19 @@
 import json
 import string
 from collections.abc import Iterable
-from functools import partial
-from functools import wraps
+from functools import partial, wraps
 from random import choice
 
 import inflection
 import yaml
 from kubernetes import client as kubeclient
 from kubernetes.client.rest import ApiException
-from miq_version import TemplateName
-from miq_version import Version
+from miq_version import TemplateName, Version
 from openshift import client as ociclient
-from wait_for import TimedOutError
-from wait_for import wait_for
+from wait_for import TimedOutError, wait_for
 
 from wrapanapi.systems.base import System
 
-
 # this service allows to access db outside of openshift
 common_service = """
 {

wrapanapi/systems/ec2.py

@@ -8,19 +8,19 @@
 from botocore.config import Config
 from botocore.exceptions import ClientError
 
-from wrapanapi.entities import Instance
-from wrapanapi.entities import Network
-from wrapanapi.entities import NetworkMixin
-from wrapanapi.entities import Stack
-from wrapanapi.entities import StackMixin
-from wrapanapi.entities import Template
-from wrapanapi.entities import TemplateMixin
-from wrapanapi.entities import VmMixin
-from wrapanapi.entities import VmState
-from wrapanapi.entities import Volume
-from wrapanapi.exceptions import ActionTimedOutError
-from wrapanapi.exceptions import MultipleItemsError
-from wrapanapi.exceptions import NotFoundError
+from wrapanapi.entities import (
+    Instance,
+    Network,
+    NetworkMixin,
+    Stack,
+    StackMixin,
+    Template,
+    TemplateMixin,
+    VmMixin,
+    VmState,
+    Volume,
+)
+from wrapanapi.exceptions import ActionTimedOutError, MultipleItemsError, NotFoundError
 from wrapanapi.systems.base import System
 
 

wrapanapi/systems/google.py

@@ -1,6 +1,7 @@
 """
 Defines System and Entity classes related to the Google Cloud platform
 """
+
 import os
 import random
 import time
@@ -15,15 +16,13 @@
 from oauth2client.service_account import ServiceAccountCredentials
 from wait_for import wait_for
 
-from wrapanapi.entities import Instance
-from wrapanapi.entities import Template
-from wrapanapi.entities import TemplateMixin
-from wrapanapi.entities import VmMixin
-from wrapanapi.entities import VmState
-from wrapanapi.exceptions import ImageNotFoundError
-from wrapanapi.exceptions import MultipleInstancesError
-from wrapanapi.exceptions import NotFoundError
-from wrapanapi.exceptions import VMInstanceNotFound
+from wrapanapi.entities import Instance, Template, TemplateMixin, VmMixin, VmState
+from wrapanapi.exceptions import (
+    ImageNotFoundError,
+    MultipleInstancesError,
+    NotFoundError,
+    VMInstanceNotFound,
+)
 from wrapanapi.systems.base import System
 
 # Retry transport and file IO errors.

wrapanapi/systems/hawkular.py

@@ -10,8 +10,7 @@
 
 from packaging import version
 
-from wrapanapi.clients import ContainerClient
-from wrapanapi.clients import HawkularWebsocketClient
+from wrapanapi.clients import ContainerClient, HawkularWebsocketClient
 from wrapanapi.systems.base import System
 
 """

wrapanapi/systems/lenovo.py

@@ -1,6 +1,7 @@
 """Backend management system classes
 Used to communicate with providers without using CFME facilities
 """
+
 import json
 
 import requests