College

CUNY School of Professional Studies

Course-Name

Software Application Programming I

Course-Code

IS 210

In this assignment, we'll focus on the construction of basic functions. The functions we create will be intentionally simple to make it easier to isolate the task at hand.

The following tasks will either have you interacting with existing files in the assignment repository or creating new ones on the fly. Don't forget to add your interpreter directive, utf-8 encoding, and a short docstring with any new files that you create!

Functions have their own documentation standards which are covered in the Google Python Style Guide. Document the function found here appropriately.

1. Document the function in task_01.py according to the Google Python Style Guide.

>>> import task_01
>>> help(task_01.know_what_i_mean)

Calling a function is already something we've done a few times but let's practice it again just to make sure we've connected the dots.

1. Open hamlet.py to get a sense of what this function does.
2. Open task_02.py and call the hamlet.crazy_math() math function assigning it the following parameters in order:
   1. 4
   2. 100000
   3. 8
   4. 98
3. Assign the returned result to a new global variable named POSITIONAL

>>> import task_02
>>> print task_02.POSITIONAL
0.00374391674995

Positional parameters may suffice in many cases but most programmers prefer to use keyword arguments. Here you'll call a function with keyword arguments instead of positional parameters.

1. Open hamlet.py to get a sense of what this function does.
2. Open task_03.py and call the hamlet.crazy_math() math function assigning it the following parameters by keyword reference:
   1. bananas: 48
   2. monkeys: 84
   3. hours: 200000
3. Assign the returned result to a new global variable named KEYWORD

>>> import task_03
>>> print task_03.KEYWORD
0.00879168510437

In this task, you'll be defining a function with three parameters.

1. Create a new file names task_04.py
2. Define a new function named too_many_kittens that takes three arguments, in order:
   1. kittens, the number of kittens
   2. litterboxes, the (integer) number of available litterboxes
   3. catfood, a boolean representing whether or not any catfood exists

3. In the function return the value of the following comparison statement:

   not (litterboxes >= kittens and catfood)

   This statement ensures we have at least one litterbox for each kitten and that we have some catfood. It then uses inversion via not to answer whether or not we have too many kittens.

>>> too_many_kittens(12, 12, False)
True

>>> too_many_kittens(13, 12, True)
True

>>> too_many_kittens(12, 13, True)
False

Here we'll set a default value in our function definition.

1. Create a file named task_05.py
2. Create a new function named defaults with two parameters:
   1. my_optional which has a default value of True
   2. my_required which is a required param and has no default value

3. Return the following logical comparison:

   my_optional is my_required

>>> defaults(True)
True

>>> defaults(True, False)
False

>>> defaults(False, False)
True

Code must be functional and pass tests before it will be eligible for credit.

Lint tests check your code for syntactic or stylistic errors To execute lint tests against a specific file, simply open a terminal in the same directory as your code repository and type:

$ pylint filename.py

Where filename.py is the name of the file you wish to lint test.

Unit tests check that your code performs the tested objectives. Unit tests may be executed individually by opening a terminal in the same directory as your code repository and typing:

$ nosetests tests/name_of_test.py

Where name_of_test.py is the name of the testfile found in the tests directory of your source code.

All tests may be run simultaneously by executing the runtests.sh script from the root of your assignment repository. To execute all tests, open a terminal in the same directory as your code repository and type:

$ bash runtests.sh

Code should be submitted to GitHub by means of opening a pull request.

As-of Lesson 02, each student will have a branch named after his or her GitHub username. Pull requests should be made against the branch that matches your GitHub username. Pull requests made against other branches will be closed. This work flow mimics the steps you took to open a pull request against the pull branch in Week Two.

For a refresher on how to open a pull request, please see homework instructions in Lesson 01. It is recommended that you run PyLint locally after each file is edited in order to reduce the number of errors found in testing.

In order to receive full credit you must complete the assignment as-instructed and without any violations (reported in the build status). There will be automated tests for this assignment to provide early feedback on program code.

When you have completed this assignment, please post the link to your pull request in the body of the assignment on Blackboard in order to receive credit.