Add black and ruff to fix lint/pep/ and other issues automatically (#634)

Add black and ruff to fix lint/pep/ and other issues automatically

Summary
This PR modernizes and stabilizes the linting and formatting pipeline while keeping OpenStack standards.

What Was Done


Integrated Ruff for:

Import sorting
Unused import removal
General lint auto-fixes (E, F, I rules)



Integrated Black as the canonical code formatter (default line length = 88)


Kept flake8 + hacking to enforce OpenStack-specific standards


Kept doc8 for documentation validation


Updated tox configuration:

pep8 environment → CI check-only (no file modifications)
fix-pep8 environment → local auto-fix (modifies files)



Disabled E501 and E203 in flake8 to avoid conflicts with Black formatting (as recommended by Black documentation)



Why to much files changed
The large diff is intentional.
Black reformatted the entire codebase to a consistent style:

Normalized indentation
Adjusted line wrapping (88 characters)
Standardized slice spacing
Reformatted long imports
Removed trailing whitespace
Applied consistent multiline formatting

Ruff additionally:

Removed unused imports
Sorted imports
Cleaned up minor style inconsistencies

No functional or behavioral changes were introduced.
All changes are formatting and lint normalization only.

Why This Is Beneficial

Eliminates inconsistent formatting across the repository
Reduces CI noise caused by minor style differences
Aligns with modern Python tooling practices
Provides a single command to auto-fix issues locally


CI Behavior
CI now runs linting in read-only mode.
If formatting is incorrect, CI fails without modifying files.

Impact

No runtime changes
No API changes
No test logic changes
Formatting and lint normalization only

Reviewed-by: Anton Sidelnikov

Author: shhovhan

doc/source/conf.py

@@ -12,26 +12,25 @@
 # limitations under the License.
 
 import os
-import sys
 import warnings
 
 # -- General configuration ----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'otcdocstheme',
-    'cliff.sphinxext',
+    "sphinx.ext.autodoc",
+    "otcdocstheme",
+    "cliff.sphinxext",
 ]
 
 # Analytics app name
-otcdocs_analytics_app = 'otcextensions'
+otcdocs_analytics_app = "otcextensions"
 
 # openstackdocstheme options
-#otcdocs_repo_name = 'opentelekomcloud/python-otcextensions'
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
-html_theme = 'otcdocs'
+# otcdocs_repo_name = 'opentelekomcloud/python-otcextensions'
+html_last_updated_fmt = "%Y-%m-%d %H:%M"
+html_theme = "otcdocs"
 
 # TODO(shade) Set this to true once the build-openstack-sphinx-docs job is
 # updated to use sphinx-build.
@@ -43,14 +42,14 @@
 # execute "export SPHINX_DEBUG=1" in your terminal to disable
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'python-otcextensions'
-copyright = u'2021, Various members of the OpenTelekomCloud'
+project = "python-otcextensions"
+copyright = "2021, Various members of the OpenTelekomCloud"
 
 # A few variables have to be set for the log-a-bug feature.
 #   gitsha: The SHA checksum of the bug description. Extracted from git log.
@@ -59,16 +58,15 @@
 # These variables are passed to the logabug code via html_context.
 git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
 try:
-    gitsha = os.popen(git_cmd).read().strip('\n')
+    gitsha = os.popen(git_cmd).read().strip("\n")
 except Exception:
     warnings.warn("Can not get git sha.")
     gitsha = "unknown"
 
 otcdocs_bug_tag = "docs"
 pwd = os.getcwd()
 # html_context allows us to pass arbitrary values into the html template
-html_context = {"pwd": pwd,
-                "gitsha": gitsha}
+html_context = {"pwd": pwd, "gitsha": gitsha}
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
@@ -78,7 +76,7 @@
 add_module_names = True
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'native'
+pygments_style = "native"
 
 autodoc_member_order = "bysource"
 
@@ -91,25 +89,36 @@
 theme_include_auto_toc = False
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = '%sdoc' % project
+htmlhelp_basename = "%sdoc" % project
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
-    ('index',
-     '%s.tex' % project,
-     u'%s Documentation' % project,
-     u'OpenTelekomCloud', 'manual'),
+    (
+        "index",
+        "%s.tex" % project,
+        "%s Documentation" % project,
+        "OpenTelekomCloud",
+        "manual",
+    ),
 ]
 
 # Include both the class and __init__ docstrings when describing the class
 autoclass_content = "both"
 
 # -- Options for cliff.sphinxext plugin ---------------------------------------
 
-autoprogram_cliff_application = 'openstack'
+autoprogram_cliff_application = "openstack"
 
 autoprogram_cliff_ignored = [
-    '--help', '--format', '--column', '--max-width', '--fit-width',
-    '--print-empty', '--prefix', '--noindent', '--quote']
+    "--help",
+    "--format",
+    "--column",
+    "--max-width",
+    "--fit-width",
+    "--print-empty",
+    "--prefix",
+    "--noindent",
+    "--quote",
+]

doc/source/contributor/create/examples/resource/fake_service.py

@@ -1,12 +1,13 @@
 # Apache 2 header omitted for brevity
 
-from openstack import service_description
 from openstack.fake.v2 import _proxy as _proxy_v2
 
+from openstack import service_description
+
 
 class FakeService(service_description.ServiceDescription):
     """The fake service."""
 
     supported_versions = {
-        '2': _proxy_v2.Proxy,
+        "2": _proxy_v2.Proxy,
     }

doc/source/enforcer.py

@@ -34,25 +34,27 @@
 
 class EnforcementError(errors.SphinxError):
     """A mismatch between what exists and what's documented"""
+
     category = "Enforcer"
 
 
 def get_proxy_methods():
     """Return a set of public names on all proxies"""
-    names = ["otcextensions.sdk.anti_ddos.v1._proxy",
-             "otcextensions.sdk.auto_scaling.v1._proxy",
-             "otcextensions.sdk.cce.v1._proxy",
-             "otcextensions.sdk.ces.v1._proxy",
-             "otcextensions.sdk.cts.v1._proxy",
-             "otcextensions.sdk.dcs.v1._proxy",
-             "otcextensions.sdk.dms.v1._proxy",
-             "otcextensions.sdk.dns.v2._proxy",
-             "otcextensions.sdk.kms.v1._proxy",
-             "otcextensions.sdk.obs.v1._proxy",
-             "otcextensions.sdk.rds.v1._proxy",
-             "otcextensions.sdk.rds.v3._proxy",
-             "otcextensions.sdk.volume_backup.v2._proxy"
-             ]
+    names = [
+        "otcextensions.sdk.anti_ddos.v1._proxy",
+        "otcextensions.sdk.auto_scaling.v1._proxy",
+        "otcextensions.sdk.cce.v1._proxy",
+        "otcextensions.sdk.ces.v1._proxy",
+        "otcextensions.sdk.cts.v1._proxy",
+        "otcextensions.sdk.dcs.v1._proxy",
+        "otcextensions.sdk.dms.v1._proxy",
+        "otcextensions.sdk.dns.v2._proxy",
+        "otcextensions.sdk.kms.v1._proxy",
+        "otcextensions.sdk.obs.v1._proxy",
+        "otcextensions.sdk.rds.v1._proxy",
+        "otcextensions.sdk.rds.v3._proxy",
+        "otcextensions.sdk.volume_backup.v2._proxy",
+    ]
 
     modules = (importlib.import_module(name) for name in names)
 
@@ -92,8 +94,7 @@ def page_context(app, pagename, templatename, context, doctree):
                 written += 1
 
         if DEBUG:
-            LOG.info("ENFORCER: Wrote %d proxy methods for %s" % (
-                     written, pagename))
+            LOG.info("ENFORCER: Wrote %d proxy methods for %s" % (written, pagename))
 
 
 def build_finished(app, exception):
@@ -113,8 +114,9 @@ def build_finished(app, exception):
     missing = all_methods - WRITTEN_METHODS
 
     missing_count = len(missing)
-    LOG.info("ENFORCER: Found %d missing proxy methods "
-             "in the output" % missing_count)
+    LOG.info(
+        "ENFORCER: Found %d missing proxy methods " "in the output" % missing_count
+    )
 
     # TODO(shade) This is spewing a bunch of content for missing thing that
     # are not actually missing. Leave it as info rather than warn so that the
@@ -128,7 +130,8 @@ def build_finished(app, exception):
 
     if app.config.enforcer_warnings_as_errors and missing_count > 0:
         raise EnforcementError(
-            "There are %d undocumented proxy methods" % missing_count)
+            "There are %d undocumented proxy methods" % missing_count
+        )
 
 
 def setup(app):