diff --git a/.github/workflows/flake8.yml b/.github/workflows/flake8.yml index fbc2b25..77086af 100644 --- a/.github/workflows/flake8.yml +++ b/.github/workflows/flake8.yml @@ -6,6 +6,7 @@ on: push: branches: - master + - my_test pull_request: branches: - master diff --git a/.github/workflows/pytest-unit-tests.yml b/.github/workflows/pytest-unit-tests.yml index d1f1fd4..1f4bd1c 100644 --- a/.github/workflows/pytest-unit-tests.yml +++ b/.github/workflows/pytest-unit-tests.yml @@ -6,6 +6,7 @@ on: push: branches: - master + - my_test pull_request: branches: - master diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8922009 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +simple_functions.egg-info/ +simple_functions/__pycache__/ +tests/__pycache__ +.eggs/ +.eggs// diff --git a/simple_functions/__init__.py b/simple_functions/__init__.py index 963db77..a62d99e 100644 --- a/simple_functions/__init__.py +++ b/simple_functions/__init__.py @@ -1,5 +1,6 @@ from .functions1 import * # noqa + from pkg_resources import get_distribution, DistributionNotFound try: __version__ = get_distribution(__name__).version diff --git a/simple_functions/constants.py b/simple_functions/constants.py new file mode 100644 index 0000000..b5c2b50 --- /dev/null +++ b/simple_functions/constants.py @@ -0,0 +1,15 @@ +from numpy import sqrt +from simple_functions.functions1 import factorial +from functools import cache + +__all__ = ['pi'] + + +def pi(terms=1): + return 1./(2.*sqrt(2.)/9801.*rsum(terms)) + + +@cache +def rsum(n): + t = factorial(4*n)*(1103+26390*n)/(factorial(n)**4*396**(4*n)) + return t + rsum(n-1) if n else t diff --git a/simple_functions/functions1.py b/simple_functions/functions1.py index 8c63a4d..29bfb7f 100644 --- a/simple_functions/functions1.py +++ b/simple_functions/functions1.py @@ -1,5 +1,6 @@ +from functools import cache -__all__ = ['my_sum'] +__all__ = ['my_sum', 'factorial'] def my_sum(iterable): @@ -7,3 +8,8 @@ def my_sum(iterable): for i in iterable: tot += i return tot + + +@cache +def factorial(n): + return n * factorial(n - 1) if n else 1 diff --git a/tests/test_constants.py b/tests/test_constants.py new file mode 100644 index 0000000..63943d0 --- /dev/null +++ b/tests/test_constants.py @@ -0,0 +1,12 @@ +import numpy as np + +from simple_functions.constants import pi + + +class TestPi(object): + '''Class to test our constants are computed correctly''' + + def test_pi(self): + '''Test computation of pi''' + my_pi = pi(2) + assert np.isclose(my_pi, np.pi, atol=1e-12) diff --git a/tests/test_simple_functions.py b/tests/test_simple_functions.py index 5a03b52..ac3e70c 100644 --- a/tests/test_simple_functions.py +++ b/tests/test_simple_functions.py @@ -1,6 +1,7 @@ import pytest from simple_functions import my_sum +from simple_functions import factorial class TestSimpleFunctions(object): @@ -14,3 +15,13 @@ def test_my_add(self, iterable, expected): '''Test our add function''' isum = my_sum(iterable) assert isum == expected + + @pytest.mark.parametrize('number, expected', [ + (5, 120), + (3, 6), + (1, 1) + ]) + def test_factorial(self, number, expected): + '''Test our factorial function''' + answer = factorial(number) + assert answer == expected