Skip to content

Commit c4ae30d

Browse files
rmp2000rmp2000
committed
Update the doctest of primelib.py
1 parent 5be5d21 commit c4ae30d

File tree

1 file changed

+247
-4
lines changed

1 file changed

+247
-4
lines changed

‎maths/primelib.py

+247-4
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,19 @@ def is_prime(number: int) -> bool:
4646
"""
4747
input: positive integer 'number'
4848
returns true if 'number' is prime otherwise false.
49+
50+
>>> is_prime(3)
51+
True
52+
>>> is_prime(10)
53+
False
54+
>>> is_prime(-1)
55+
Traceback (most recent call last):
56+
...
57+
AssertionError: 'number' must been an int and positive
58+
>>> is_prime("test")
59+
Traceback (most recent call last):
60+
...
61+
AssertionError: 'number' must been an int and positive
4962
"""
5063

5164
# precondition
@@ -83,6 +96,18 @@ def sieve_er(n):
8396
This function implements the algorithm called
8497
sieve of erathostenes.
8598
99+
>>> sieve_er(8)
100+
[2, 3, 5, 7]
101+
>>> sieve_er(2)
102+
[2]
103+
>>> sieve_er(-1)
104+
Traceback (most recent call last):
105+
...
106+
AssertionError: 'N' must been an int and > 2
107+
>>> sieve_er("test")
108+
Traceback (most recent call last):
109+
...
110+
AssertionError: 'N' must been an int and > 2
86111
"""
87112

88113
# precondition
@@ -116,6 +141,19 @@ def get_prime_numbers(n):
116141
input: positive integer 'N' > 2
117142
returns a list of prime numbers from 2 up to N (inclusive)
118143
This function is more efficient as function 'sieveEr(...)'
144+
145+
>>> get_prime_numbers(8)
146+
[2, 3, 5, 7]
147+
>>> get_prime_numbers(2)
148+
[2]
149+
>>> get_prime_numbers(-1)
150+
Traceback (most recent call last):
151+
...
152+
AssertionError: 'n' must been an int and > 2
153+
>>> get_prime_numbers("test")
154+
Traceback (most recent call last):
155+
...
156+
AssertionError: 'n' must been an int and > 2
119157
"""
120158

121159
# precondition
@@ -142,6 +180,21 @@ def prime_factorization(number):
142180
"""
143181
input: positive integer 'number'
144182
returns a list of the prime number factors of 'number'
183+
184+
>>> prime_factorization(0)
185+
[0]
186+
>>> prime_factorization(8)
187+
[2, 2, 2]
188+
>>> prime_factorization(287)
189+
[7, 41]
190+
>>> prime_factorization(-1)
191+
Traceback (most recent call last):
192+
...
193+
AssertionError: 'number' must been an int and >= 0
194+
>>> prime_factorization("test")
195+
Traceback (most recent call last):
196+
...
197+
AssertionError: 'number' must been an int and >= 0
145198
"""
146199

147200
# precondition
@@ -183,12 +236,27 @@ def greatest_prime_factor(number):
183236
"""
184237
input: positive integer 'number' >= 0
185238
returns the greatest prime number factor of 'number'
239+
240+
>>> greatest_prime_factor(0)
241+
0
242+
>>> greatest_prime_factor(8)
243+
2
244+
>>> greatest_prime_factor(287)
245+
41
246+
>>> greatest_prime_factor(-1)
247+
Traceback (most recent call last):
248+
...
249+
AssertionError: 'number' must been an int and >= 0
250+
>>> greatest_prime_factor("test")
251+
Traceback (most recent call last):
252+
...
253+
AssertionError: 'number' must been an int and >= 0
186254
"""
187255

188256
# precondition
189257
assert isinstance(number, int) and (
190258
number >= 0
191-
), "'number' bust been an int and >= 0"
259+
), "'number' must been an int and >= 0"
192260

193261
ans = 0
194262

@@ -210,12 +278,27 @@ def smallest_prime_factor(number):
210278
"""
211279
input: integer 'number' >= 0
212280
returns the smallest prime number factor of 'number'
281+
282+
>>> smallest_prime_factor(0)
283+
0
284+
>>> smallest_prime_factor(8)
285+
2
286+
>>> smallest_prime_factor(287)
287+
7
288+
>>> smallest_prime_factor(-1)
289+
Traceback (most recent call last):
290+
...
291+
AssertionError: 'number' must been an int and >= 0
292+
>>> smallest_prime_factor("test")
293+
Traceback (most recent call last):
294+
...
295+
AssertionError: 'number' must been an int and >= 0
213296
"""
214297

215298
# precondition
216299
assert isinstance(number, int) and (
217300
number >= 0
218-
), "'number' bust been an int and >= 0"
301+
), "'number' must been an int and >= 0"
219302

220303
ans = 0
221304

@@ -237,11 +320,24 @@ def is_even(number):
237320
"""
238321
input: integer 'number'
239322
returns true if 'number' is even, otherwise false.
323+
324+
>>> is_even(0)
325+
True
326+
>>> is_even(8)
327+
True
328+
>>> is_even(287)
329+
False
330+
>>> is_even(-1)
331+
False
332+
>>> is_even("test")
333+
Traceback (most recent call last):
334+
...
335+
AssertionError: 'number' must been an int
240336
"""
241337

242338
# precondition
243339
assert isinstance(number, int), "'number' must been an int"
244-
assert isinstance(number % 2 == 0, bool), "compare bust been from type bool"
340+
assert isinstance(number % 2 == 0, bool), "compare must been from type bool"
245341

246342
return number % 2 == 0
247343

@@ -253,11 +349,24 @@ def is_odd(number):
253349
"""
254350
input: integer 'number'
255351
returns true if 'number' is odd, otherwise false.
352+
353+
>>> is_odd(0)
354+
False
355+
>>> is_odd(8)
356+
False
357+
>>> is_odd(287)
358+
True
359+
>>> is_odd(-1)
360+
True
361+
>>> is_odd("test")
362+
Traceback (most recent call last):
363+
...
364+
AssertionError: 'number' must been an int
256365
"""
257366

258367
# precondition
259368
assert isinstance(number, int), "'number' must been an int"
260-
assert isinstance(number % 2 != 0, bool), "compare bust been from type bool"
369+
assert isinstance(number % 2 != 0, bool), "compare must been from type bool"
261370

262371
return number % 2 != 0
263372

@@ -270,6 +379,22 @@ def goldbach(number):
270379
Goldbach's assumption
271380
input: a even positive integer 'number' > 2
272381
returns a list of two prime numbers whose sum is equal to 'number'
382+
>>> goldbach(8)
383+
[3, 5]
384+
>>> goldbach(824)
385+
[3, 821]
386+
>>> goldbach(0)
387+
Traceback (most recent call last):
388+
...
389+
AssertionError: 'number' must been an int, even and > 2
390+
>>> goldbach(-1)
391+
Traceback (most recent call last):
392+
...
393+
AssertionError: 'number' must been an int, even and > 2
394+
>>> goldbach("test")
395+
Traceback (most recent call last):
396+
...
397+
AssertionError: 'number' must been an int, even and > 2
273398
"""
274399

275400
# precondition
@@ -323,6 +448,22 @@ def kg_v(number1, number2):
323448
Least common multiple
324449
input: two positive integer 'number1' and 'number2'
325450
returns the least common multiple of 'number1' and 'number2'
451+
>>> kg_v(8,10)
452+
40
453+
>>> kg_v(824,67)
454+
55208
455+
>>> kg_v(0)
456+
Traceback (most recent call last):
457+
...
458+
TypeError: kg_v() missing 1 required positional argument: 'number2'
459+
>>> kg_v(10,-1)
460+
Traceback (most recent call last):
461+
...
462+
AssertionError: 'number1' and 'number2' must been positive integer.
463+
>>> kg_v("test","test2")
464+
Traceback (most recent call last):
465+
...
466+
AssertionError: 'number1' and 'number2' must been positive integer.
326467
"""
327468

328469
# precondition
@@ -395,6 +536,21 @@ def get_prime(n):
395536
Gets the n-th prime number.
396537
input: positive integer 'n' >= 0
397538
returns the n-th prime number, beginning at index 0
539+
540+
>>> get_prime(0)
541+
2
542+
>>> get_prime(8)
543+
23
544+
>>> get_prime(824)
545+
6337
546+
>>> get_prime(-1)
547+
Traceback (most recent call last):
548+
...
549+
AssertionError: 'number' must been a positive int
550+
>>> get_prime("test")
551+
Traceback (most recent call last):
552+
...
553+
AssertionError: 'number' must been a positive int
398554
"""
399555

400556
# precondition
@@ -430,6 +586,25 @@ def get_primes_between(p_number_1, p_number_2):
430586
pNumber1 < pNumber2
431587
returns a list of all prime numbers between 'pNumber1' (exclusive)
432588
and 'pNumber2' (exclusive)
589+
590+
>>> get_primes_between(3,67)
591+
[5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61]
592+
>>> get_primes_between(0)
593+
Traceback (most recent call last):
594+
...
595+
TypeError: get_primes_between() missing 1 required positional argument: 'p_number_2'
596+
>>> get_primes_between(0,1)
597+
Traceback (most recent call last):
598+
...
599+
AssertionError: The arguments must been prime numbers and 'pNumber1' < 'pNumber2'
600+
>>> get_primes_between(-1,3)
601+
Traceback (most recent call last):
602+
...
603+
AssertionError: 'number' must been an int and positive
604+
>>> get_primes_between("test","test")
605+
Traceback (most recent call last):
606+
...
607+
AssertionError: 'number' must been an int and positive
433608
"""
434609

435610
# precondition
@@ -473,6 +648,19 @@ def get_divisors(n):
473648
"""
474649
input: positive integer 'n' >= 1
475650
returns all divisors of n (inclusive 1 and 'n')
651+
652+
>>> get_divisors(8)
653+
[1, 2, 4, 8]
654+
>>> get_divisors(824)
655+
[1, 2, 4, 8, 103, 206, 412, 824]
656+
>>> get_divisors(-1)
657+
Traceback (most recent call last):
658+
...
659+
AssertionError: 'n' must been int and >= 1
660+
>>> get_divisors("test")
661+
Traceback (most recent call last):
662+
...
663+
AssertionError: 'n' must been int and >= 1
476664
"""
477665

478666
# precondition
@@ -497,6 +685,19 @@ def is_perfect_number(number):
497685
"""
498686
input: positive integer 'number' > 1
499687
returns true if 'number' is a perfect number otherwise false.
688+
689+
>>> is_perfect_number(28)
690+
True
691+
>>> is_perfect_number(824)
692+
False
693+
>>> is_perfect_number(-1)
694+
Traceback (most recent call last):
695+
...
696+
AssertionError: 'number' must been an int and >= 1
697+
>>> is_perfect_number("test")
698+
Traceback (most recent call last):
699+
...
700+
AssertionError: 'number' must been an int and >= 1
500701
"""
501702

502703
# precondition
@@ -525,6 +726,17 @@ def simplify_fraction(numerator, denominator):
525726
input: two integer 'numerator' and 'denominator'
526727
assumes: 'denominator' != 0
527728
returns: a tuple with simplify numerator and denominator.
729+
730+
>>> simplify_fraction(10,20)
731+
(1,2)
732+
>>> simplify_fraction(10,-1)
733+
Traceback (most recent call last):
734+
...
735+
AssertionError: The arguments must been from type int and 'denominator' != 0"
736+
>>> simplify_fraction("test","test")
737+
Traceback (most recent call last):
738+
...
739+
AssertionError: The arguments must been from type int and 'denominator' != 0"
528740
"""
529741

530742
# precondition
@@ -554,6 +766,19 @@ def factorial(n):
554766
"""
555767
input: positive integer 'n'
556768
returns the factorial of 'n' (n!)
769+
770+
>>> factorial(0)
771+
1
772+
>>> factorial(20)
773+
2432902008176640000
774+
>>> factorial(-1)
775+
Traceback (most recent call last):
776+
...
777+
AssertionError: 'n' must been a int and >= 0
778+
>>> factorial("test")
779+
Traceback (most recent call last):
780+
...
781+
AssertionError: 'n' must been a int and >= 0
557782
"""
558783

559784
# precondition
@@ -574,6 +799,19 @@ def fib(n):
574799
"""
575800
input: positive integer 'n'
576801
returns the n-th fibonacci term , indexing by 0
802+
803+
>>> fib(0)
804+
1
805+
>>> fib(20)
806+
10946
807+
>>> fib(-1)
808+
Traceback (most recent call last):
809+
...
810+
AssertionError: 'n' must been an int and >= 0
811+
>>> fib("test")
812+
Traceback (most recent call last):
813+
...
814+
AssertionError: 'n' must been an int and >= 0
577815
"""
578816

579817
# precondition
@@ -589,3 +827,8 @@ def fib(n):
589827
fib1 = tmp
590828

591829
return ans
830+
831+
if __name__ == "__main__":
832+
import doctest
833+
834+
doctest.testmod()

0 commit comments

Comments
 (0)