Skip to content

Commit 526939e

Browse files
authored
Use ruff instead of black and flake8 (#643)
We switched the project templates to ruff in 3.0, and it has been working out well. Time to switch the main project over to it. * All configs are now in pyproject.toml. * setup.cfg removed. * Azure pipelines and contributing guide are both updated accordingly. * Project has been formatted with ruff.
1 parent c0b8ef5 commit 526939e

41 files changed

Lines changed: 412 additions & 372 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

azure-pipelines.yml

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# Python Django
21
# Test a Django project on multiple versions of Python.
32
# Add steps that analyze code, save build artifacts, deploy, and more:
43
# https://docs.microsoft.com/azure/devops/pipelines/languages/python
@@ -13,13 +12,10 @@
1312
#
1413
# Use PowerShell Core for any utility scripts so they are re-usable across
1514
# Windows, macOS, and Linux.
16-
#
17-
1815

1916
trigger:
2017
- main
2118

22-
2319
stages:
2420
- stage: Unit_Tests
2521
displayName: Unit Tests
@@ -71,7 +67,6 @@ stages:
7167

7268
- script: |
7369
cd testproject/
74-
touch requirements-dev.txt
7570
python -m pip install -r requirements-dev.txt
7671
python manage.py makemigrations --check
7772
displayName: 'CR-QC: Check migrations'
@@ -117,11 +112,11 @@ stages:
117112
- pwsh: ./ci/spellcheck.ps1
118113
displayName: 'CR-QC: Spelling'
119114

120-
- script: black --check .
121-
displayName: 'CR-QC: Black'
115+
- script: ruff format --check .
116+
displayName: 'CR-QC: Ruff Format'
122117

123-
- script: flake8 .
124-
displayName: 'CR-QC: Flake8'
118+
- script: ruff check .
119+
displayName: 'CR-QC: Ruff Check'
125120

126121
- job: codecov
127122
displayName: Code Coverage

ci/spellcheck.ps1

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,7 @@ Push-Location $projectDir
1515
$ExitCode = 0
1616

1717
# Run spell checker.
18-
codespell `
19-
--skip="migrations,vendor,_build,*.css.map,*.jpg,*.png,*.pyc" `
20-
--ignore-words-list="assertIn" `
21-
coderedcms docs
18+
codespell coderedcms docs
2219
$ExitCode = $LastExitCode
2320

2421
# Print output.

coderedcms/admin_urls.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
from django.urls import include, path
1+
from django.urls import include
2+
from django.urls import path
23
from wagtail.admin import urls as wagtailadmin_urls
3-
from coderedcms.views import import_index, import_pages_from_csv_file
4+
5+
from coderedcms.views import import_index
6+
from coderedcms.views import import_pages_from_csv_file
47

58

69
urlpatterns = [

coderedcms/api/mailchimp.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1+
import requests
12
from wagtail.models import Site
2-
from coderedcms.models.wagtailsettings_models import LayoutSettings
33

4-
import requests
4+
from coderedcms.models.wagtailsettings_models import LayoutSettings
55

66

77
class MailchimpApi:

coderedcms/bin/coderedcms.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,10 @@ def handle(self, **options):
4646
options["secret_key"] = get_random_secret_key()
4747

4848
# Handle custom template logic
49-
import coderedcms
5049
import wagtail
5150

51+
import coderedcms
52+
5253
crx_path = os.path.dirname(coderedcms.__file__)
5354
if not options["template"]:
5455
options["template"] = "basic"

coderedcms/blocks/__init__.py

Lines changed: 49 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -5,63 +5,57 @@
55
"""
66

77
from django.utils.translation import gettext_lazy as _
8-
98
from wagtail import blocks
109

11-
from .stream_form_blocks import (
12-
CoderedStreamFormCharFieldBlock,
13-
CoderedStreamFormCheckboxesFieldBlock,
14-
CoderedStreamFormCheckboxFieldBlock,
15-
CoderedStreamFormDateFieldBlock,
16-
CoderedStreamFormDateTimeFieldBlock,
17-
CoderedStreamFormDropdownFieldBlock,
18-
CoderedStreamFormFileFieldBlock,
19-
CoderedStreamFormImageFieldBlock,
20-
CoderedStreamFormNumberFieldBlock,
21-
CoderedStreamFormRadioButtonsFieldBlock,
22-
CoderedStreamFormStepBlock,
23-
CoderedStreamFormTextFieldBlock,
24-
CoderedStreamFormTimeFieldBlock,
25-
)
26-
from .html_blocks import (
27-
ButtonBlock,
28-
EmbedGoogleMapBlock,
29-
ImageBlock,
30-
ImageLinkBlock,
31-
DownloadBlock,
32-
EmbedVideoBlock,
33-
PageListBlock,
34-
PagePreviewBlock,
35-
QuoteBlock,
36-
RichTextBlock,
37-
TableBlock,
38-
)
39-
from .content_blocks import ( # noqa
40-
AccordionBlock,
41-
CardBlock,
42-
CarouselBlock,
43-
ContentWallBlock,
44-
FilmStripBlock,
45-
ImageGalleryBlock,
46-
ModalBlock,
47-
NavDocumentLinkWithSubLinkBlock,
48-
NavExternalLinkWithSubLinkBlock,
49-
NavPageLinkWithSubLinkBlock,
50-
PriceListBlock,
51-
ReusableContentBlock,
52-
)
53-
from .layout_blocks import CardGridBlock, GridBlock, HeroBlock
54-
from .base_blocks import ( # noqa
55-
BaseBlock,
56-
BaseLayoutBlock,
57-
BaseLinkBlock,
58-
ClassifierTermChooserBlock,
59-
CoderedAdvColumnSettings,
60-
CoderedAdvSettings,
61-
CoderedAdvTrackingSettings,
62-
CollectionChooserBlock,
63-
LinkStructValue,
64-
)
10+
from .base_blocks import BaseBlock # noqa
11+
from .base_blocks import BaseLayoutBlock # noqa
12+
from .base_blocks import BaseLinkBlock # noqa
13+
from .base_blocks import ClassifierTermChooserBlock # noqa
14+
from .base_blocks import CoderedAdvColumnSettings # noqa
15+
from .base_blocks import CoderedAdvSettings # noqa
16+
from .base_blocks import CoderedAdvTrackingSettings # noqa
17+
from .base_blocks import CollectionChooserBlock # noqa
18+
from .base_blocks import LinkStructValue # noqa
19+
from .content_blocks import AccordionBlock
20+
from .content_blocks import CardBlock
21+
from .content_blocks import CarouselBlock
22+
from .content_blocks import ContentWallBlock # noqa
23+
from .content_blocks import FilmStripBlock
24+
from .content_blocks import ImageGalleryBlock
25+
from .content_blocks import ModalBlock
26+
from .content_blocks import NavDocumentLinkWithSubLinkBlock
27+
from .content_blocks import NavExternalLinkWithSubLinkBlock
28+
from .content_blocks import NavPageLinkWithSubLinkBlock
29+
from .content_blocks import PriceListBlock
30+
from .content_blocks import ReusableContentBlock
31+
from .html_blocks import ButtonBlock
32+
from .html_blocks import DownloadBlock
33+
from .html_blocks import EmbedGoogleMapBlock
34+
from .html_blocks import EmbedVideoBlock
35+
from .html_blocks import ImageBlock
36+
from .html_blocks import ImageLinkBlock
37+
from .html_blocks import PageListBlock
38+
from .html_blocks import PagePreviewBlock
39+
from .html_blocks import QuoteBlock
40+
from .html_blocks import RichTextBlock
41+
from .html_blocks import TableBlock
42+
from .layout_blocks import CardGridBlock
43+
from .layout_blocks import GridBlock
44+
from .layout_blocks import HeroBlock
45+
from .stream_form_blocks import CoderedStreamFormCharFieldBlock
46+
from .stream_form_blocks import CoderedStreamFormCheckboxesFieldBlock
47+
from .stream_form_blocks import CoderedStreamFormCheckboxFieldBlock
48+
from .stream_form_blocks import CoderedStreamFormDateFieldBlock
49+
from .stream_form_blocks import CoderedStreamFormDateTimeFieldBlock
50+
from .stream_form_blocks import CoderedStreamFormDropdownFieldBlock
51+
from .stream_form_blocks import CoderedStreamFormFileFieldBlock
52+
from .stream_form_blocks import CoderedStreamFormImageFieldBlock
53+
from .stream_form_blocks import CoderedStreamFormNumberFieldBlock
54+
from .stream_form_blocks import CoderedStreamFormRadioButtonsFieldBlock
55+
from .stream_form_blocks import CoderedStreamFormStepBlock
56+
from .stream_form_blocks import CoderedStreamFormTextFieldBlock
57+
from .stream_form_blocks import CoderedStreamFormTimeFieldBlock
58+
6559

6660
# Collections of blocks commonly used together.
6761

coderedcms/blocks/base_blocks.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
from django.utils.safestring import mark_safe
99
from django.utils.translation import gettext_lazy as _
1010
from wagtail import blocks
11-
from wagtail.models import Collection
1211
from wagtail.coreutils import resolve_model_string
1312
from wagtail.documents.blocks import DocumentChooserBlock
13+
from wagtail.models import Collection
1414

1515
from coderedcms.settings import crx_settings
1616

coderedcms/blocks/content_blocks.py

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,10 @@
99
from wagtail.images.blocks import ImageChooserBlock
1010
from wagtail.snippets.blocks import SnippetChooserBlock
1111

12-
from .base_blocks import (
13-
BaseBlock,
14-
BaseLayoutBlock,
15-
ButtonMixin,
16-
CollectionChooserBlock,
17-
)
12+
from .base_blocks import BaseBlock
13+
from .base_blocks import BaseLayoutBlock
14+
from .base_blocks import ButtonMixin
15+
from .base_blocks import CollectionChooserBlock
1816
from .html_blocks import ButtonBlock
1917

2018

coderedcms/blocks/html_blocks.py

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,20 @@
88
"""
99

1010
import logging
11+
1112
from django.utils.translation import gettext_lazy as _
12-
from wagtail.contrib.table_block.blocks import TableBlock as WagtailTableBlock
1313
from wagtail import blocks
14+
from wagtail.contrib.table_block.blocks import TableBlock as WagtailTableBlock
1415
from wagtail.documents.blocks import DocumentChooserBlock
1516
from wagtail.embeds.blocks import EmbedBlock
1617
from wagtail.images.blocks import ImageChooserBlock
1718

18-
from .base_blocks import (
19-
BaseBlock,
20-
BaseLinkBlock,
21-
ButtonMixin,
22-
ClassifierTermChooserBlock,
23-
CoderedAdvTrackingSettings,
24-
LinkStructValue,
25-
)
19+
from .base_blocks import BaseBlock
20+
from .base_blocks import BaseLinkBlock
21+
from .base_blocks import ButtonMixin
22+
from .base_blocks import ClassifierTermChooserBlock
23+
from .base_blocks import CoderedAdvTrackingSettings
24+
from .base_blocks import LinkStructValue
2625

2726

2827
logger = logging.getLogger("coderedcms")

coderedcms/blocks/layout_blocks.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99

1010
from coderedcms.settings import crx_settings
1111

12-
from .base_blocks import BaseLayoutBlock, CoderedAdvColumnSettings
12+
from .base_blocks import BaseLayoutBlock
13+
from .base_blocks import CoderedAdvColumnSettings
1314

1415

1516
# Level 1 layout blocks

0 commit comments

Comments
 (0)