ruff --fix # also import sorting

examples/request_stream/client.py

@@ -1,5 +1,6 @@
 import requests
 
+
 # Warning: This is a heavy process.
 
 data = ""

guide/content/en/migrate.py

@@ -1,4 +1,5 @@
 import re
+
 from pathlib import Path
 from textwrap import indent
 

guide/pyproject.toml

@@ -0,0 +1,7 @@
+[tool.ruff]
+extend = "../pyproject.toml"
+
+[tool.ruff.isort]
+known-first-party = ["webapp"]
+lines-after-imports = 1
+lines-between-types = 1

guide/webapp/display/base.py

@@ -2,7 +2,6 @@
 
 from html5tagger import Builder, Document  # type: ignore
 
-
 class BaseRenderer:
     def __init__(self, base_title: str):
         self.base_title = base_title

guide/webapp/display/code_style.py

@@ -7,7 +7,6 @@
     Token,
 )
 
-
 class SanicCodeStyle(Style):
     styles = {
         Token: "#777",

guide/webapp/display/layouts/base.py

@@ -6,7 +6,6 @@
 from html5tagger import Builder
 from sanic import Request
 
-
 class BaseLayout:
     def __init__(self, builder: Builder):
         self.builder = builder

guide/webapp/display/layouts/elements/footer.py

@@ -3,7 +3,6 @@
 from html5tagger import Builder, E  # type: ignore
 from sanic import Request
 
-
 def do_footer(builder: Builder, request: Request) -> None:
     builder.footer(
         _pagination(request),

guide/webapp/display/layouts/elements/navbar.py

@@ -1,8 +1,7 @@
-from webapp.display.layouts.models import MenuItem
-
 from html5tagger import Builder, E  # type: ignore
 from sanic import Request
 
+from webapp.display.layouts.models import MenuItem
 
 def do_navbar(builder: Builder, request: Request) -> None:
     navbar_items = [

guide/webapp/display/layouts/elements/sidebar.py

@@ -1,9 +1,8 @@
-from webapp.display.layouts.models import MenuItem
-from webapp.display.text import slugify
-
 from html5tagger import Builder, E  # type: ignore
 from sanic import Request
 
+from webapp.display.layouts.models import MenuItem
+from webapp.display.text import slugify
 
 def do_sidebar(builder: Builder, request: Request) -> None:
     builder.a(class_="burger")(E.span().span().span().span())

guide/webapp/display/layouts/home.py

@@ -8,7 +8,6 @@
 
 from .base import BaseLayout
 
-
 class HomeLayout(BaseLayout):
     @contextmanager
     def layout(

guide/webapp/display/layouts/main.py

@@ -1,15 +1,14 @@
 from contextlib import contextmanager
 from typing import Generator
 
+from sanic import Request
+
 from webapp.display.layouts.elements.footer import do_footer
 from webapp.display.layouts.elements.navbar import do_navbar
 from webapp.display.layouts.elements.sidebar import do_sidebar
 
-from sanic import Request
-
 from .base import BaseLayout
 
-
 class MainLayout(BaseLayout):
     @contextmanager
     def layout(

guide/webapp/display/layouts/models.py

@@ -2,7 +2,6 @@
 
 from msgspec import Struct, field
 
-
 class MenuItem(Struct, kw_only=False, omit_defaults=True):
     label: str
     path: str | None = None

guide/webapp/display/markdown.py

@@ -1,15 +1,15 @@
 import re
+
 from textwrap import dedent
 
+from html5tagger import HTML, Builder, E  # type: ignore
 from mistune import HTMLRenderer, create_markdown, escape
 from mistune.directives import RSTDirective, TableOfContents
 from mistune.util import safe_entity
 from pygments import highlight
 from pygments.formatters import html
 from pygments.lexers import get_lexer_by_name
 
-from html5tagger import HTML, Builder, E  # type: ignore
-
 from .code_style import SanicCodeStyle
 from .plugins.attrs import Attributes
 from .plugins.columns import Column
@@ -20,7 +20,6 @@
 from .plugins.tabs import Tabs
 from .text import slugify
 
-
 class DocsRenderer(HTMLRenderer):
     def block_code(self, code: str, info: str | None = None):
         builder = Builder("Block")

guide/webapp/display/page/docobject.py

@@ -3,19 +3,18 @@
 import importlib
 import inspect
 import pkgutil
+
 from collections import defaultdict
 from dataclasses import dataclass, field
 from html import escape
 
 from docstring_parser import Docstring, DocstringParam, DocstringRaises
 from docstring_parser import parse as parse_docstring
 from docstring_parser.common import DocstringExample
-
 from html5tagger import HTML, Builder, E  # type: ignore
 
 from ..markdown import render_markdown, slugify
 
-
 @dataclass
 class DocObject:
     name: str

guide/webapp/display/page/renderer.py

@@ -3,15 +3,14 @@
 from contextlib import contextmanager
 from typing import Type
 
-from webapp.display.base import BaseRenderer
-
 from html5tagger import HTML, Builder  # type: ignore
 from sanic import Request
 
+from webapp.display.base import BaseRenderer
+
 from ..layouts.base import BaseLayout
 from .page import Page
 
-
 class PageRenderer(BaseRenderer):
     def render(self, request: Request, language: str, path: str) -> Builder:
         builder = self.get_builder(

guide/webapp/display/plugins/attrs.py

@@ -2,13 +2,11 @@
 from textwrap import dedent
 from typing import Any
 
+from html5tagger import HTML, E
 from mistune.block_parser import BlockParser
 from mistune.core import BlockState
 from mistune.directives import DirectivePlugin
 
-from html5tagger import HTML, E
-
-
 class Attributes(DirectivePlugin):
     def __call__(self, directive, md):
         directive.register("attrs", self.parse)

guide/webapp/display/plugins/columns.py

@@ -8,7 +8,6 @@
 from mistune.directives import DirectivePlugin, RSTDirective
 from mistune.markdown import Markdown
 
-
 class Column(DirectivePlugin):
     def parse(
         self, block: BlockParser, m: Match, state: BlockState

guide/webapp/display/plugins/hook.py

@@ -2,7 +2,6 @@
 from mistune.directives import DirectivePlugin, RSTDirective
 from mistune.markdown import Markdown
 
-
 class Hook(DirectivePlugin):
     def __call__(  # type: ignore
         self, directive: RSTDirective, md: Markdown

guide/webapp/display/plugins/mermaid.py

@@ -3,15 +3,13 @@
 from textwrap import dedent
 from typing import Any
 
+from html5tagger import HTML, E
 from mistune import HTMLRenderer
 from mistune.block_parser import BlockParser
 from mistune.core import BlockState
 from mistune.directives import DirectivePlugin, RSTDirective
 from mistune.markdown import Markdown
 
-from html5tagger import HTML, E
-
-
 class Mermaid(DirectivePlugin):
     def parse(
         self, block: BlockParser, m: Match, state: BlockState

guide/webapp/display/plugins/notification.py

@@ -1,7 +1,5 @@
-from mistune.directives import Admonition
-
 from html5tagger import HTML, E
-
+from mistune.directives import Admonition
 
 class Notification(Admonition):
     SUPPORTED_NAMES = {

guide/webapp/display/plugins/span.py

@@ -2,7 +2,6 @@
 
 from mistune.markdown import Markdown
 
-
 def parse_inline_span(inline, m: re.Match, state):
     state.append_token(
         {

guide/webapp/display/plugins/tabs.py

@@ -8,7 +8,6 @@
 from mistune.directives import DirectivePlugin, RSTDirective
 from mistune.markdown import Markdown
 
-
 class Tabs(DirectivePlugin):
     def parse(
         self, block: BlockParser, m: Match, state: BlockState

guide/webapp/display/search/renderer.py

@@ -1,15 +1,14 @@
 from contextlib import contextmanager
 from urllib.parse import unquote
 
-from webapp.display.search.search import Searcher
-
 from html5tagger import Builder, E  # type: ignore
 from sanic import Request
 
+from webapp.display.search.search import Searcher
+
 from ..base import BaseRenderer
 from ..layouts.main import MainLayout
 
-
 class SearchRenderer(BaseRenderer):
     def render(
         self, request: Request, language: str, searcher: Searcher, full: bool

guide/webapp/display/search/search.py

@@ -5,8 +5,8 @@
 from typing import ClassVar
 
 from msgspec import Struct
-from webapp.display.page import Page
 
+from webapp.display.page import Page
 
 class Stemmer:
     STOP_WORDS: ClassVar[set[str]] = set(

guide/webapp/endpoint/search.py

@@ -1,11 +1,11 @@
 # from urllib.parse import unquote
 
+from sanic import Blueprint, Request, Sanic, html
+
 from webapp.display.page import Page
 from webapp.display.search.renderer import SearchRenderer
 from webapp.display.search.search import Document, Searcher, Stemmer
 
-from sanic import Blueprint, Request, Sanic, html
-
 bp = Blueprint("search", url_prefix="/<language>/search")
 
 

guide/webapp/worker/config.py

@@ -1,8 +1,8 @@
 from pathlib import Path
 
 from msgspec import yaml
-from webapp.display.layouts.models import GeneralConfig, MenuItem
 
+from webapp.display.layouts.models import GeneralConfig, MenuItem
 
 def load_menu(path: Path) -> list[MenuItem]:
     loaded = yaml.decode(path.read_bytes(), type=dict[str, list[MenuItem]])

guide/webapp/worker/factory.py

@@ -1,15 +1,14 @@
 from pathlib import Path
 
+from sanic import Request, Sanic, html, redirect
+
 from webapp.display.layouts.models import MenuItem
 from webapp.display.page import Page, PageRenderer
 from webapp.endpoint.view import bp
 from webapp.worker.config import load_config, load_menu
 from webapp.worker.reload import setup_livereload
 from webapp.worker.style import setup_style
 
-from sanic import Request, Sanic, html, redirect
-
-
 def _compile_sidebar_order(items: list[MenuItem]) -> list[str]:
     order = []
     for item in items:

guide/webapp/worker/reload.py

@@ -8,7 +8,6 @@
 
 from sanic import Request, Sanic, Websocket
 
-
 def setup_livereload(app: Sanic) -> None:
     @app.main_process_start
     async def main_process_start(app: Sanic):

guide/webapp/worker/style.py

@@ -1,11 +1,10 @@
 # from scss.compiler import compile_string
 
 from pygments.formatters import html
-from sass import compile as compile_scss
-from webapp.display.code_style import SanicCodeStyle
-
 from sanic import Sanic
+from sass import compile as compile_scss
 
+from webapp.display.code_style import SanicCodeStyle
 
 def setup_style(app: Sanic) -> None:
     index = app.config.STYLE_DIR / "index.scss"

pyproject.toml

@@ -4,6 +4,13 @@ build-backend = "setuptools.build_meta"
 
 [tool.ruff]
 line-length = 79
+extend-select = ["I"]
+
+[tool.ruff.isort]
+known-first-party = ["sanic"]
+known-third-party = ["pytest"]
+lines-after-imports = 2
+lines-between-types = 1
 
 [tool.black]
 line-length = 79

sanic/worker/state.py

@@ -1,7 +1,6 @@
 from collections.abc import Mapping
-from typing import Any, Dict, ItemsView, Iterator, KeysView, List
+from typing import Any, Dict, ItemsView, Iterator, KeysView, List, ValuesView
 from typing import Mapping as MappingType
-from typing import ValuesView
 
 
 dict

scripts/changelog.py

@@ -1,12 +1,14 @@
 #!/usr/bin/env python
 
-from os import path
 import sys
 
+from os import path
+
+
 if __name__ == "__main__":
     try:
-        import towncrier
         import click
+        import towncrier
     except ImportError:
         print(
             "Please make sure you have a installed towncrier and click before using this tool"