ci: add linter action

notice about v0.3.0 development

.github/workflows/build-and-draft-release.yml

@@ -0,0 +1,48 @@
+name: "Build and draft a release"
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+permissions:
+  contents: write
+  discussions: write
+
+jobs:
+  build-and-draft-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python environment
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build package
+        run: |
+          pip install build
+          python -m build
+
+      - name: Remove `v` in tag name
+        uses: mad9000/actions-find-and-replace-string@5
+        id: tagNameReplaced
+        with:
+          source: ${{ github.ref_name }}
+          find: "v"
+          replace: ""
+
+      - name: Draft a release
+        uses: softprops/action-gh-release@v2
+        with:
+          discussion_category_name: New releases
+          draft: true
+          generate_release_notes: true
+          files: |
+            dist/arcaea_offline-${{ steps.tagNameReplaced.outputs.value }}*.whl
+            dist/arcaea-offline-${{ steps.tagNameReplaced.outputs.value }}.tar.gz

.github/workflows/main.yml

@@ -0,0 +1,40 @@
+name: test & lint
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    types: [opened, reopened]
+  workflow_dispatch:
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dev dependencies
+        run: 'pip install .[dev]'
+      - name: Run tests
+        run: 'pytest -v'
+
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dev dependencies
+        run: 'pip install .[dev]'
+      - name: Run linter
+        run: 'ruff check'

.pre-commit-config.yaml

@@ -4,11 +4,10 @@ repos:
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/psf/black
-    rev: 23.1.0
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.4
     hooks:
-      - id: black
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
+      - id: ruff
+        args: ["--fix"]
+      - id: ruff-format

.sourcery.yaml

@@ -0,0 +1,2 @@
+rule_settings:
+  python_version: '3.8'

README.md

@@ -10,9 +10,14 @@ English | [简体中文](./README.zh_Hans.md)
 
 ## WIP
 
-> **Warning**
+> [!CAUTION]
 > This project is under active development, thus it is unstable and API may change frequently.
 
+> [!IMPORTANT]
+> v0.3.0 is under development, check out [this branch](https://github.com/283375/arcaea-offline/tree/0.3.0-refactor)!
+>
+> Once v0.3.0 is ready for release, this repository will be transferred to *[ArcaeaOffline](https://github.com/ArcaeaOffline)/core-python*
+
 ## What is this？
 
 This is the core library of `Arcaea Offline`, designed to manage player scores, calculate their potential, and provide various useful tools.

README.zh_Hans.md

@@ -8,9 +8,14 @@
 
 ## WIP
 
-> **Warning**
+> [!CAUTION]
 > 该项目正处于早期开发阶段，不能保证稳定性，且 API 可能随时变动。
 
+> [!IMPORTANT]
+> v0.3.0 正在[此分支](https://github.com/283375/arcaea-offline/tree/0.3.0-refactor)下开发！
+>
+> 在 v0.3.0 准备好发布后，此存储库将被迁移至 *[ArcaeaOffline](https://github.com/ArcaeaOffline)/core-python*。
+
 ## 这是什么？
 
 这是 `Arcaea Offline` 的核心依赖库，用于维护分数数据库、计算潜力值，并提供一些实用工具。

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "arcaea-offline"
-version = "0.2.1"
+version = "0.2.2"
 authors = [{ name = "283375", email = "log_283375@163.com" }]
 description = "Manage your local Arcaea score database."
 readme = "README.md"
@@ -20,24 +20,34 @@ classifiers = [
   "Programming Language :: Python :: 3",
 ]
 
+[project.optional-dependencies]
+dev = ["ruff~=0.4", "pre-commit~=3.3", "pytest~=7.4", "tox~=4.11"]
+
 [project.urls]
 "Homepage" = "https://github.com/283375/arcaea-offline"
 "Bug Tracker" = "https://github.com/283375/arcaea-offline/issues"
 
-[tool.isort]
-profile = "black"
-src_paths = ["src/arcaea_offline"]
-
 [tool.pyright]
 ignore = ["build/"]
 
-[tool.pylint.main]
-jobs = 0
-
-[tool.pylint.logging]
-disable = [
-  "missing-module-docstring",
-  "missing-class-docstring",
-  "missing-function-docstring",
-  "not-callable", # false positive to sqlalchemy `func.*`, remove this when pylint-dev/pylint(#8138) closed
+[tool.ruff.lint]
+# Full list: https://docs.astral.sh/ruff/rules
+select = [
+  "E",   # pycodestyle (Error)
+  "W",   # pycodestyle (Warning)
+  "F",   # pyflakes
+  "I",   # isort
+  "PL",  # pylint
+  "N",   # pep8-naming
+  "FBT", # flake8-boolean-trap
+  "A",   # flake8-builtins
+  "DTZ", # flake8-datetimez
+  "LOG", # flake8-logging
+  "Q",   # flake8-quotes
+  "G",   # flake8-logging-format
+  "PIE", # flake8-pie
+  "PT",  # flake8-pytest-style
+]
+ignore = [
+  "E501", # line-too-long
 ]

requirements.dev.txt

@@ -1,4 +1,4 @@
-black==23.3.0
-isort==5.12.0
-pre-commit==3.3.1
-pylint==3.0.2
+ruff~=0.4
+pre-commit~=3.3
+pytest~=7.4
+tox~=4.11

src/arcaea_offline/database.py

@@ -6,7 +6,7 @@ from sqlalchemy import Engine, func, inspect, select
 from sqlalchemy.orm import DeclarativeBase, InstrumentedAttribute, sessionmaker
 
 from .external.arcsong.arcsong_json import ArcSongJsonBuilder
-from .external.exports import ScoreExport, exporters
+from .external.exports import ArcaeaOfflineDEFV2_Score, ScoreExport, exporters
 from .models.config import ConfigBase, Property
 from .models.scores import (
     CalculatedPotential,
@@ -410,6 +410,15 @@ class Database(metaclass=Singleton):
         scores = self.get_scores()
         return [exporters.score(score) for score in scores]
 
+    def export_scores_def_v2(self) -> ArcaeaOfflineDEFV2_Score:
+        scores = self.get_scores()
+        return {
+            "$schema": "https://arcaeaoffline.sevive.xyz/schemas/def/v2/score.schema.json",
+            "type": "score",
+            "version": 2,
+            "scores": [exporters.score_def_v2(score) for score in scores],
+        }
+
     def generate_arcsong(self):
         with self.sessionmaker() as session:
             arcsong = ArcSongJsonBuilder(session).generate_arcsong_json()

src/arcaea_offline/external/chart_info_db/__init__.py

@@ -0,0 +1 @@
+from .parser import ChartInfoDbParser

src/arcaea_offline/external/chart_info_db/parser.py

@@ -0,0 +1,35 @@
+import contextlib
+import sqlite3
+from typing import List
+
+from sqlalchemy.orm import Session
+
+from ...models.songs import ChartInfo
+
+
+class ChartInfoDbParser:
+    def __init__(self, filepath):
+        self.filepath = filepath
+
+    def parse(self) -> List[ChartInfo]:
+        results = []
+        with sqlite3.connect(self.filepath) as conn:
+            with contextlib.closing(conn.cursor()) as cursor:
+                db_results = cursor.execute(
+                    "SELECT song_id, rating_class, constant, notes FROM charts_info"
+                ).fetchall()
+                for result in db_results:
+                    chart = ChartInfo(
+                        song_id=result[0],
+                        rating_class=result[1],
+                        constant=result[2],
+                        notes=result[3] or None,
+                    )
+                    results.append(chart)
+
+        return results
+
+    def write_database(self, session: Session):
+        results = self.parse()
+        for result in results:
+            session.merge(result)

src/arcaea_offline/external/exports/__init__.py

@@ -1,2 +1,2 @@
 from . import exporters
-from .types import ScoreExport
+from .types import ArcaeaOfflineDEFV2_Score, ScoreExport

src/arcaea_offline/external/exports/exporters.py

@@ -1,5 +1,5 @@
 from ...models import Score
-from .types import ScoreExport
+from .types import ArcaeaOfflineDEFV2_ScoreItem, ScoreExport
 
 
 def score(score: Score) -> ScoreExport:
@@ -17,3 +17,21 @@ def score(score: Score) -> ScoreExport:
         "clear_type": score.clear_type,
         "comment": score.comment,
     }
+
+
+def score_def_v2(score: Score) -> ArcaeaOfflineDEFV2_ScoreItem:
+    return {
+        "id": score.id,
+        "songId": score.song_id,
+        "ratingClass": score.rating_class,
+        "score": score.score,
+        "pure": score.pure,
+        "far": score.far,
+        "lost": score.lost,
+        "date": score.date,
+        "maxRecall": score.max_recall,
+        "modifier": score.modifier,
+        "clearType": score.clear_type,
+        "source": None,
+        "comment": score.comment,
+    }

src/arcaea_offline/external/exports/types.py

@@ -1,4 +1,4 @@
-from typing import Optional, TypedDict
+from typing import List, Literal, Optional, TypedDict
 
 
 class ScoreExport(TypedDict):
@@ -14,3 +14,32 @@ class ScoreExport(TypedDict):
     modifier: Optional[int]
     clear_type: Optional[int]
     comment: Optional[str]
+
+
+class ArcaeaOfflineDEFV2_ScoreItem(TypedDict, total=False):
+    id: Optional[int]
+    songId: str
+    ratingClass: int
+    score: int
+    pure: Optional[int]
+    far: Optional[int]
+    lost: Optional[int]
+    date: Optional[int]
+    maxRecall: Optional[int]
+    modifier: Optional[int]
+    clearType: Optional[int]
+    source: Optional[str]
+    comment: Optional[str]
+
+
+ArcaeaOfflineDEFV2_Score = TypedDict(
+    "ArcaeaOfflineDEFV2_Score",
+    {
+        "$schema": Literal[
+            "https://arcaeaoffline.sevive.xyz/schemas/def/v2/score.schema.json"
+        ],
+        "type": Literal["score"],
+        "version": Literal[2],
+        "scores": List[ArcaeaOfflineDEFV2_ScoreItem],
+    },
+)

src/arcaea_offline/utils/rating.py

@@ -5,6 +5,7 @@ RATING_CLASS_TEXT_MAP = {
     1: "Present",
     2: "Future",
     3: "Beyond",
+    4: "Eternal",
 }
 
 RATING_CLASS_SHORT_TEXT_MAP = {
@@ -12,6 +13,7 @@ RATING_CLASS_SHORT_TEXT_MAP = {
     1: "PRS",
     2: "FTR",
     3: "BYD",
+    4: "ETR",
 }
 
 

tests/calculate/test_world_step.py

@@ -0,0 +1,22 @@
+from decimal import Decimal
+
+from arcaea_offline.calculate.world_step import (
+    AwakenedAyuPartnerBonus,
+    LegacyMapStepBooster,
+    PlayResult,
+    calculate_step_original,
+)
+
+
+def test_world_step():
+    # the result was copied from https://arcaea.fandom.com/wiki/World_Mode_Mechanics#Calculation
+    # CC BY-SA 3.0
+
+    booster = LegacyMapStepBooster(6, 250)
+    partner_bonus = AwakenedAyuPartnerBonus("+3.6")
+    play_result = PlayResult(play_rating=Decimal("11.299"), partner_step=92)
+    result = calculate_step_original(
+        play_result, partner_bonus=partner_bonus, step_booster=booster
+    )
+
+    assert result.quantize(Decimal("0.000")) == Decimal("175.149")

tests/db/db.py

@@ -0,0 +1,5 @@
+from sqlalchemy import Engine, create_engine, inspect
+
+
+def create_engine_in_memory():
+    return create_engine("sqlite:///:memory:")

tests/db/models/test_songs.py

@@ -0,0 +1,118 @@
+from sqlalchemy import Engine
+from sqlalchemy.orm import Session
+
+from arcaea_offline.models.songs import (
+    Chart,
+    ChartInfo,
+    Difficulty,
+    Pack,
+    Song,
+    SongsBase,
+    SongsViewBase,
+)
+
+from ..db import create_engine_in_memory
+
+
+def _song(**kw):
+    defaults = {"artist": "test"}
+    defaults.update(kw)
+    return Song(**defaults)
+
+
+def _difficulty(**kw):
+    defaults = {"rating_plus": False, "audio_override": False, "jacket_override": False}
+    defaults.update(kw)
+    return Difficulty(**defaults)
+
+
+class Test_Chart:
+    def init_db(self, engine: Engine):
+        SongsBase.metadata.create_all(engine)
+        SongsViewBase.metadata.create_all(engine)
+
+    def db(self):
+        db = create_engine_in_memory()
+        self.init_db(db)
+        return db
+
+    def test_chart_info(self):
+        pre_entites = [
+            Pack(id="test", name="Test Pack"),
+            _song(idx=0, id="song0", set="test", title="Full Chart Info"),
+            _song(idx=1, id="song1", set="test", title="Partial Chart Info"),
+            _song(idx=2, id="song2", set="test", title="No Chart Info"),
+            _difficulty(song_id="song0", rating_class=2, rating=9),
+            _difficulty(song_id="song1", rating_class=2, rating=9),
+            _difficulty(song_id="song2", rating_class=2, rating=9),
+            ChartInfo(song_id="song0", rating_class=2, constant=90, notes=1234),
+            ChartInfo(song_id="song1", rating_class=2, constant=90),
+        ]
+
+        db = self.db()
+        with Session(db) as session:
+            session.add_all(pre_entites)
+            session.commit()
+
+            chart_song0_ratingclass2 = (
+                session.query(Chart)
+                .where((Chart.song_id == "song0") & (Chart.rating_class == 2))
+                .one()
+            )
+
+            assert chart_song0_ratingclass2.constant == 90
+            assert chart_song0_ratingclass2.notes == 1234
+
+            chart_song1_ratingclass2 = (
+                session.query(Chart)
+                .where((Chart.song_id == "song1") & (Chart.rating_class == 2))
+                .one()
+            )
+
+            assert chart_song1_ratingclass2.constant == 90
+            assert chart_song1_ratingclass2.notes is None
+
+            chart_song2_ratingclass2 = (
+                session.query(Chart)
+                .where((Chart.song_id == "song2") & (Chart.rating_class == 2))
+                .first()
+            )
+
+            assert chart_song2_ratingclass2 is None
+
+    def test_difficulty_title_override(self):
+        pre_entites = [
+            Pack(id="test", name="Test Pack"),
+            _song(idx=0, id="test", set="test", title="Test"),
+            _difficulty(song_id="test", rating_class=0, rating=2),
+            _difficulty(song_id="test", rating_class=1, rating=5),
+            _difficulty(song_id="test", rating_class=2, rating=8),
+            _difficulty(
+                song_id="test", rating_class=3, rating=10, title="TEST ~REVIVE~"
+            ),
+            ChartInfo(song_id="test", rating_class=0, constant=10),
+            ChartInfo(song_id="test", rating_class=1, constant=10),
+            ChartInfo(song_id="test", rating_class=2, constant=10),
+            ChartInfo(song_id="test", rating_class=3, constant=10),
+        ]
+
+        db = self.db()
+        with Session(db) as session:
+            session.add_all(pre_entites)
+            session.commit()
+
+            charts_original_title = (
+                session.query(Chart)
+                .where((Chart.song_id == "test") & (Chart.rating_class in [0, 1, 2]))
+                .all()
+            )
+
+            assert all(chart.title == "Test" for chart in charts_original_title)
+
+            chart_overrided_title = (
+                session.query(Chart)
+                .where((Chart.song_id == "test") & (Chart.rating_class == 3))
+                .one()
+            )
+
+            assert chart_overrided_title.title == "TEST ~REVIVE~"

tox.ini

@@ -0,0 +1,16 @@
+[tox]
+env_list =
+    py311
+    py310
+    py39
+    py38
+minversion = 4.11.3
+
+[testenv]
+description = run the tests with pytest
+package = wheel
+wheel_build_env = .pkg
+deps =
+    pytest==7.4.3
+commands =
+    pytest {tty:--color=yes} {posargs}