Merge pull request #689 from sdispater/refactor/codspeed

Add benchmarks to track performances

Author: sdispater

.github/workflows/codspeed.yml

@@ -0,0 +1,48 @@
+name: codspeed
+
+on:
+  push:
+    branches:
+      - "main" # or "master"
+  pull_request:
+  # `workflow_dispatch` allows CodSpeed to trigger backtest
+  # performance analysis in order to generate initial data.
+  workflow_dispatch:
+
+jobs:
+  benchmarks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "3.9"
+
+      - name: Get full Python version
+        id: full-python-version
+        run: |
+          echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")
+
+      - name: Install poetry
+        run: |
+          curl -fsS https://install.python-poetry.org | python - --preview -y
+
+      - name: Update PATH
+        if: ${{ matrix.os != 'Windows' }}
+        run: echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Update Path for Windows
+        if: ${{ matrix.os == 'Windows' }}
+        run: echo "$APPDATA\Python\Scripts" >> $GITHUB_PATH
+
+      - name: Configure poetry
+        run: poetry config virtualenvs.create false
+
+      - name: Install dependencies
+        run: poetry install --only main --only test --only benchmark -vvv
+
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@v1
+        with:
+          token: ${{ secrets.CODSPEED_TOKEN }}
+          run: pytest tests/ --codspeed

.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
       - id: black
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.10.1
+    rev: 5.12.0
     hooks:
       - id: isort
         args: [ --add-import, from __future__ import annotations, --lines-after-imports, "-1" ]

pendulum/parsing/__init__.py

@@ -231,3 +231,6 @@ def _parse_iso8601_interval(text: str) -> _Interval:
     return _Interval(
         cast(datetime, start), cast(datetime, end), cast(Duration, duration)
     )
+
+
+__all__ = ["parse", "parse_iso8601"]

poetry.lock

@@ -35,9 +35,9 @@ importlib-resources = { version = "^5.9.0", python = ">=3.7,<3.9" }
 
 [tool.poetry.group.test.dependencies]
 pytest = "^7.1.2"
-pytest-cov = "^3.0.0"
 pytz = ">=2022.1"
 time-machine = "^2.7.1"
+pytest-benchmark = "^4.0.0"
 
 [tool.poetry.group.doc.dependencies]
 mkdocs = "^1.0"
@@ -64,6 +64,9 @@ optional = true
 meson = "^0.63.2"
 ninja = "^1.10.2.3"
 
+[tool.poetry.group.benchmark.dependencies]
+pytest-codspeed = "^1.2.2"
+
 [tool.poetry.build]
 generate-setup-file = false
 script = "build.py"

pyproject.toml

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pytest_benchmark.fixture import BenchmarkFixture
+
+import pendulum
+
+from pendulum.formatting.formatter import Formatter
+
+
+def test_format(benchmark: BenchmarkFixture) -> None:
+    f = Formatter()
+    d = pendulum.datetime(2016, 8, 28, 7, 3, 6, 123456)
+
+    @benchmark  # type: ignore[misc]
+    def benchmark_() -> None:
+        f.format(d, "S")
+        f.format(d, "SS")
+        f.format(d, "SSS")
+        f.format(d, "SSSS")
+        f.format(d, "SSSSS")
+        f.format(d, "SSSSSS")
+
+        f.format(d, "zz")
+        f.format(d, "z")
+        f.format(d, "ZZ")
+        f.format(d, "Z")
+
+        f.format(d, "LT")
+        f.format(d, "LTS")
+        f.format(d, "L")
+        f.format(d, "LL")
+        f.format(d, "LLL")
+        f.format(d, "LLLL")

tests/benchmarks/__init__.py

@@ -0,0 +1,51 @@
+from __future__ import annotations
+
+import pytest
+
+from pendulum.parsing.iso8601 import parse_iso8601
+
+
+@pytest.mark.benchmark(group="Parsing")
+def test_parse_iso8601() -> None:
+    # Date
+    parse_iso8601("2016")
+    parse_iso8601("2016-10")
+    parse_iso8601("2016-10-06")
+    parse_iso8601("20161006")
+
+    # Time
+    parse_iso8601("201610")
+
+    # Datetime
+    parse_iso8601("2016-10-06T12:34:56.123456")
+    parse_iso8601("2016-10-06T12:34:56.123")
+    parse_iso8601("2016-10-06T12:34:56.000123")
+    parse_iso8601("2016-10-06T12")
+    parse_iso8601("2016-10-06T123456")
+    parse_iso8601("2016-10-06T123456.123456")
+    parse_iso8601("20161006T123456.123456")
+    parse_iso8601("20161006 123456.123456")
+
+    # Datetime with offset
+    parse_iso8601("2016-10-06T12:34:56.123456+05:30")
+    parse_iso8601("2016-10-06T12:34:56.123456+0530")
+    parse_iso8601("2016-10-06T12:34:56.123456-05:30")
+    parse_iso8601("2016-10-06T12:34:56.123456-0530")
+    parse_iso8601("2016-10-06T12:34:56.123456+05")
+    parse_iso8601("2016-10-06T12:34:56.123456-05")
+    parse_iso8601("20161006T123456,123456-05")
+    parse_iso8601("2016-10-06T12:34:56.123456789+05:30")
+
+    # Ordinal date
+    parse_iso8601("2012-007")
+    parse_iso8601("2012007")
+    parse_iso8601("2017-079")
+
+    # Week date
+    parse_iso8601("2012-W05")
+    parse_iso8601("2008-W39-6")
+    parse_iso8601("2009-W53-7")
+    parse_iso8601("2009-W01-1")
+
+    # Week date wth time
+    parse_iso8601("2008-W39-6T09")