PUC-740: linting

Author: haseebsyed12

python/diff-nautobot-understack/diff_nautobot_understack/cli.py

@@ -1,17 +1,16 @@
-from typing import Optional
-
 import typer
 from diffsync.diff import Diff
-from diff_nautobot_understack.project.main import (
-    openstack_project_diff_from_nautobot_tenant,
-)
+from rich import print
+from rich.console import Console
+from rich.table import Table
+
 from diff_nautobot_understack.network.main import (
     openstack_network_diff_from_ucvni_network,
 )
+from diff_nautobot_understack.project.main import (
+    openstack_project_diff_from_nautobot_tenant,
+)
 from diff_nautobot_understack.settings import app_settings as settings
-from rich.console import Console
-from rich.table import Table
-from rich import print
 
 app = typer.Typer(
     name="diff",
@@ -25,7 +24,7 @@
 
 
 def display_output(
-    diff_result: Diff, diff_output: str, output_format: Optional[str] = None
+    diff_result: Diff, diff_output: str, output_format: str | None = None
 ):
     print(diff_result.summary())
     __output_format = (

python/diff-nautobot-understack/diff_nautobot_understack/clients/nautobot.py

@@ -1,8 +1,9 @@
-import requests
-import logging
 import inspect
+import logging
 from urllib.parse import urljoin
 
+import requests
+
 from diff_nautobot_understack.settings import app_settings as settings
 
 

python/diff-nautobot-understack/diff_nautobot_understack/network/adapters/openstack_network.py

@@ -1,6 +1,6 @@
 from diffsync import Adapter
-from diff_nautobot_understack.clients.openstack import API
 
+from diff_nautobot_understack.clients.openstack import API
 from diff_nautobot_understack.network import models
 
 

python/diff-nautobot-understack/diff_nautobot_understack/network/adapters/ucvni.py

@@ -1,7 +1,7 @@
 from diffsync import Adapter
 from pydantic import BaseModel
-from diff_nautobot_understack.clients.nautobot import API
 
+from diff_nautobot_understack.clients.nautobot import API
 from diff_nautobot_understack.network import models
 
 

python/diff-nautobot-understack/diff_nautobot_understack/network/main.py

@@ -1,5 +1,6 @@
 from diffsync.diff import Diff
 from diffsync.enum import DiffSyncFlags
+
 from diff_nautobot_understack.network.adapters.openstack_network import (
     Network as OpenstackNetwork,
 )

python/diff-nautobot-understack/diff_nautobot_understack/project/adapters/nautobot_tenant.py

@@ -1,8 +1,8 @@
 import uuid
 
 from diffsync import Adapter
-from diff_nautobot_understack.clients.nautobot import API
 
+from diff_nautobot_understack.clients.nautobot import API
 from diff_nautobot_understack.project import models
 
 

python/diff-nautobot-understack/diff_nautobot_understack/project/adapters/openstack_project.py

@@ -1,6 +1,6 @@
 from diffsync import Adapter
-from diff_nautobot_understack.clients.openstack import API
 
+from diff_nautobot_understack.clients.openstack import API
 from diff_nautobot_understack.project import models
 
 

python/diff-nautobot-understack/diff_nautobot_understack/project/main.py

@@ -1,7 +1,8 @@
 from diffsync.diff import Diff
 from diffsync.enum import DiffSyncFlags
-from diff_nautobot_understack.project.adapters.openstack_project import Project
+
 from diff_nautobot_understack.project.adapters.nautobot_tenant import Tenant
+from diff_nautobot_understack.project.adapters.openstack_project import Project
 from diff_nautobot_understack.settings import app_settings as settings
 
 

python/diff-nautobot-understack/diff_nautobot_understack/settings.py

@@ -1,17 +1,16 @@
-from typing import Optional
-
-from pydantic_settings import BaseSettings, SettingsConfigDict
+from pydantic_settings import BaseSettings
+from pydantic_settings import SettingsConfigDict
 
 
 class Settings(BaseSettings):
     model_config = SettingsConfigDict(env_file="./.env", env_file_encoding="utf-8")
 
-    nautobot_api_token: Optional[str] = None
+    nautobot_api_token: str | None = None
     nautobot_url: str = "https://nautobot.dev.undercloud.rackspace.net"
     debug: bool = False
-    os_cloud: Optional[str] = None
+    os_cloud: str | None = None
     os_project: str = "default"
-    os_client_config_file: Optional[str] = None
+    os_client_config_file: str | None = None
     output_format: str = "table"
 
 

python/diff-nautobot-understack/pyproject.toml

@@ -14,6 +14,43 @@ diffsync = "^2.0.1"
 typer = "^0.15.1"
 pydantic-settings = "^2.7.1"
 
+[tool.ruff]
+target-version = "py311"
+fix = true
+
+[tool.ruff.lint]
+select = [
+  "D",       # pydocstyle
+  "E",       # pycodestyle (error)
+  "F",       # pyflakes
+  "B",       # flake8-bugbear
+  "I",       # isort
+  "S",       # flake8-bandit
+  "UP",      # pyupgrade
+  "ASYNC",   # flake8-async
+]
+
+ignore = [
+    "D100",  # don't require docs for every module
+    "D101",  # don't require docs for every class
+    "D102",  # don't require docs for every class method
+    "D103",  # don't require docs for every function
+    "D104",  # don't require docs for every package
+    "D106",  # don't require docs for every nested class
+    "D107",  # don't require docs for __init__
+    "D417"   # don't require docs for every function parameter
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+
+[tool.ruff.lint.pydocstyle]
+# enable the google doc style rules by default
+convention = "google"
+
+[tool.ruff.lint.per-file-ignores]
+"diff_nautobot_understack/cli.py" = ["D415"]
+
 [tool.poetry.scripts]
 uc-diff = "diff_nautobot_understack.cli:app"