384
edits
Changes
→Second Milestone (due August 2)
An example of the finished code your script might produce is this:
<code><b>user@host ~ $ ./duim.py -H /usr/local/lib</b></code>
<pre>
61 % [============ ] 160.2 MiB M /usr/local/lib/heroku 4 % [= ] 10.8 MiB M /usr/local/lib/python2.7 34 % [======= ] 90.4 MiB M /usr/local/lib/node_modules 0 % [ ] 8.0 kiB K /usr/local/lib/python3.8Total: 261.4 MiB M /usr/local/lib
</pre>
Notice that total size of the target directory (/usr/local/lib) is around 260 Megabytes. Of that 260 Megabytes, 160 Megabytes can be found in the heroku subdirectory. 160 MB represents 61% of the total 160 MB. The details percentages don't have to add up to 100%, since with these arguments we are excluding files in the target directory. You may choose to add an option to your script to print files as well. The bar chart in this example is 20 characters long, but this must be dynamic. The 20 characters does <i>not</i> the square brackets. The resolution of the bar chart must become more accurate as you increase the total size. For example, if the user specifies a length of 100 total characters, in this example 61 of those characters would be equal signs and 39 would be spaces. The output of each subdirectory should include percentage, size in bytes (or Human readable if the user uses the -H option), the bar chart and the name of the subdirectory. Specific formatting of the final output will be up to you, but you should be formatted in such a way that the output is easy to read. (ie. use columns!) You will be required to fulfill some specific requirements before completing your script. Read on...
= Assignment Requirements =
== Starting Code ==
The first step for the assignment will be to accept the assignment using the invite code provided by your instructor. You will need to create a GitHub account to do this. (If you already have a GitHub account, you may use this).
In your repository you will find a file called <b>duim.py</b>. This file contains starting code. You will complete the assignment inside duim.py. <b>Do not rename this file or the functions inside, unit tests will fail and you will lose marks!</b>
Also in your repository you will find <b>checkA2.py</b>. You can use this check script to check your work.
== Permitted Modules ==
<b><font color='blue'>Your python script is allowed to import only the <u>os, subprocess, argparse and sys</u> modules from the standard library.</font></b>
=== Documentation ===
There are three types of comments in programming and your assignment should contain each:* The top-level docstring should contain information about what your script does. This is included in the duim.py file. <b>Please use pythoncomplete the top-level docstring.</b>* Use Python's docstring function docstrings to document your python script (script level documentation) and how each of the functions (function level documentation) you created for this assignmentwork. The docstring should describe 'what' the each function does, not 'how' it does.* Your script should also include in-line comments to explain anything that isn't immediately obvious to a beginner programmer. For these comments, it's always better to explain <i>why</i> your code is doing what it does rather than <i>what</i> it's doing. Also: <b><u>It is expected that you will be able to explain how each part of your code works in detail.</u></b>* Refer to the docstring for after() to get an idea of the function docstrings required.
=== Authorship Declaration ===
All your Python code for this assignment must be placed in the provided Python file called <b>assignment1duim.py</b>. <u>Do not change the name of this file.</u> Please complete the declaration <b><u>as part of the top-level docstring</u></b> in your Python source code file (replace "Student Name" with your own name).
= Submission Guidelines and Process =
== Clone Your Repo (ASAP) ==
The first step will be to clone the Assignment 1 2 repository. The invite link will be provided to you by your professor. The repo <b>You will contain need a check script, a README filefree GitHub account to complete this assignment.</b> If you already have an existing GitHub account, and the file where you will enter your codemay use it.
The repo will contain a check script, a README file, and the file where you will enter your code. == The First Milestone (due February 14July 26) ==
For the first milestone you will have two functions to complete.
* <code>call_du_sub</code> will take one argument and return a list. The argument is a target directory. The function will use <code>subprocess.Popen</code> to run the command <b>du -d l <target_directory></b>.
To test with the check script, run the following:
<code>python3 checkA1checkA2.py -f -v TestPercent</code>
<code>python3 checkA2.py -f -v TestDuSub</code> == Second Milestone (due February 21August 2) ==For the second milestone you will have one two more function functions to complete.
* <code>create_dir_dict</code> will take your list from <code>call_du_sub</code> and return a dictionary.
** Every item in your list should create a key in your dictionary.
To run the check script, enter the following:
<code>python checkA1python3 checkA2.py -f -v TestDirDict</code> You will be using a module in the standard library called <b>Argparse</b>. This will help handle more complex sets of options and arguments than simply using sys.argv.Refer to the argparse documentation to complete the <code>parse_command_args</code> function. At minimum, your assignment should handle the following options and arguments: * -h will print a usage message. This will automatically be created by argparse itself, you will not need to implement this. However, refer carefully to the sample output and ensure that 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. Your assignment should be able to produce the following: <code><b>user@host ~ $ python3 duim.py -h</b></code><pre>usage: duim.py [-h] [-H] [-l LENGTH] [target] DU Improved -- See Disk Usage Report with bar charts positional arguments: target The directory to scan. optional arguments: -h, --help show this help message and exit -H, --human-readable print sizes in human readable format (e.g. 1K 23M 2G) -l LENGTH, --length LENGTH Specify the length of the graph. Default is 20. Copyright 2021</pre> Use the following to test your code: <code>python3 checkA2.py -f -v TestArgs</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 check command line argumentscall the parse_command_args function. ** If the user has entered no command line Experiment with print statements so that you understand how each option and argument, use the current directoryare stored.
** If the user has entered more than one argument, or their argument isn't a valid directory, print an error message.
** OtherwiseIf the user doesn't specify any target, use the argument will be your target 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>
* Format the output in a way that is easy to read.
* Add colour to the output.
* Include files in the output.
* Include a threshold, so that results that are less than a user-specified size get excluded from results.
* Add more error checking, print a usage message to the user.
* Accept more options from the user.
* Sort the output by percentage, or by filename.
It is expected that the additional features you provided should be useful, non-trivial, they should not require super-user privileges and should not require the installation of additional packages to work. (ie: I shouldn't have to run pip to make your assignment work).
== The Assignment (due March 7August 6, 11:59pm) ==* Be sure to make your final commit before the deadline.Don't forget to also use <code>git push</code> to push your code into the online repository!
* Then, copy the contents of your <b>duim.py</b> file into a Word document, and submit it to Blackboard. <i>I will use GitHub to evaluate your deadline, but submitting to Blackboard tells me that you wish to be evaluated.</i>
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 March 7 August 6 at 11:59pm.
