Syncronize our SQLAlchemy type hints with db schema

[jonathangreen]

Description

Make sure what what is defined in our SQLAlchemy schema is accuratly reflected in the type hints:

• If a relationship is not a collection, and its foreign key column is nullable make sure the annotation is Optional
  • There were some cases where this caused a large number of mypy failures, since we were widely assuming that these relationships were not optional. In these cases I queried all our production instances, and if the the foreign key was never null, I added a nullable=False to the foreign key column.
• Appropriately set the columns annotation to not Optional if:
  • nullable=False
  • primary_key=True
• Add nullable=False and appropriately set annotation for columns that have default set

Motivation and Context

Our sqlalchemy type hints have been added over time, and some of them did not accurately reflect what was in the DB schema. I noticed this while working on #2194.

These changes meant that I had to add some guard code for errors that mypy rightly flagged. It also meant that I could remove some guard code that was no longer necessary.

How Has This Been Tested?

• Running unit tests
• Querying our production DBs to make sure our production data doesn't have any nulls set

Checklist

• I have updated the documentation accordingly.
• All new and existing tests passed.

[codecov]

Codecov Report

Attention: Patch coverage is 94.73684% with 14 lines in your changes missing coverage. Please review.

Project coverage is 91.08%. Comparing base (7f9581a) to head (905a0b6).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
src/palace/manager/api/odl/api.py	64.28%	3 Missing and 2 partials ⚠️
src/palace/manager/util/notifications.py	0.00%	2 Missing and 1 partial ⚠️
src/palace/manager/api/opds_for_distributors.py	0.00%	1 Missing and 1 partial ⚠️
src/palace/manager/feed/acquisition.py	75.00%	1 Missing and 1 partial ⚠️
src/palace/manager/marc/annotator.py	75.00%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2197      +/-   ##
==========================================
- Coverage   91.09%   91.08%   -0.01%     
==========================================
  Files         363      363              
  Lines       41226    41200      -26     
  Branches     8835     8827       -8     
==========================================
- Hits        37555    37529      -26     
- Misses       2406     2407       +1     
+ Partials     1265     1264       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jonathangreen]

This is okay to get a code review but I need to fix up the migrations parent before it gets merged due to the migration in #2198.

[tdilauro]

This looks good! 🗺️

There are some cases we have not added an annotation. Was that intentional? What is the rationale for whether we are adding one or not?

[jonathangreen]

There are some cases we have not added an annotation. Was that intentional? What is the rationale for whether we are adding one or not?

@tdilauro every relationship mapped value should have a type hint after this change. If I missed any it wasn't intentional.

Only Column mapped values that vary from the default introspection provided by the sqlalchemy mypy plugin (see docs) were annotated. In practice, this means I only annotated Column values that had nullable=False or primary_key=True set on them.