HW2 - Stocks

Introduction

In this exercise you will practice

writing classes,

reading CSV files,

using control structures, and

manipulating data structures.

General Instructions

This is an individual assignment.

Collaboration at a reasonable level will not result in substantially similar code. Students may only collaborate with fellow students currently taking CS 2316, the TAs and the professor. Collaboration means talking through problems, assisting with debugging, explaining a concept, etc. You should not exchange code or write code for others.

Notes:

Include a comment with your name, T-Square login ID, and GTID at the top of all Python files.

Do not wait until the last minute to do this assignment in case you run into problems.

Pay close attention to whether problems require you to print or return the results! Printing instead of returning or vice versa will result in a point deduction.

Name all modules, classes methods, and functions as specified in the instructions.

Unless otherwise stated, you can assume inputs will be valid in this assignment (i.e. error checking is not required).

In a Python module you must define a value (such as a function) before referencing it. So if you call function A from function B, the definition of function A must come before the definition of function B in the file.

Problem Description

You need to process daily stock prices that are stored in CSV files. Each stock is stored in a CSV file named after the stocks ticker symbol. For example, the stock prices for Alphabet, Inc are stored in a file named GOOG.csv.

Solution Description

Write a module named stocks that includes two classes:

Company with the following instance attributes:

symbol: str the official stock ticker symbol

name: str the companys name

sector: str the companys sector, as defined by Yahoo Finance

stock_data: dict[datetime, StockData] a dictionary mapping datetime objects to StockData objects

and the following instance methods:

__init__ which takes arguments that are used to initialize the values of the instance attribute listed above (except stock_data), in the order listed above. Only the symbol must be provided when creating a Company instance, the other instance attributes (except stock_data) should have the value None if not provided as arguments to __init__ when creating a Company object.

a method which is automatically called whenever a Company object is printed or converted to a str and returns a string with the companys name and stock symbol in parentheses, e.g., Alphabet (GOOG)

a method which is automatically called by the Python REPL to print the value of a Company object to the console and returns a string with the class name and all the attributes (except stock_data) between angle brackets, e.g.,

performance which takes an optional start date and optional end date and returns the percentage return (as a float, e.g., 20% is .20, 120% is 1.20) from the open price on the start date to the adjusted closing price on the end date, i.e., if you multiply the open price on the start date by the value returned by this function and add that result to the open price on the start date, you get the adjusted closing price on the end date. Dates should be datetime objects with date components but no time components.

If the start date is not in stock_data, use the next date after the specified start date for which there is data.

If the start date is not provided, use the first date in stock_data.

If the end date is not in stock_data, use the last date before the specified end date for which there is data.

If the end date is not provided, use the last date in stock_data.

StockData with the following instance attributes to store the data found in a record in a stock data CSV file:

open_price: float

high: float

low: float

close: float

adj_close: float

volume: int

and an instance method that makes instances of StockData comparable to each other using the < operator based on the values of their adj_close attributes.

Finally, your stocks module should be runnable as a script that takes three command line arguments: a companys stock symbol, a start date, and an end date.

The stock symbol, e.g., GOOG is required.

Start date and end date are optional. If either is not supplied, follow the directions for the Company.performance method above. Note that if you supply only one date, its the start date. You cant specify an end date but no start date. Date should be in ISO 8601 format (see examples below).

Your script should:

create a Company object with the symbol but no company name or sector,

read a CSV file in its working directory which is named after the stock symbol (with a .csv ending),

use the data in the CSV file to populate the Company objects stock_data dictionary,

use the Company objects performance method to find the requested stock return, and

print a report as in the examples below. Note that the performace reported by the scrip t should be in percentage format, not a float as returned by Company.performance.

Your stocks module not perform any of the script actions listed above when imported as a module.

Your program should work with CSV files formatted and named like the ones you can download from Yahoo Finace, e.g., Alphabet, Inc historical data. For your convenience you may use the following files: AAPL.csv, BAC.csv, C.csv, CSCO.csv, F.csv, FB.csv, FCAU.csv, GM.csv, GOOG.csv, JPM.csv, ORCL.csv, WFC.csv.

Here are some sample program runs:

$ python stocks.py GOOG Stock performance of None (GOOG) from 2004-08-19 to 2017-09-21: 1777.0%. $ python stocks.py GOOG 2017-01-01 Stock performance of None (GOOG) from 2017-01-01 to 2017-09-21: 19.7%. $ python stocks.py GOOG 2015-01-01 2017-09-21 Stock performance of None (GOOG) from 2015-01-01 to 2017-09-21: 77.2%. 

Don't worry about csv files.