added notes about individual project.

Author: PythonCHB

materials/source/index.rst

@@ -115,6 +115,12 @@ Fluent Python
 
 `Fluent Python <http://shop.oreilly.com/product/0636920032519.do>`_, by Luciano Ramalho, is an excellent book about the more advanced features of Python. We highly recommend you get it, and we will be referencing it throughout the class.
 
+Individual_project
+------------------
+
+In addition to weekly exercises, you will also complete an :ref:`individual_project`
+
+
 Week 1: Jan 9 -- Iterators and Generators, Packaging
 ....................................................
 

solutions/mailroom_json_save/mailroom/model.py

@@ -9,10 +9,13 @@
 
 # handy utility to make pretty printing easier
 from textwrap import dedent
+from pathlib import Path
 
 import json_save.json_save_dec as js
 import json
 
+from . import data_dir
+
 
 @js.json_save
 class Donor:
@@ -108,31 +111,78 @@ def gen_letter(self):
 @js.json_save
 class DonorDB:
     """
-    encapsulation of the entire database of donors and data associated with them.
+    Encapsulation of the entire database of donors and data associated with them.
     """
+    # specify a json_save dict as the data structure for the data.
     donor_data = js.Dict()
 
-    def __init__(self, donors=None):
+    def __init__(self, donors=None, db_file=None):
         """
         Initialize a new donor database
 
         :param donors=None: iterable of Donor objects
+
+        :param db_file=None: path to file to store the datbase in.
+                             if None, the data will be stored in the
+                             package data_dir
         """
         if donors is None:
             self.donor_data = {}
         else:
             self.donor_data = {d.norm_name: d for d in donors}
 
+        if db_file is None:
+            self.db_file = data_dir / "mailroom_data.json"
+        else:
+            self.db_file = Path(db_file)
+
+    def mutating(self, method):
+        """
+        Decorator that saves the DB when a change is made
+
+        It should be applied to all mutating methods, so the
+        data will be saved whenever it's been changed.
+
+        NOTE: This is not very efficient -- it will re-write
+              the entire file each time.
+        """
+        def wrapped(*args, **kwargs):
+            res = method(*args, **kwargs)
+            self.save()
+            return res
+        return wrapped
+
     @classmethod
     def load_from_file(cls, filename):
         """
-        loads a donor database from a json file
+        loads a donor database from a raw json file
+        NOTE: This is not a json_save format file!
+              -- it is a simpler, less flexible format.
         """
         with open(filename) as infile:
             donors = json.load(infile)
         db = cls([Donor(*d) for d in donors])
         return db
 
+
+    @classmethod
+    def load_json_save(cls, filename):
+        """
+        loads a donor database from a json_save format file.
+        """
+
+        # with open(filename) as infile:
+        #     donors = json.load(infile)
+        # db = cls([Donor(*d) for d in donors])
+        # return db
+
+    def save(self):
+        """
+        save the data to a json_save file
+        """
+        with open(self.db_file, 'w') as db_file:
+            self.to_json(db_file)
+
     @property
     def donors(self):
         """

solutions/mailroom_json_save/mailroom/sample_data.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+
+"""
+sample data for testing, etc.
+
+This is a python list of Donor objects, suitable for loading into a
+
+DonorDB instance:
+
+DB = DonorDB(sample_donor_data)
+
+"""
+
+from .model import Donor
+
+
+def sample_donor_data():
+    return [Donor("William Gates III", [653772.32, 12.17]),
+            Donor("Jeff Bezos", [877.33]),
+            Donor("Paul Allen", [663.23, 43.87, 1.32]),
+            Donor("Mark Zuckerberg", [1663.23, 4300.87, 10432.0])
+            ]

solutions/mailroom_json_save/mailroom/test/conftest.py

@@ -1,18 +1,32 @@
 """
 conftest.py
 
-This is a file that will automatically be read by pytest to find fixtures, etc.
+This is a file that will automatically be read by pytest to
+find fixtures, etc.
 
 It's a good place to put stuff that multiple test files need.
 """
+from pathlib import Path
 
 import pytest
-from mailroom import model, data_dir
+from mailroom.model import DonorDB
+from mailroom.sample_data import sample_donor_data
+
+test_output_path = Path(__file__).parent / "output"
+
+# make sure the output path exists
+test_output_path.mkdir(exist_ok=True)
 
 
 @pytest.fixture
 def sample_db():
-    """
-    creates a clean sample database for the tests to use
-    """
-    return model.DonorDB.load_from_file(data_dir / "sample_data.json")
+    """a clean DonorDB for tests"""
+    return DonorDB(sample_donor_data(),
+                   db_file=test_output_path / "db1.json_save")
+
+
+@pytest.fixture
+def sample_db2():
+    """so we can have two separate ones if needed"""
+    return DonorDB(sample_donor_data(),
+                   db_file=test_output_path / "db2.json_save")

solutions/mailroom_json_save/mailroom/test/test_json_save.py

@@ -4,15 +4,12 @@
 Test code for saving data to/from json with json_save
 """
 
-import pytest
 
-from mailroom import data_dir
-from mailroom.model import Donor, DonorDB
+import pytest
 
+from json_save import json_save_dec as js
 
-@pytest.fixture()
-def sample_db():
-    return DonorDB.load_from_file(data_dir / "sample_data.json")
+from mailroom.model import Donor, DonorDB
 
 
 def test_one_donor():
@@ -42,17 +39,34 @@ def test_donor_db(sample_db):
     db2 = DonorDB.from_json_dict(dbd)
 
     # See if it's the same:
-    jeff_bezos = db2.find_donor('jeff bezos')
-    jeff_bezos.add_donation(2000)
+    assert db2 == sample_db
+
 
-    print(jeff_bezos)
+def test_donor_db_not_equal(sample_db, sample_db2):
+    """
+    makes sure that two DBs aren't equal if you change something.
+
+    __eq__ is provided by json_save
+    """
+    # They should be equal initially
 
-    print(db2.donor_data.keys())
+    assert sample_db == sample_db2
+
+    # now make a change in one
+    jeff_bezos = sample_db2.find_donor('jeff bezos')
+    jeff_bezos.add_donation(2000)
+
+    assert sample_db != sample_db2
 
-    assert db2 == sample_db
 
-    print(db2)
+def test_save(sample_db):
+    # save out the DB
+    sample_db.save()
 
-    assert False
+    # Make a new one from the file
+    with open(sample_db.db_file) as js_file:
+        DB = js.from_json(js_file)
 
+    # are they the same?
+    assert sample_db == DB
 

solutions/mailroom_json_save/mailroom/test/test_model.py

@@ -26,7 +26,8 @@
 
 import os
 import pytest
-from mailroom import model, data_dir
+from mailroom import model
+
 
 
 def test_empty_db():

solutions/mailroom_json_save/test_donor_db.json

@@ -5,6 +5,7 @@
 """
 
 import json
+from pathlib import Path
 
 from .json_save_meta import *
 
@@ -139,7 +140,7 @@ def from_json(_json):
     Factory function that re-creates a JsonSaveable object
     from a json string or file
     """
-    if isinstance(_json, str):
+    if isinstance(_json, (str, Path)):
         return from_json_dict(json.loads(_json))
     else:  # assume a file-like object
         return from_json_dict(json.load(_json))