-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implemented processor for prepayments
Prepayments have been implemented by a new processor, `PrepaymentProcessor`. The full implementation for prepayments involved the following changes: - Several new columns names have been added to `invoices/invoice.py`, including column names for the prepay data files and for the exported invoices - Many invoices will now export with 4 new columns: `Prepaid Group Name`, `Prepaid Group Institution`, `Prepaid Group Balance`, `Prepaid Group Used` - 4 command line arguments have been added to `process_report.py`. 3 of them allows the user to pass in a local version of the prepay credits, contacts, and projects file. The last one (`—prepay-debits`) allows passing a local version of the prepay debits files, and defaults to fetching from s3 if not provided - A set of test cases have been added for `PrepaymentProcessor` Since the implementation of this feature required a lot of logic decisions (i.e What happens if a prepaid project is active, but has no funds?), below is (hopefully) an exhaustive list of code logic decisions that were made. These can also be inferred through the test cases. - Prepay projects listed in `prepaid_projects.csv` are identified by their project name, not project - allocation name - Attempting to process past invoices (“backprocessing”) may result in incorrect output due to the nature of the prepay debit ledger - While backprocessing is not supported for past months, processing the same invoice month twice will still return correct output. In this case, the month’s debit entry may be will be overwritten - Prepay balances can be used in the same month they are added. - The time range in which prepay projects are considered “active” includes their start and end date - After processing of any given invoice month, debit entries for that month will be added. I emphasize this for clarification. A debit entry such as: `2024-11,G1,1062.48` Should be interpreted as: In the period from 2024-11-01 to 2024-11-30, prepay group G1 spent $1062.48 As opposed to: In the period from 2024-10-01 to 2024-10-31, … - If prepay projects are “active” but their prepay group has $0 balance, their prepay info (group name, contact email) is still included, but the prepay balance will be displayed as $0 and the prepay used as an empty field
- Loading branch information
Showing
10 changed files
with
726 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| import sys | ||
|
|
||
| from dataclasses import dataclass | ||
| import pandas | ||
|
|
||
| from process_report import util | ||
| from process_report.invoices import invoice | ||
| from process_report.processors import discount_processor | ||
|
|
||
|
|
||
| @dataclass | ||
| class PrepaymentProcessor(discount_processor.DiscountProcessor): | ||
| IS_DISCOUNT_BY_NERC = True | ||
|
|
||
| prepay_credits: pandas.DataFrame | ||
| prepay_projects: pandas.DataFrame | ||
| prepay_contacts: pandas.DataFrame | ||
| prepay_debits_filepath: str | ||
| upload_to_s3: bool | ||
|
|
||
| @staticmethod | ||
| def _load_prepay_debits(prepay_debits_filepath): | ||
| try: | ||
| prepay_debits = pandas.read_csv(prepay_debits_filepath) | ||
| except FileNotFoundError: | ||
| sys.exit("Applying prepayments failed. prepay debits file does not exist") | ||
|
|
||
| return prepay_debits | ||
|
|
||
| def _prepare(self): | ||
| self.data[invoice.GROUP_NAME_FIELD] = None | ||
| self.data[invoice.GROUP_INSTITUTION_FIELD] = None | ||
| self.data[invoice.GROUP_MANAGED_FIELD] = None | ||
| self.data[invoice.GROUP_BALANCE_FIELD] = None | ||
| self.data[invoice.GROUP_BALANCE_USED_FIELD] = None | ||
|
|
||
| self.prepay_debits = self._load_prepay_debits(self.prepay_debits_filepath) | ||
| self.group_info_dict = self._get_prepay_group_dict() | ||
|
|
||
| def _process(self): | ||
| self._add_prepay_info() | ||
| self._apply_prepayments() | ||
|
|
||
| self._export_prepay_debits() | ||
| if self.upload_to_s3: | ||
| self._export_s3_prepay_debits() | ||
|
|
||
| def _get_prepay_group_dict(self): | ||
| """Loads prepay info into a dict for simpler indexing | ||
| during processing step""" | ||
| prepay_group_dict = dict() | ||
| for _, group_info in self.prepay_contacts.iterrows(): | ||
| group_name = group_info[invoice.PREPAY_GROUP_NAME_FIELD] | ||
| prepay_group_dict[group_name] = dict() | ||
| prepay_group_dict[group_name][ | ||
| invoice.PREPAY_GROUP_CONTACT_FIELD | ||
| ] = group_info[invoice.PREPAY_GROUP_CONTACT_FIELD] | ||
| prepay_group_dict[group_name][invoice.PREPAY_MANAGED_FIELD] = group_info[ | ||
| invoice.PREPAY_MANAGED_FIELD | ||
| ] | ||
| prepay_group_dict[group_name][invoice.GROUP_BALANCE_FIELD] = 0 | ||
| prepay_group_dict[group_name][invoice.PREPAY_PROJECT_FIELD] = [] | ||
|
|
||
| for _, group_credit in self.prepay_credits.iterrows(): | ||
| if ( | ||
| util.get_month_diff( | ||
| self.invoice_month, group_credit[invoice.PREPAY_MONTH_FIELD] | ||
| ) | ||
| >= 0 | ||
| ): | ||
| prepay_group_dict[group_credit[invoice.PREPAY_GROUP_NAME_FIELD]][ | ||
| invoice.GROUP_BALANCE_FIELD | ||
| ] += group_credit[invoice.PREPAY_CREDIT_FIELD] | ||
|
|
||
| for _, group_debit in self.prepay_debits.iterrows(): | ||
| if ( | ||
| util.get_month_diff( | ||
| self.invoice_month, group_debit[invoice.PREPAY_MONTH_FIELD] | ||
| ) | ||
| > 0 | ||
| ): | ||
| prepay_group_dict[group_debit[invoice.PREPAY_GROUP_NAME_FIELD]][ | ||
| invoice.GROUP_BALANCE_FIELD | ||
| ] -= group_debit[invoice.PREPAY_DEBIT_FIELD] | ||
|
|
||
| for _, group_project in self.prepay_projects.iterrows(): | ||
| if ( | ||
| util.get_month_diff( | ||
| self.invoice_month, group_project[invoice.PREPAY_START_DATE_FIELD] | ||
| ) | ||
| >= 0 | ||
| and util.get_month_diff( | ||
| group_project[invoice.PREPAY_END_DATE_FIELD], self.invoice_month | ||
| ) | ||
| >= 0 | ||
| ): | ||
| prepay_group_dict[group_project[invoice.PREPAY_GROUP_NAME_FIELD]][ | ||
| invoice.PREPAY_PROJECT_FIELD | ||
| ].append(group_project[invoice.PREPAY_PROJECT_FIELD]) | ||
|
|
||
| return prepay_group_dict | ||
|
|
||
| def _add_prepay_info(self): | ||
| """Populate prepaid group name, institute, and MGHPCC managed field""" | ||
| institute_list = util.load_institute_list() | ||
| institute_map = util.get_institute_mapping(institute_list) | ||
|
|
||
| for group_name, group_dict in self.group_info_dict.items(): | ||
| group_institute = util.get_institution_from_pi( | ||
| institute_map, group_dict[invoice.PREPAY_GROUP_CONTACT_FIELD] | ||
| ) | ||
|
|
||
| row_mask = self.data[invoice.PROJECT_NAME_FIELD].isin( | ||
| group_dict[invoice.PREPAY_PROJECT_FIELD] | ||
| ) | ||
| col_mask = [ | ||
| invoice.INVOICE_EMAIL_FIELD, | ||
| invoice.GROUP_NAME_FIELD, | ||
| invoice.GROUP_INSTITUTION_FIELD, | ||
| invoice.GROUP_MANAGED_FIELD, | ||
| ] | ||
| self.data.loc[row_mask, col_mask] = [ | ||
| group_dict[invoice.PREPAY_GROUP_CONTACT_FIELD], | ||
| group_name, | ||
| group_institute, | ||
| group_dict[invoice.PREPAY_MANAGED_FIELD], | ||
| ] | ||
|
|
||
| def _apply_prepayments(self): | ||
| for group_name, group_dict in self.group_info_dict.items(): | ||
| group_projects = self.data[ | ||
| self.data[invoice.GROUP_NAME_FIELD] == group_name | ||
| ] | ||
| prepay_amount_used = self.apply_flat_discount( | ||
| self.data, | ||
| group_projects, | ||
| invoice.PI_BALANCE_FIELD, | ||
| group_dict[invoice.GROUP_BALANCE_FIELD], | ||
| invoice.GROUP_BALANCE_USED_FIELD, | ||
| invoice.BALANCE_FIELD, | ||
| ) | ||
|
|
||
| remaining_prepay_balance = ( | ||
| group_dict[invoice.GROUP_BALANCE_FIELD] - prepay_amount_used | ||
| ) | ||
| self.data.loc[ | ||
| self.data[invoice.GROUP_NAME_FIELD] == group_name, | ||
| invoice.GROUP_BALANCE_FIELD, | ||
| ] = remaining_prepay_balance | ||
|
|
||
| if prepay_amount_used > 0: | ||
| debit_entry_mask = ( | ||
| self.prepay_debits[invoice.PREPAY_MONTH_FIELD] == self.invoice_month | ||
| ) & (self.prepay_debits[invoice.PREPAY_GROUP_NAME_FIELD] == group_name) | ||
| if self.prepay_debits[debit_entry_mask].empty: | ||
| self.prepay_debits = pandas.concat( | ||
| [ | ||
| self.prepay_debits, | ||
| pandas.DataFrame( | ||
| [[self.invoice_month, group_name, prepay_amount_used]], | ||
| columns=self.prepay_debits.columns, | ||
| ), | ||
| ], | ||
| ignore_index=True, | ||
| ) | ||
| else: | ||
| self.prepay_debits.loc[ | ||
| debit_entry_mask, invoice.PREPAY_DEBIT_FIELD | ||
| ] = prepay_amount_used | ||
|
|
||
| def _export_prepay_debits(self): | ||
| self.prepay_debits.to_csv(self.prepay_debits_filepath, index=False) | ||
|
|
||
| def _export_s3_prepay_debits(self): | ||
| invoice_bucket = util.get_invoice_bucket() | ||
| invoice_bucket.upload_file(self.prepay_debits_filepath, "TODO.csv") # TODO |
Oops, something went wrong.