modernize project, move to pyproject.toml and use ruff

Author: skshetry

.github/workflows/release.yml

@@ -13,14 +13,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Check out the repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v4
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v5
       with:
-        python-version: '3.10'
+        python-version: '3.13'
 
     - name: Upgrade pip and nox
       run: |

.github/workflows/tests.yml

@@ -21,16 +21,16 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-20.04, windows-latest, macos-latest]
-        pyv: ['3.8', '3.9', '3.10', '3.11']
+        pyv: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
 
     steps:
     - name: Check out the repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
     - name: Set up Python ${{ matrix.pyv }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.pyv }}
 
@@ -56,7 +56,7 @@ jobs:
       run: nox -s tests-${{ matrix.nox_pyv || matrix.pyv }} -- --cov-report=xml
 
     - name: Upload coverage report
-      uses: codecov/codecov-action@v3.1.1
+      uses: codecov/codecov-action@v5
 
     - name: Build package
       run: nox -s build

.pre-commit-config.yaml

@@ -1,12 +1,8 @@
 default_language_version:
   python: python3
 repos:
-  - repo: https://github.com/psf/black
-    rev: 23.1.0
-    hooks:
-      - id: black
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -23,32 +19,14 @@ repos:
         args: ['--fix=lf']
       - id: sort-simple-yaml
       - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.9.3'
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.2
+    rev: v2.4.1
     hooks:
       - id: codespell
         additional_dependencies: ["tomli"]
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
-    hooks:
-      - id: pyupgrade
-        args: [--py38-plus]
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-  - repo: https://github.com/pycqa/flake8
-    rev: 6.0.0
-    hooks:
-      - id: flake8
-        additional_dependencies:
-          - flake8-bugbear==23.1.20
-          - flake8-comprehensions==3.10.1
-          - flake8-debugger==4.1.2
-          - flake8-string-format==0.3.0
-  - repo: https://github.com/pycqa/bandit
-    rev: 1.7.4
-    hooks:
-      - id: bandit
-        args: [-c, pyproject.toml]
-        additional_dependencies: ["toml"]

MANIFEST.in

@@ -1,4 +1,5 @@
 """Automation using nox."""
+
 import glob
 import os
 
@@ -31,12 +32,11 @@ def lint(session: nox.Session) -> None:
     args = *(session.posargs or ("--show-diff-on-failure",)), "--all-files"
     session.run("pre-commit", "run", *args)
     session.run("python", "-m", "mypy")
-    session.run("python", "-m", "pylint", *locations)
 
 
 @nox.session
 def build(session: nox.Session) -> None:
-    session.install("build", "setuptools", "twine")
+    session.install("build", "twine")
     session.run("python", "-m", "build")
     dists = glob.glob("dist/*")
     session.run("twine", "check", *dists, silent=True)

noxfile.py

@@ -2,30 +2,45 @@
 requires = ["setuptools>=48", "setuptools_scm[toml]>=6.3.1"]
 build-backend = "setuptools.build_meta"
 
-[tool.setuptools_scm]
+[project]
+name = "ossfs"
+description = "fsspec filesystem for OSS"
+readme = "README.rst"
+authors = [{ name = "Yanxiang Gao", email = "[email protected]" }]
+maintainers = [{ name = "Yanxiang Gao", email = "[email protected]" }]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+requires-python = ">=3.8"
+dependencies = ["aiooss2>=0.2.7", "fsspec>=2023.9.2", "oss2==2.18.1"]
+license = { text = "Apache-2.0" }
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/fsspec/ossfs"
 
-[tool.black]
-line-length = 88
-include = '\.pyi?$'
-exclude = '''
-/(
-    \.eggs
-  | \.git
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | \.venv
-  | _build
-  | buck-out
-  | build
-  | dist
-)/
-'''
+[project.optional-dependencies]
+tests = [
+    "aliyun-python-sdk-sts==3.1.1",
+    "pytest-cov>=3,<6",
+    "pytest-mock>=3.8.2,<4",
+    "pytest>=7.2.0,<8",
+    "requests>=2.31.0",
+]
+dev = ["ossfs[tests]", "mypy==0.971"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = false
 
-[tool.isort]
-profile = "black"
-known_first_party = ["ossfs"]
-line_length = 88
+[tool.setuptools_scm]
 
 [tool.pytest.ini_options]
 addopts = "-ra"
@@ -67,19 +82,21 @@ files = ["src", "tests"]
 module = ["oss2.*", "fsspec.*", "aliyunsdkcore", "aliyunsdksts.*", "requests"]
 ignore_missing_imports = true
 
-[tool.pylint.format]
-max-line-length = 88
-
-[tool.pylint.message_control]
-enable = ["c-extension-no-member", "no-else-return"]
-
-[tool.pylint.variables]
-dummy-variables-rgx = "_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_"
-ignored-argument-names = "_.*|^ignored_|^unused_|args|kwargs"
-
 [tool.codespell]
 ignore-words-list = " "
 
-[tool.bandit]
-exclude_dirs = ["tests"]
-skips = ["B101"]
+[tool.ruff.lint]
+select = [
+    "F", "E", "W", "C90", "I", "N", "UP", "YTT", "ASYNC", "S", "BLE", "B", "A", "C4", "DTZ", "T10",
+    "EXE", "ISC", "ICN", "LOG", "G", "INP", "PIE", "T20", "PYI", "PT", "Q", "RSE", "RET",
+    "SLOT", "SIM", "TID", "TC", "ARG", "PGH", "PLC", "PLE", "PLR", "PLW", "TRY",
+    "FLY", "PERF", "FURB", "RUF",
+]
+ignore = ["D", "FA", "S101", "ANN", "FBT", "PLR2004", "TRY003", "PT011", "SIM117", "TRY300"]
+
+[tool.ruff.lint.flake8-unused-arguments]
+ignore-variadic-names = true
+
+[tool.ruff.lint.per-file-ignores]
+"docs/**" = ["INP001"]
+"tests/**" = ["S", "TRY", "ARG"]

pyproject.toml

@@ -3,8 +3,9 @@
 ----------------------------------------------------------------
 A pythonic file-systems interface to OSS (Object Storage Service)
 """
+
 from .async_oss import AioOSSFileSystem
 from .core import OSSFileSystem
 from .file import OSSFile
 
-__all__ = ["OSSFile", "OSSFileSystem", "AioOSSFileSystem"]
+__all__ = ["AioOSSFileSystem", "OSSFile", "OSSFileSystem"]