Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce ruff to check code style #13

Merged
merged 1 commit into from
Aug 19, 2024
Merged

Introduce ruff to check code style #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .pylintrc
View file
Open in desktop

This file was deleted.

10 changes: 4 additions & 6 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,15 @@ install: ## Install the project in dev mode.

.PHONY: fmt
fmt: ## Format code using black & isort.
poetry run ruff check tosfs/ --fix
$(ENV_PREFIX)isort tosfs/
$(ENV_PREFIX)black -l 79 tosfs/
$(ENV_PREFIX)black -l 79 tosfs/tests/
$(ENV_PREFIX)black -l 88 tosfs/

.PHONY: lint
lint: ## Run pep8, black, mypy linters.
set -e;
$(ENV_PREFIX)pylint tosfs/
$(ENV_PREFIX)flake8 tosfs/
$(ENV_PREFIX)black -l 79 --check tosfs/
$(ENV_PREFIX)black -l 79 --check tosfs/tests/
$(ENV_PREFIX)black -l 88 --check tosfs/
poetry run ruff check tosfs/
$(ENV_PREFIX)mypy --ignore-missing-imports tosfs/

.PHONY: test
Expand Down
148 changes: 28 additions & 120 deletions poetry.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

72 changes: 70 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,82 @@ tos = ">=2.7.0"
[tool.poetry.group.dev.dependencies]
fsspec = ">=2023.5.0"
tos = ">=2.7.0"
pylint = "==3.2.6"
flake8 = "==7.0.0"
black = "==24.4.1"
isort = "==5.13.2"
mypy = "==1.10.0"
pytest = "==8.1.1"
pytest-cov = "==5.0.0"
coverage = "==7.5.0"
ruff = "==0.6.0"

[tool.pydocstyle]
convention = "numpy"

[tool.ruff]
target-version = "py39"
line-length = 88

[tool.ruff.lint]
select = [
"A", # Annotations rules
"ASYNC", # Asynchronous programming rules
"B", # Bugbear rules
"C", # Complexity rules
"D", # Docstring rules
"E", # Error rules
"F", # Pyflakes rules
"FURB", # FURB rules
"G", # General rules
"I", # Import rules
"LOG", # Logging rules
"N", # Naming rules
"PERF", # Performance rules
"PIE", # PIE rules
"PLC", # Pylint convention rules
"PLE", # Pylint error rules
"PLR", # Pylint refactor rules
"PLW", # Pylint warning rules
"PT", # Pytest rules
"PYI", # Pyright rules
"Q", # Quotes rules
"RUF", # Ruff-specific rules
"S", # Security rules
"SIM", # Similarity rules
"SLOT", # Slot rules
"T", # Testing rules
"W", # Whitespace rules
"YTT", # YTT rules
]
ignore = [
"S101", # Use of `assert` detected
"S311", # Standard pseudo-random generators are not suitable for cryptographic purposes
"D203", # no-blank-line-before-class
"D213", # multi-line-summary-second-line
"PLR0913", # Too many arguments in function definition
"SIM105", # Use `contextlib.suppress(IOError)` instead of `try`-`except`-`pass`
]

[tool.ruff.lint.per-file-ignores]
"tosfs/tests/*" = [
#D103 Missing docstring in public function
"D103",
#D100 Missing docstring in public module
"D100"
]
"tosfs/__init__.py" = [
#D104 Missing docstring in public package
"D104",
#D107 Missing docstring in __init__
"D107"
]

[tool.mypy]
python_version = "3.9"
ignore_missing_imports = true
disallow_untyped_calls = true
disallow_untyped_defs = true
strict_optional = true
exclude = "tosfs/tests/.*"

[build-system]
requires = ["poetry-core"]
Expand Down
Loading