[qa] Automatic reformatting of code and docs

openwisp · Jul 30, 2024 · 745a6ca · 745a6ca
1 parent c745e64
commit 745a6ca
Show file tree

Hide file tree

Showing 17 changed files with 31 additions and 38 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -14,13 +14,16 @@ Bugfixes
 
 - Fixed `hardcoded storage backend of the "FirmwareImage.file" field
   <https://github.com/openwisp/openwisp-firmware-upgrader/issues/195>`_.
-  ``FirmwareImage.file`` was configured to use ``PrivateFileSystemStorage``,
-  which made it impossible to use other private storage backends.
-  The `"OPENWISP_FIRMWARE_PRIVATE_STORAGE_INSTANCE"
+  ``FirmwareImage.file`` was configured to use
+  ``PrivateFileSystemStorage``, which made it impossible to use other
+  private storage backends. The
+  `"OPENWISP_FIRMWARE_PRIVATE_STORAGE_INSTANCE"
   <https://github.com/openwisp/openwisp-firmware-upgrader#openwisp_firmware_private_storage_instance>`_
-  setting is added to make the ``FirmwareImage.file`` storage configurable.
-- Fixed `inconsistent URL keyword argument in "serve_private_file"
-  URL pattern <https://github.com/openwisp/openwisp-firmware-upgrader/issues/197>`_.
+  setting is added to make the ``FirmwareImage.file`` storage
+  configurable.
+- Fixed `inconsistent URL keyword argument in "serve_private_file" URL
+  pattern
+  <https://github.com/openwisp/openwisp-firmware-upgrader/issues/197>`_.
   This broke the reverse proxy feature of `django-private-storage
   <https://github.com/edoburu/django-private-storage>`_.
 
@@ -93,15 +96,15 @@ Changes
 -------
 
 Backward incompatible changes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - REST APIs are enabled by default. You can disable them by setting
   ``OPENWISP_FIRMWARE_UPGRADER_API`` to ``False``.
 - Changed REST API prefix from ``/upgrader/`` to ``/firmware-upgrader/``.
   This makes it consistent with REST API endpoints of other modules
 
 Dependencies
-^^^^^^^^^^^^
+~~~~~~~~~~~~
 
 - Dropped support for Python 3.6
 - Dropped support for Django 2.2
@@ -110,32 +113,33 @@ Dependencies
 - Upgraded openwisp-controller to 1.0.x
 
 Other changes
-^^^^^^^^^^^^^
+~~~~~~~~~~~~~
 
-- Avoid deletion of ``UpgradeOperation`` when related
-  ``Firmware Image`` is deleted
-- Increased default retries in OpenWRT upgrader from
-  ``15`` to ``40``
+- Avoid deletion of ``UpgradeOperation`` when related ``Firmware Image``
+  is deleted
+- Increased default retries in OpenWRT upgrader from ``15`` to ``40``
 - Made firmware upgrade logs translatable
-- Changed the default API throttle rate from ``400/hour`` to ``1000/minute``
-- Added time limits to ``openwisp_firmware_upgrader.tasks.create_device_firmware``
-  and ``openwisp_firmware_upgrader.tasks.create_all_device_firmwares`` celery tasks
+- Changed the default API throttle rate from ``400/hour`` to
+  ``1000/minute``
+- Added time limits to
+  ``openwisp_firmware_upgrader.tasks.create_device_firmware`` and
+  ``openwisp_firmware_upgrader.tasks.create_all_device_firmwares`` celery
+  tasks
 
 Bugfixes
 --------
 
 - Fixed firmware checksum check
 - Improved error handling for upgrade operations
-- Remove openwisp-config persistent checksum:
-  openwisp-config 0.6.0 makes the checksum persistent,
-  but this causes upgraded devices to not download the configuration
-  again after the upgrade, which is an issue if the configuration
-  contains any file which is not stored in ``/etc/``.
+- Remove openwisp-config persistent checksum: openwisp-config 0.6.0 makes
+  the checksum persistent, but this causes upgraded devices to not
+  download the configuration again after the upgrade, which is an issue if
+  the configuration contains any file which is not stored in ``/etc/``.
 - Fixed a bug which caused ``Server 500`` error on creating a new
   ``Build`` object if ``category`` field was left empty
 - Fixed bugs in restoring deleted devices using ``django-reversion``
-- Fixed migrations referencing non-swappable OpenWISP modules
-  that broke OpenWISP's extensibility
+- Fixed migrations referencing non-swappable OpenWISP modules that broke
+  OpenWISP's extensibility
 
 Version 0.1.1 [2021-01-08]
 --------------------------

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -1 +1,2 @@
-Please refer to the `OpenWISP contributing guidelines <http://openwisp.io/docs/developer/contributing.html>`_.
+Please refer to the `OpenWISP contributing guidelines
+<http://openwisp.io/docs/developer/contributing.html>`_.
diff --git a/openwisp_firmware_upgrader/migrations/0001_initial.py b/openwisp_firmware_upgrader/migrations/0001_initial.py
@@ -13,7 +13,6 @@
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [

diff --git a/openwisp_firmware_upgrader/migrations/0002_default_permissions.py b/openwisp_firmware_upgrader/migrations/0002_default_permissions.py
@@ -9,7 +9,6 @@ def create_permissions_for_default_groups_helper(apps, schema_editor):
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('firmware_upgrader', '0001_initial'),
     ]

diff --git a/openwisp_firmware_upgrader/migrations/0003_private_media.py b/openwisp_firmware_upgrader/migrations/0003_private_media.py
@@ -7,7 +7,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('firmware_upgrader', '0002_default_permissions'),
     ]

diff --git a/openwisp_firmware_upgrader/migrations/0004_batch_upgrade_operation_idle_status.py b/openwisp_firmware_upgrader/migrations/0004_batch_upgrade_operation_idle_status.py
@@ -4,7 +4,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('firmware_upgrader', '0003_private_media'),
     ]

diff --git a/openwisp_firmware_upgrader/migrations/0005_build_os_identifier.py b/openwisp_firmware_upgrader/migrations/0005_build_os_identifier.py
@@ -4,7 +4,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('firmware_upgrader', '0004_batch_upgrade_operation_idle_status'),
     ]

diff --git a/openwisp_firmware_upgrader/migrations/0006_create_device_firmware.py b/openwisp_firmware_upgrader/migrations/0006_create_device_firmware.py
@@ -11,7 +11,6 @@ def create_device_firmware_for_connections_helper(apps, schema_editor):
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('firmware_upgrader', '0005_build_os_identifier'),
     ]

diff --git a/openwisp_firmware_upgrader/migrations/0007_nullable_upgrade_operation_image.py b/openwisp_firmware_upgrader/migrations/0007_nullable_upgrade_operation_image.py
@@ -6,7 +6,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('firmware_upgrader', '0006_create_device_firmware'),
     ]

diff --git a/openwisp_firmware_upgrader/migrations/0008_firmware_image_baseurl.py b/openwisp_firmware_upgrader/migrations/0008_firmware_image_baseurl.py
@@ -9,7 +9,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('firmware_upgrader', '0007_nullable_upgrade_operation_image'),
     ]

diff --git a/openwisp_firmware_upgrader/migrations/0009_upgrade_options.py b/openwisp_firmware_upgrader/migrations/0009_upgrade_options.py
@@ -4,7 +4,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('firmware_upgrader', '0008_firmware_image_baseurl'),
     ]

diff --git a/openwisp_firmware_upgrader/migrations/0010_alter_firmwareimage_file.py b/openwisp_firmware_upgrader/migrations/0010_alter_firmwareimage_file.py
@@ -9,7 +9,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("firmware_upgrader", "0009_upgrade_options"),
     ]

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,2 @@
+[tool.docstrfmt]
+extend_exclude = ["**/*.py", "README.rst"]
diff --git a/tests/openwisp2/sample_firmware_upgrader/migrations/0001_initial.py b/tests/openwisp2/sample_firmware_upgrader/migrations/0001_initial.py
@@ -17,7 +17,6 @@
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [

diff --git a/tests/openwisp2/sample_firmware_upgrader/migrations/0002_default_permissions.py b/tests/openwisp2/sample_firmware_upgrader/migrations/0002_default_permissions.py
@@ -11,7 +11,6 @@ def create_permissions_for_default_groups_helper(apps, schema_editor):
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('sample_firmware_upgrader', '0001_initial'),
     ]

diff --git a/tests/openwisp2/sample_firmware_upgrader/migrations/0003_create_device_firmware.py b/tests/openwisp2/sample_firmware_upgrader/migrations/0003_create_device_firmware.py
@@ -11,7 +11,6 @@ def create_device_firmware_for_connections_helper(apps, schema_editor):
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ('sample_firmware_upgrader', '0002_default_permissions'),
     ]

diff --git a/tests/openwisp2/sample_firmware_upgrader/migrations/0004_alter_firmwareimage_file.py b/tests/openwisp2/sample_firmware_upgrader/migrations/0004_alter_firmwareimage_file.py
@@ -9,7 +9,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("sample_firmware_upgrader", "0003_create_device_firmware"),
     ]