From 33e83fd69466c5887b151e3bc1b7d0b3470f7776 Mon Sep 17 00:00:00 2001 From: andrew Date: Sat, 18 Nov 2023 19:42:33 +0000 Subject: [PATCH 1/9] [18/11/23] README grammar --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c56982d..54f7d89 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ # Fast, simple and accurate Python timing. Written in Rust. ## Installation -Install with [pip](https://pypi.org/project/pip): +Install with [pip](https://pypi.org/project/pip). ```bash $ python -m pip install tictoc ``` From ed995856f917b01576f0a638b386ab9e604c7387 Mon Sep 17 00:00:00 2001 From: andrew Date: Sat, 18 Nov 2023 21:20:45 +0000 Subject: [PATCH 2/9] [18/11/23] Initial Python tests commit --- tests/pytest.ini | 4 +++ tests/test.py | 86 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+) create mode 100644 tests/pytest.ini create mode 100644 tests/test.py diff --git a/tests/pytest.ini b/tests/pytest.ini new file mode 100644 index 0000000..2779ef8 --- /dev/null +++ b/tests/pytest.ini @@ -0,0 +1,4 @@ +[pytest] +python_files = test*.py +python_classes = test +python_functions = test* diff --git a/tests/test.py b/tests/test.py new file mode 100644 index 0000000..b019fd2 --- /dev/null +++ b/tests/test.py @@ -0,0 +1,86 @@ +import pytest +import tictoc +import time +import math + + +@pytest.fixture +def t(): + t = tictoc.init() + return t + + +class testFunctionality: + def testBasic(self, t): + t.tic() + print("test") + t.toc() + assert t.results.seconds > 0 + + def testOverwrite(self, t): + t.tic() + print("test") + t.toc() + firstResult = t.results.seconds + print("test2") + t.toc() + secondResult = t.results.seconds + + assert firstResult < secondResult + + +class testInvalid: + def testNoInit(self): + with pytest.raises(Exception): + t.tic() + + def testTocBeforeTic(self, t): + with pytest.raises(Exception): + t.toc() + + +@pytest.mark.parametrize("sleepTime", [0.05, 0.5, 1]) +class testAccuracy: + @pytest.fixture(scope="class") + def tol(self): + return 0.0006 + + def testSingleCall(self, t, sleepTime, tol): + t.tic() + time.sleep(sleepTime) + t.toc() + assert (t.results.seconds > sleepTime) & ( + t.results.seconds < (t.results.seconds + tol) + ) + + def testMultipleCalls(self, t, sleepTime, tol): + t.tic() + time.sleep(sleepTime) + t.toc() + time.sleep(sleepTime) + t.toc() + assert (t.results.seconds > sleepTime * 2) & ( + t.results.seconds < (t.results.seconds + tol) + ) + + +class testConsistency: + def testMicros(self, t): + t.tic() + print("test") + t.toc() + assert t.results.micros == (math.floor(t.results.nanos * pow(10, -3))) + + def testMillis(self, t): + t.tic() + print("test") + t.toc() + assert t.results.millis == (math.floor(t.results.nanos * pow(10, -6))) + + def testSeconds(self, t): + t.tic() + print("test") + t.toc() + assert t.results.seconds == round( + (t.results.nanos * pow(10, -9)), 9 + ) # f64 vs u128, hence the round From fa055714b674a23359bb947c14aa429d346596bb Mon Sep 17 00:00:00 2001 From: andrew Date: Sun, 19 Nov 2023 21:20:09 +0000 Subject: [PATCH 3/9] [19/11/23] Adding tests and exception for bad syntax --- requirements.txt | 5 +++++ src/lib.rs | 51 +++++++++++++++++++++++++++++++++++++++--------- 2 files changed, 47 insertions(+), 9 deletions(-) diff --git a/requirements.txt b/requirements.txt index 2b076d0..db9c234 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,11 @@ certifi==2023.7.22 charset-normalizer==3.3.2 +coverage==7.3.2 idna==3.4 +iniconfig==2.0.0 maturin==1.3.1 +packaging==23.2 +pluggy==1.3.0 +pytest==7.4.3 requests==2.31.0 urllib3==2.0.7 diff --git a/src/lib.rs b/src/lib.rs index d3cf904..4974904 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,6 @@ use pyo3::prelude::*; use std::time::Instant; +use pyo3::exceptions::PyException; #[pyclass] #[derive(Clone)] @@ -19,6 +20,7 @@ struct Init { time: Instant, #[pyo3(get)] results: Results, + status: bool, } #[pymethods] @@ -34,21 +36,28 @@ impl Init { Init { time: Instant::now(), results: res, + status: false, } } fn tic(&mut self) { - self.time = Instant::now() + self.time = Instant::now(); + self.status = true; } - fn toc(&mut self) { - let elapsed_time = self.time.elapsed(); - self.results = Results { - nanos: elapsed_time.as_nanos(), - micros: elapsed_time.as_micros(), - millis: elapsed_time.as_millis(), - seconds: elapsed_time.as_secs_f64(), - }; + fn toc(&mut self) -> PyResult<()> { + if self.status == false { + Err(PyException::new_err("tic() must be called before toc()")) + } else { + let elapsed_time = self.time.elapsed(); + self.results = Results { + nanos: elapsed_time.as_nanos(), + micros: elapsed_time.as_micros(), + millis: elapsed_time.as_millis(), + seconds: elapsed_time.as_secs_f64(), + }; + Ok(()) + } } } @@ -57,3 +66,27 @@ fn tictoc(_py: Python<'_>, m: &PyModule) -> PyResult<()> { m.add_class::()?; Ok(()) } + +#[test] +fn test_new() { + let init = Init::new(); + assert_eq!(init.results.nanos,0); +} + +#[test] +fn test_tic() { + let mut init = Init::new(); + let time1 = init.time; + init.tic(); + let time2 = init.time; + assert!(time2 > time1) +} + +#[test] +fn test_toc() { + let mut init = Init::new(); + init.tic(); + println!("{}","test"); + let _ = init.toc(); + assert!(init.results.nanos > 0) +} From 463612d71d6b1f6a93a1323caed1f4704ae79842 Mon Sep 17 00:00:00 2001 From: andrew Date: Mon, 20 Nov 2023 10:42:23 +0000 Subject: [PATCH 4/9] [20/11/23] GitHub Actions testing workflow --- .github/workflows/tests.yml | 49 +++++++++++++++++++++++++++++++++++++ .gitignore | 2 +- 2 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/tests.yml diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..c91f613 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,49 @@ +name: tests + +on: + push: + branches: [ "dev" ] + +permissions: + contents: read + +env: + CARGO_TERM_COLOR: always + +jobs: + python: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Set up Python 3.11.2 + uses: actions/setup-python@v3 + with: + python-version: "3.11.2" + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install flake8 pytest + if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + pip install . + - name: Lint with flake8 + run: | + # stop the build if there are Python syntax errors or undefined names + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - name: Test with pytest + run: | + pytest -v tests + + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Build + run: cargo build --verbose + - name: Run tests + run: cargo test --verbose diff --git a/.gitignore b/.gitignore index 9845fe0..7e88271 100644 --- a/.gitignore +++ b/.gitignore @@ -72,7 +72,7 @@ docs/_build/ .python-version # GitHub Actions -.github/ +#.github/ # pyenv .env/ From 0dc7f9d958a8f3c03b3b36d05a3272d53a31886e Mon Sep 17 00:00:00 2001 From: andrew Date: Mon, 20 Nov 2023 10:44:55 +0000 Subject: [PATCH 5/9] [20/11/23] Changing job name --- .github/workflows/tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index c91f613..92fa8ad 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -37,7 +37,7 @@ jobs: run: | pytest -v tests - build: + rust: runs-on: ubuntu-latest From ccc45638374f2d26be9ab17ed0d2e5be08327d9e Mon Sep 17 00:00:00 2001 From: Andrew Conlin Date: Mon, 20 Nov 2023 10:48:07 +0000 Subject: [PATCH 6/9] [20/11/23] Adding tests badge to README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 54f7d89..5f06673 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ # Fast, simple and accurate Python timing. Written in Rust. +![badge](https://github.com/andrwcnln/nfl/actions/workflows/tests.yml/badge.svg) + ## Installation Install with [pip](https://pypi.org/project/pip). ```bash From 8d9ab1a4bd12c6a23d7a1c04edeb8fb3e96419b4 Mon Sep 17 00:00:00 2001 From: Andrew Conlin Date: Mon, 20 Nov 2023 10:48:50 +0000 Subject: [PATCH 7/9] [20/11/23] Fixing typo in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5f06673..2c7e70e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # Fast, simple and accurate Python timing. Written in Rust. -![badge](https://github.com/andrwcnln/nfl/actions/workflows/tests.yml/badge.svg) +![badge](https://github.com/andrwcnln/tictoc-py/actions/workflows/tests.yml/badge.svg) ## Installation Install with [pip](https://pypi.org/project/pip). From 6b2d7c9fc092d9a4f27192617cf73a4537c69c5f Mon Sep 17 00:00:00 2001 From: andrew Date: Mon, 20 Nov 2023 10:56:27 +0000 Subject: [PATCH 8/9] [20/11/23] Splitting workflow files by language --- .github/workflows/{tests.yml => python.yml} | 18 ++-------------- .github/workflows/rust.yml | 23 +++++++++++++++++++++ 2 files changed, 25 insertions(+), 16 deletions(-) rename .github/workflows/{tests.yml => python.yml} (79%) create mode 100644 .github/workflows/rust.yml diff --git a/.github/workflows/tests.yml b/.github/workflows/python.yml similarity index 79% rename from .github/workflows/tests.yml rename to .github/workflows/python.yml index 92fa8ad..2ee5ad0 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/python.yml @@ -1,4 +1,4 @@ -name: tests +name: Python on: push: @@ -7,11 +7,8 @@ on: permissions: contents: read -env: - CARGO_TERM_COLOR: always - jobs: - python: + build: runs-on: ubuntu-latest @@ -36,14 +33,3 @@ jobs: - name: Test with pytest run: | pytest -v tests - - rust: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v3 - - name: Build - run: cargo build --verbose - - name: Run tests - run: cargo test --verbose diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml new file mode 100644 index 0000000..83af3ea --- /dev/null +++ b/.github/workflows/rust.yml @@ -0,0 +1,23 @@ +name: Rust + +on: + push: + branches: [ "dev" ] + +permissions: + contents: read + +env: + CARGO_TERM_COLOR: always + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Build + run: cargo build --verbose + - name: Run tests + run: cargo test --verbose From 1c10a5303615fff4084674e5f6d9ebdc23f8877a Mon Sep 17 00:00:00 2001 From: Andrew Conlin Date: Mon, 20 Nov 2023 10:58:57 +0000 Subject: [PATCH 9/9] [20/11/23] Updating badges in README --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c7e70e..081e1ac 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ # Fast, simple and accurate Python timing. Written in Rust. -![badge](https://github.com/andrwcnln/tictoc-py/actions/workflows/tests.yml/badge.svg) +![badge](https://github.com/andrwcnln/tictoc-py/actions/workflows/python.yml/badge.svg) +![badge](https://github.com/andrwcnln/tictoc-py/actions/workflows/rust.yml/badge.svg) ## Installation Install with [pip](https://pypi.org/project/pip).