Run isort & black, automaticly check in CI (#302)

* Run isort & black

* Automate on CI

* Address PR comments

* PR comments

* Keep scripts untouched

* Create extensions.json

* Black 2024 style

* isort on sympy-stubs

* black on sympy-stubs

---------

Co-authored-by: Erik De Bonte <[email protected]>

Author: Avasam

.github/workflows/test.yml

@@ -33,3 +33,19 @@ jobs:
         with:
           project: tests/pyrighttestconfig.json
           warn-partial: true
+
+  hygiene:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: Run isort
+        uses: isort/isort-action@v1
+
+      - name: Run Black
+        uses: psf/black@stable
+        with:
+          options: "--check --verbose"

.vscode/extensions.json

@@ -0,0 +1,11 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "ms-python.black-formatter",
+        "ms-python.isort",
+        "ms-python.mypy-type-checker",
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+    ]
+}

pyproject.toml

@@ -85,4 +85,4 @@ strict_equality = true
 # Configuring error messages
 show_error_context = false
 show_column_numbers = false
-show_error_codes = true
+show_error_codes = true

stubs/matplotlib/__init__.pyi

@@ -1,56 +1,51 @@
-import numpy as np
-from typing import Generator, Literal
-from ._typing import *
 import contextlib
+from typing import Generator, Literal
+
+import numpy as np
 from packaging.version import parse as parse_version
-from . import _docstring, _version, cbook, rcsetup
-from . import colors as colors
 
-class __getattr__:
+from . import _docstring, _version, cbook, colors as colors, rcsetup
+from ._typing import *
 
+class __getattr__:
     URL_REGEX = ...
 
-def set_loglevel(
-    level: Literal["notset", "debug", "info", "warning", "error", "critical"]
-)-> None: ...
+def set_loglevel(level: Literal["notset", "debug", "info", "warning", "error", "critical"]) -> None: ...
 
-class ExecutableNotFoundError(FileNotFoundError):
-    ...
+class ExecutableNotFoundError(FileNotFoundError): ...
 
-def checkdep_usetex(s)-> bool: ...
+def checkdep_usetex(s) -> bool: ...
 def get_configdir() -> str: ...
 def get_cachedir() -> str: ...
 def get_data_path() -> str: ...
 def matplotlib_fname() -> str: ...
 
 class RcParams(dict):
-
     validate = ...
     def __init__(self, *args, **kwargs) -> None: ...
-    def find_all(self, pattern)-> RcParams: ...
-    def copy(self)-> RcParams: ...
+    def find_all(self, pattern) -> RcParams: ...
+    def copy(self) -> RcParams: ...
 
 def rc_params(fail_on_error: bool = ...) -> RcParams: ...
 def is_url(filename: str) -> bool: ...
-def rc_params_from_file(
-    fname: str | PathLike, fail_on_error: bool = ..., use_default_template: bool = ...
-) -> RcParams: ...
+def rc_params_from_file(fname: str | PathLike, fail_on_error: bool = ..., use_default_template: bool = ...) -> RcParams: ...
 
 rcParamsDefault: RcParams = ...
 rcParams: RcParams = ...
 rcParamsOrig: RcParams = ...
 
-def rc(group, **kwargs)-> None: ...
-def rcdefaults()-> None: ...
-def rc_file_defaults()-> None: ...
-def rc_file(fname: str | PathLike, *, use_default_template: bool = ...)-> None: ...
+def rc(group, **kwargs) -> None: ...
+def rcdefaults() -> None: ...
+def rc_file_defaults() -> None: ...
+def rc_file(fname: str | PathLike, *, use_default_template: bool = ...) -> None: ...
 @contextlib.contextmanager
-def rc_context(rc: dict = ..., fname: str | PathLike = ...)-> Generator: ...
-def use(backend: str, *, force: bool = True)-> None: ...
+def rc_context(rc: dict = ..., fname: str | PathLike = ...) -> Generator: ...
+def use(backend: str, *, force: bool = True) -> None: ...
 def get_backend() -> str: ...
 def interactive(b) -> bool: ...
 def is_interactive() -> bool: ...
 
 default_test_modules: list[str] = ...
 
-def test(verbosity=..., coverage=..., **kwargs): int: ...
+def test(verbosity=..., coverage=..., **kwargs):
+    int: ...

stubs/matplotlib/_afm.pyi

@@ -1,4 +1,5 @@
 import numpy as np
+
 from ._typing import *
 
 CharMetrics = ...
@@ -9,16 +10,16 @@ class AFM:
     def get_bbox_char(self, c: str, isord: bool = False): ...
     def string_width_height(self, s: str) -> tuple[float, float]: ...
     def get_str_bbox_and_descent(self, s: str) -> tuple[float, ...]: ...
-    def get_str_bbox(self, s: str)-> tuple[float, ...]: ...
-    def get_name_char(self, c: str, isord: bool = False)-> str: ...
-    def get_width_char(self, c: str, isord: bool =False)-> float: ...
-    def get_width_from_char_name(self, name: str)-> float: ...
-    def get_height_char(self, c: str, isord: bool = False)-> float: ...
-    def get_kern_dist(self, c1: str, c2: str)-> float: ...
-    def get_kern_dist_from_name(self, name1: str, name2: str)-> float: ...
+    def get_str_bbox(self, s: str) -> tuple[float, ...]: ...
+    def get_name_char(self, c: str, isord: bool = False) -> str: ...
+    def get_width_char(self, c: str, isord: bool = False) -> float: ...
+    def get_width_from_char_name(self, name: str) -> float: ...
+    def get_height_char(self, c: str, isord: bool = False) -> float: ...
+    def get_kern_dist(self, c1: str, c2: str) -> float: ...
+    def get_kern_dist_from_name(self, name1: str, name2: str) -> float: ...
     def get_fontname(self) -> str: ...
     @property
-    def postscript_name(self)-> str: ...
+    def postscript_name(self) -> str: ...
     def get_fullname(self) -> str: ...
     def get_familyname(self) -> str: ...
     @property

stubs/matplotlib/_api/__init__.pyi

@@ -1,28 +1,20 @@
+import functools
 from typing import Any, Callable, Generator, Iterable, Type
 
-import functools
-from .deprecation import (
-    MatplotlibDeprecationWarning,
-)
+from .deprecation import MatplotlibDeprecationWarning
 
 class classproperty:
-    def __init__(
-        self, fget: Callable, fset: None = ..., fdel: None = ..., doc: None = ...
-    ) -> None: ...
+    def __init__(self, fget: Callable, fset: None = ..., fdel: None = ..., doc: None = ...) -> None: ...
     def __get__(self, instance, owner): ...
     @property
     def fget(self): ...
 
 def check_isinstance(**kwargs) -> None: ...
-def check_in_list(
-    _values: Iterable, *, _print_supported_values: bool = True, **kwargs
-) -> None: ...
+def check_in_list(_values: Iterable, *, _print_supported_values: bool = True, **kwargs) -> None: ...
 def check_shape(**kwargs) -> None: ...
 def check_getitem(_mapping: dict, **kwargs): ...
 def caching_module_getattr(cls) -> functools._lru_cache_wrapper: ...
-def define_aliases(
-    alias_d: dict[str, list[str]], cls: None = ...
-) -> functools.partial: ...
+def define_aliases(alias_d: dict[str, list[str]], cls: None = ...) -> functools.partial: ...
 def select_matching_signature(funcs: list[Callable], *args, **kwargs): ...
 def recursive_subclasses(cls) -> Generator: ...
 def warn_external(

stubs/matplotlib/_api/deprecation.pyi

@@ -1,5 +1,5 @@
-from functools import partial
 import contextlib
+from functools import partial
 from typing import Callable, Iterator
 
 class MatplotlibDeprecationWarning(DeprecationWarning): ...
@@ -13,7 +13,7 @@ def warn_deprecated(
     pending: bool = ...,
     obj_type: str = ...,
     addendum: str = ...,
-    removal: str = ...
+    removal: str = ...,
 ) -> None: ...
 def deprecated(
     since: str,
@@ -24,7 +24,7 @@ def deprecated(
     pending: bool = ...,
     obj_type: str = ...,
     addendum: str = ...,
-    removal: str = ...
+    removal: str = ...,
 ) -> Callable: ...
 
 class deprecate_privatize_attribute:
@@ -33,19 +33,13 @@ class deprecate_privatize_attribute:
 
 DECORATORS: dict = ...
 
-def rename_parameter(
-    since: str, old: str, new: str, func: None | Callable = ...
-) -> partial | Callable: ...
+def rename_parameter(since: str, old: str, new: str, func: None | Callable = ...) -> partial | Callable: ...
 
 class _deprecated_parameter_class:
     def __repr__(self): ...
 
-def delete_parameter(
-    since: str, name: str, func: None | Callable = ..., **kwargs
-) -> partial | Callable: ...
-def make_keyword_only(
-    since: str, name: str, func: None | Callable = ...
-) -> partial | Callable: ...
+def delete_parameter(since: str, name: str, func: None | Callable = ..., **kwargs) -> partial | Callable: ...
+def make_keyword_only(since: str, name: str, func: None | Callable = ...) -> partial | Callable: ...
 def deprecate_method_override(method, obj, *, allow_empty: bool = ..., **kwargs): ...
 @contextlib.contextmanager
 def suppress_matplotlib_deprecation_warning() -> Iterator[None]: ...

stubs/matplotlib/_cm.pyi

@@ -1,9 +1,7 @@
 from functools import partial
 from typing import Any
 
-def cubehelix(
-    gamma: float = 1, s: float = 0.5, r: float = -1.5, h: float = 1
-) -> dict[str, partial]: ...
+def cubehelix(gamma: float = 1, s: float = 0.5, r: float = -1.5, h: float = 1) -> dict[str, partial]: ...
 
 gfunc: dict[int, Any] = ...
 

stubs/matplotlib/_constrained_layout.pyi

@@ -1,31 +1,43 @@
 from matplotlib.backend_bases import RendererBase
-from .figure import Figure
+
 from .axes import Axes
+from .figure import Figure
 from .transforms import Bbox
 
 def do_constrained_layout(
-    fig: Figure,
-    h_pad: float,
-    w_pad: float,
-    hspace: float|None = None,
-    wspace: float|None = None,
-    rect: tuple = ...
-)-> dict: ...
-def make_layoutgrids(fig, layoutgrids:dict, rect=...)-> dict: ...
-def make_layoutgrids_gs(layoutgrids: dict, gs)-> dict: ...
-def check_no_collapsed_axes(layoutgrids, fig: Figure)-> bool: ...
+    fig: Figure, h_pad: float, w_pad: float, hspace: float | None = None, wspace: float | None = None, rect: tuple = ...
+) -> dict: ...
+def make_layoutgrids(fig, layoutgrids: dict, rect=...) -> dict: ...
+def make_layoutgrids_gs(layoutgrids: dict, gs) -> dict: ...
+def check_no_collapsed_axes(layoutgrids, fig: Figure) -> bool: ...
 def compress_fixed_aspect(layoutgrids, fig: Figure): ...
-def get_margin_from_padding(obj, *, w_pad: float=0, h_pad: float=0, hspace: float=0, wspace: float=0)-> dict: ...
+def get_margin_from_padding(obj, *, w_pad: float = 0, h_pad: float = 0, hspace: float = 0, wspace: float = 0) -> dict: ...
 def make_layout_margins(
-    layoutgrids: dict, fig: Figure, renderer: RendererBase, *, w_pad: float=0, h_pad: float=0, hspace: float=0, wspace: float=0
-)-> dict: ...
-def make_margin_suptitles(layoutgrids: dict, fig: Figure, renderer: RendererBase, *, w_pad: float=0, h_pad: float=0)-> None: ...
-def match_submerged_margins(layoutgrids: dict, fig: Figure)-> None: ...
-def get_cb_parent_spans(cbax)-> tuple[range, range]: ...
+    layoutgrids: dict,
+    fig: Figure,
+    renderer: RendererBase,
+    *,
+    w_pad: float = 0,
+    h_pad: float = 0,
+    hspace: float = 0,
+    wspace: float = 0,
+) -> dict: ...
+def make_margin_suptitles(
+    layoutgrids: dict, fig: Figure, renderer: RendererBase, *, w_pad: float = 0, h_pad: float = 0
+) -> None: ...
+def match_submerged_margins(layoutgrids: dict, fig: Figure) -> None: ...
+def get_cb_parent_spans(cbax) -> tuple[range, range]: ...
 def get_pos_and_bbox(ax: Axes, renderer: RendererBase) -> tuple[Bbox, Bbox]: ...
 def reposition_axes(
-    layoutgrids: dict, fig: Figure, renderer: RendererBase, *, w_pad: float=0, h_pad: float=0, hspace: float=0, wspace: float=0
-)-> None: ...
-def reposition_colorbar(layoutgrids: dict, cbax: Axes, renderer: RendererBase, *, offset: float|None=None)-> dict: ...
-def reset_margins(layoutgrids: dict, fig: Figure)-> None: ...
-def colorbar_get_pad(layoutgrids: dict, cax: Axes)-> float: ...
+    layoutgrids: dict,
+    fig: Figure,
+    renderer: RendererBase,
+    *,
+    w_pad: float = 0,
+    h_pad: float = 0,
+    hspace: float = 0,
+    wspace: float = 0,
+) -> None: ...
+def reposition_colorbar(layoutgrids: dict, cbax: Axes, renderer: RendererBase, *, offset: float | None = None) -> dict: ...
+def reset_margins(layoutgrids: dict, fig: Figure) -> None: ...
+def colorbar_get_pad(layoutgrids: dict, cax: Axes) -> float: ...

stubs/matplotlib/_enums.pyi

@@ -4,10 +4,9 @@ class _AutoStringNameEnum(Enum):
     def __hash__(self) -> int: ...
 
 class JoinStyle(str, _AutoStringNameEnum):
-
-    miter: JoinStyle 
-    round: JoinStyle 
-    bevel: JoinStyle 
+    miter: JoinStyle
+    round: JoinStyle
+    bevel: JoinStyle
     @staticmethod
     def demo() -> None: ...
 

stubs/matplotlib/_layoutgrid.pyi

@@ -1,19 +1,20 @@
 from typing import Literal
+
+from .figure import Figure
 from .gridspec import SubplotSpec
 from .transforms import Bbox
-from .figure import Figure
 
 class LayoutGrid:
     def __init__(
         self,
-        parent: LayoutGrid | tuple[int, int, int, int]|None = None,
+        parent: LayoutGrid | tuple[int, int, int, int] | None = None,
         parent_pos: tuple[range, range] | tuple[int, int] = (0, 0),
         parent_inner: bool = False,
-        name: str = '',
+        name: str = "",
         ncols: int = 1,
         nrows: int = 1,
-        h_pad: float|None = None,
-        w_pad: float|None = None,
+        h_pad: float | None = None,
+        w_pad: float | None = None,
         width_ratios: None | list[float] = None,
         height_ratios: None | list[float] = None,
     ) -> None: ...
@@ -29,22 +30,16 @@ class LayoutGrid:
     ) -> None: ...
     def parent_constraints(self) -> None: ...
     def grid_constraints(self) -> None: ...
-    def edit_margin(
-        self, todo: Literal["left", "right", "bottom", "top"], size: float, cell: int
-    ) -> None: ...
+    def edit_margin(self, todo: Literal["left", "right", "bottom", "top"], size: float, cell: int) -> None: ...
     def edit_margin_min(
         self,
         todo: Literal["left", "right", "bottom", "top"],
         size: float,
         cell: int = 0,
     ) -> None: ...
-    def edit_margins(
-        self, todo: Literal["left", "right", "bottom", "top"], size: float
-    ) -> None: ...
-    def edit_all_margins_min(
-        self, todo: Literal["left", "right", "bottom", "top"], size: float
-    ): ...
-    def edit_outer_margin_mins(self, margin: dict, ss: SubplotSpec)-> None: ...
+    def edit_margins(self, todo: Literal["left", "right", "bottom", "top"], size: float) -> None: ...
+    def edit_all_margins_min(self, todo: Literal["left", "right", "bottom", "top"], size: float): ...
+    def edit_outer_margin_mins(self, margin: dict, ss: SubplotSpec) -> None: ...
     def get_margins(self, todo, col) -> Bbox: ...
     def get_outer_bbox(self, rows=0, cols=0) -> Bbox: ...
     def get_inner_bbox(self, rows=0, cols=0) -> Bbox: ...
@@ -57,4 +52,4 @@ class LayoutGrid:
 
 def seq_id() -> str: ...
 def print_children(lb) -> None: ...
-def plot_children(fig: Figure, lg=None, level: int=0, printit: bool=False)->None: ...
+def plot_children(fig: Figure, lg=None, level: int = 0, printit: bool = False) -> None: ...