384
edits
Changes
→Rubric
** '-d 1' specifies a <i>max depth</i> of 1. Your list shouldn't include files, just a list of subdirectories in the target directory.
** Your list should <u>not</u> contain newline characters.
2. <code>percent_to_graph()</code> should take two arguments: percent and the total chars. It should return a 'bar graph' as a string.
** <b>max_length</b> refers to the total number of characters that the bar graph will be composed of. You can use equal signs <code>=</code> or any other character that makes sense, but the empty space <b>must be composed of spaces</b>, at least until you have passed the first milestone.
'===== '
<b>Please note that the '' characters should <u>not</u> be part of the output, they are here to indicate that this is a string!</b>
3. <code>create_dir_dict</code> should take a list as the argument, and should return a dictionary.
** The list can be the list returned by <code>call_du_sub()</code>.
** The dictionary that you return should have the full directory name as <i>key</i>, and the number of bytes in the directory as the <i>value</i>. This value should be an integer. For example, using the example of <b>/usr/local/lib</b>, the function would return:
{'/usr/local/lib/heroku': 164028, '/usr/local/lib/python2.7': 11072, ...}
4. <code>get_max</code> should take a dictionary and the target directory as arguments, and it should return the total size of the target directory as an integer.
** The dictionary returned by <code>create_dir_dict</code> will be used for this function. When calculating the percentage for each subdirectory, you will need the total size of the target directory as the denominator. This function will return that value.
== Additional Functions ==
You may create any other functions that you think appropriate, especially when if you begin decide to build additional functionality. Part of your evaluation will be on how "re-usable" your functions are, and sensible use of arguments and return values.
== Use of GitHub ==
To test with the check script, run the following:
<code>python3 checkA2checkA1.py -f -v TestPercent</code>
<code>python3 checkA2checkA1.py -f -v TestDuSub</code>
== Second Milestone (due October 21) ==
For the second milestone you will have two more functions to complete.
For example: <code>{'/usr/lib/local': 33400}</code>
* To run the check script, enter the following:
<code>python3 checkA2checkA1.py -f -v TestDirDict</code>
* -h will print a usage message. This will automatically be created by argparse itself, you will not need to implement this. However, refer carefully Use the following to the sample output and ensure that test your help message matches the required output.* -H will print file sizes in Human readable format. For example, 1024 bytes will be printed as 1K, 1024 kilobytes will be printed as 1M, and so on. * -l <number> will set the maximum length of the bar graph. The default should be 20 character. This option will require an option argument that is an integer.* Your script will also require one positional argument which contains the target directory for scanning.code:
== Minimum Viable Product ==
Once you have achieved the Milestones, you will have to do the following to get a minimum viable product:
* In your <code>if __name__ == '__main__'</code> block, you will have to call accept a command line argument from the parse_command_args function. Experiment with print statements so that you understand how each option and argument are storeduser This will become your target directory.
** If the user has entered more than one argument, or their argument isn't a valid directory, print an error message.
** If the user doesn't specify any target, use the current directory.
* Call <code>call_du_sub</code> with the target directory.
* Pass the return value from that function to <code>create_dir_dict</code>.* You may wish Pass the dictionary into <code>get_total</code> to create one or more functions to do get the total size of the target.* For each item in your dictionary (excluding the followingtarget):
** Use the total size of the target directory to calculate percentage.
** Once you've calculated percentage, call <code>percent_to_graph</code> with a max_size of your choice.
** For every subdirectory, print <i>at least</i> the percent, the bar graph, and the name of the subdirectory.
** The target directory <b>should not</b> have a bar graph.
* Finally, print the total size of the target directory.
== Additional Features ==
After completing the above, you are expected may choose to add some additional features. Some improvements you could make are:
* Format the output in a way that is easy to read.
* Convert bytes into a human readable format.
* Add colour to the output.
* Include files in the output.
* Accept more options from the user.
* Sort the output by percentage, or by filename.
== The Assignment (due November 4, 11:59pm) ==
| Program Authorship Declaration || 5 ||
|-
| required functions design First Milestone || 5 10 ||
|-
| required functions readability Second Milestone || 5 10 ||
|-
| main loop percent function design || 10 ||
|-
| main loop readability get total function design || 10 ||
|-
| output function other functions design || 5 ||
|-
| output function readability Error checking and exception handling || 5 10 ||
|-
| additional features implemented required functions readability/variable naming || 20 5 ||
|-
| docstrings and comments main loop design || 5 ||
|-
| First Milestone main loop readability || 10 5 ||
|-
| Second Milestone docstrings and comments || 10 15 ||
|-
| github.com repository: Commit messages and use || 10 ||
Please submit the following files by the due date:
* [ ] your python script, named as 'duim.py', in your repository, and also '''submitted to Blackboard''', by August 6 November 4 at 11:59pm.
