Merge pull request optuna#5408 from HideakiImamura/add-pre-commit-config

Add pre-commit config

.pre-commit-config.yaml

@@ -0,0 +1,60 @@
+# pre-commit package installation is necessary to use pre-commit.
+# $ pip install pre-commit
+# $ pre-commit install
+
+default_language_version:
+  python: python3
+
+repos:
+  # Args are based on setup.cfg.
+  - repo: https://github.com/psf/black
+    rev: 24.8.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.1.1
+    hooks:
+      - id: flake8
+        exclude: tutorial|docs/visualization_examples|docs/visualization_matplotlib_examples
+        args: [
+            "--max-line-length=99",
+            "--ignore=E203,E704,W503",
+            "--statistics",
+        ]
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.2
+    hooks:
+    - id: mypy
+      additional_dependencies: [
+        "alembic>=1.5.0",
+        "colorlog",
+        "numpy",
+        "packaging>=20.0",
+        "sqlalchemy>=1.3.0",
+        "tqdm",
+        "PyYAML",
+        "mypy_boto3_s3",
+        "types-PyYAML",
+        "types-redis",
+        "types-setuptools",
+        "types-tqdm",
+        "typing_extensions>=3.10.0.0",
+      ]
+      exclude: docs|tutorial|optuna/storages/_rdb/alembic
+      args: [
+        --warn-unused-configs,
+        --disallow-untyped-calls,
+        --disallow-untyped-defs,
+        --disallow-incomplete-defs,
+        --check-untyped-defs,
+        --no-implicit-optional,
+        --warn-redundant-casts,
+        --strict-equality,
+        --extra-checks,
+        --no-implicit-reexport,
+        --ignore-missing-imports,
+      ]

CONTRIBUTING.md

@@ -78,6 +78,17 @@ $ pip install ".[checking]"
 $ ./formats.sh
 ```
 
+You can use `pre-commit` to automatically check the format, coding style, and type hints before committing.
+The following commands automatically fix format errors by auto-formatters.
+
+```bash
+# Install `pre-commit`.
+$ pip install pre-commit
+
+$ pre-commit install
+$ pre-commit run --all-files
+```
+
 ### Documentation
 
 When adding a new feature to the framework, you also need to document it in the reference.

optuna/storages/_rdb/models.py

@@ -36,8 +36,7 @@
     _Column = mapped_column
 except ImportError:
     # TODO(Shinichi): Remove this after dropping support for SQLAlchemy<2.0.
-    from sqlalchemy import Column as _Column  # type: ignore[assignment]
-
+    from sqlalchemy import Column as _Column  # type: ignore[assignment, no-redef]
 
 # Don't modify this version number anymore.
 # The schema management functionality has been moved to alembic.

pyproject.toml

@@ -127,7 +127,7 @@ version = {attr = "optuna.version.__version__"}
 [tool.black]
 line-length = 99
 target-version = ['py38']
-exclude = '''
+force-exclude = '''
 /(
   \.eggs
   | \.git