Add typehints in openlibrary.accounts module (#9821)

* Add typehints in openlibrary.accounts module
* Add typehints in openlibrary.plugins.upstream.mybooks module

openlibrary/accounts/__init__.py

@@ -5,6 +5,11 @@
 from .model import *  # noqa: F403
 from .model import Account, Link
 
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from openlibrary.plugins.upstream.models import User
+
 
 # Unconfirmed functions (I'm not sure that these should be here)
 def get_group(name):
@@ -20,7 +25,7 @@ class RunAs:
     and then de-escalates to original user.
     """
 
-    def __init__(self, username):
+    def __init__(self, username: str) -> None:
         """
         :param str username: Username e.g. /people/mekBot of user to run action as
         """
@@ -45,14 +50,16 @@ def __exit__(self, exc_type, exc_val, exc_tb):
 
 
 # Confirmed functions (these have to be here)
-def get_current_user():
+def get_current_user() -> "User | None":
     """
     Returns the currently logged in user. None if not logged in.
     """
     return web.ctx.site.get_user()
 
 
-def find(username=None, lusername=None, email=None):
+def find(
+    username: str | None = None, lusername: str | None = None, email: str | None = None
+) -> Account | None:
     """Finds an account by username, email or lowercase username."""
 
     def query(name, value):
@@ -99,7 +106,7 @@ def update_account(username, **kargs):
     web.ctx.site.update_account(username, **kargs)
 
 
-def get_link(code):
+def get_link(code: str) -> Link | bool:
     docs = web.ctx.site.store.values(type="account-link", name="code", value=code)
     if docs:
         doc = docs[0]

openlibrary/core/batch_imports.py

@@ -83,7 +83,7 @@ def batch_import(raw_data: bytes) -> BatchResult:
     The line numbers errors use 1-based counting because they are line numbers in a file.
     """
     user = accounts.get_current_user()
-    username = user.get_username()
+    username = user.get_username() if user else None
     batch_name = f"batch-{generate_hash(raw_data)}"
     errors: list[BatchImportError] = []
     raw_import_records: list[dict] = []

openlibrary/core/bookshelves.py

@@ -626,7 +626,7 @@ def get_recently_logged_books(
         return cls.fetch(logged_books) if fetch else logged_books
 
     @classmethod
-    def get_users_read_status_of_work(cls, username: str, work_id: str) -> str | None:
+    def get_users_read_status_of_work(cls, username: str, work_id: str) -> int | None:
         """A user can mark a book as (1) want to read, (2) currently reading,
         or (3) already read. Each of these states is mutually
         exclusive. Returns the user's read state of this work, if one

openlibrary/plugins/upstream/borrow.py

@@ -749,7 +749,7 @@ def is_users_turn_to_borrow(user, edition) -> bool:
 def is_admin() -> bool:
     """Returns True if the current user is in admin usergroup."""
     user = accounts.get_current_user()
-    return user and user.key in [
+    return user is not None and user.key in [
         m.key for m in web.ctx.site.get('/usergroup/admin').members
     ]
 

openlibrary/plugins/upstream/mybooks.py

@@ -1,7 +1,8 @@
 import json
 import web
+from web.template import TemplateResult
 
-from typing import Final, Literal, cast
+from typing import Final, Literal, cast, TYPE_CHECKING
 
 from infogami import config
 from infogami.utils import delegate
@@ -26,22 +27,25 @@
 from openlibrary.core.follows import PubSub
 from openlibrary.core.yearly_reading_goals import YearlyReadingGoals
 
+if TYPE_CHECKING:
+    from openlibrary.core.lists.model import List
+    from openlibrary.plugins.upstream.models import Work
 
 RESULTS_PER_PAGE: Final = 25
 
 
 class avatar(delegate.page):
     path = "/people/([^/]+)/avatar"
 
-    def GET(self, username):
+    def GET(self, username: str):
         url = User.get_avatar_url(username)
         raise web.seeother(url)
 
 
 class mybooks_home(delegate.page):
     path = "/people/([^/]+)/books"
 
-    def GET(self, username):
+    def GET(self, username: str) -> TemplateResult:
         """Renders the template for the my books overview page
 
         The other way to get to this page is /account/books which is
@@ -398,7 +402,7 @@ def GET(self, username, key='want-to-read'):
 
 
 @public
-def get_patrons_work_read_status(username, work_key):
+def get_patrons_work_read_status(username: str, work_key: str) -> int | None:
     if not username:
         return None
     work_id = extract_numeric_id_from_olid(work_key)
@@ -426,7 +430,7 @@ class MyBooksTemplate:
         "imports",
     }
 
-    def __init__(self, username, key):
+    def __init__(self, username: str, key: str) -> None:
         """The following is data required by every My Books sub-template (e.g. sidebar)"""
         self.username = username
         self.user = web.ctx.site.get('/people/%s' % self.username)
@@ -455,7 +459,7 @@ def __init__(self, username, key):
             else {}
         )
 
-        self.reading_goals = []
+        self.reading_goals: list = []
         self.selected_year = None
 
         if self.me and self.is_my_page or self.is_public:
@@ -467,9 +471,9 @@ def __init__(self, username, key):
             self.sponsorships = get_sponsored_editions(self.user)
             self.counts['sponsorships'] = len(self.sponsorships)
 
-        self.component_times = {}
+        self.component_times: dict = {}
 
-    def render_sidebar(self):
+    def render_sidebar(self) -> TemplateResult:
         return render['account/sidebar'](
             self.username,
             self.key,
@@ -480,7 +484,9 @@ def render_sidebar(self):
             self.component_times,
         )
 
-    def render(self, template, header_title, page=None):
+    def render(
+        self, template: TemplateResult, header_title: str, page: "List | None" = None
+    ) -> TemplateResult:
         """
         Gather the data necessary to render the My Books template, and then
         render the template.
@@ -506,7 +512,7 @@ def __init__(self, user=None):
         self.user = user or accounts.get_current_user()
 
     @property
-    def lists(self):
+    def lists(self) -> list:
         return self.user.get_lists()
 
     @property
@@ -525,7 +531,7 @@ def get_sidebar_counts(self):
         return counts
 
     @property
-    def reading_log_counts(self):
+    def reading_log_counts(self) -> dict[str, int]:
         counts = (
             Bookshelves.count_total_books_logged_by_user_per_shelf(
                 self.user.get_username()
@@ -612,11 +618,11 @@ def add_read_statuses(username, works):
 class PatronBooknotes:
     """Manages the patron's book notes and observations"""
 
-    def __init__(self, user):
+    def __init__(self, user: User) -> None:
         self.user = user
         self.username = user.key.split('/')[-1]
 
-    def get_notes(self, limit=RESULTS_PER_PAGE, page=1):
+    def get_notes(self, limit: int = RESULTS_PER_PAGE, page: int = 1) -> list:
         notes = Booknotes.get_notes_grouped_by_work(
             self.username, limit=limit, page=page
         )
@@ -633,7 +639,7 @@ def get_notes(self, limit=RESULTS_PER_PAGE, page=1):
             }
         return notes
 
-    def get_observations(self, limit=RESULTS_PER_PAGE, page=1):
+    def get_observations(self, limit: int = RESULTS_PER_PAGE, page: int = 1) -> list:
         observations = Observations.get_observations_grouped_by_work(
             self.username, limit=limit, page=page
         )
@@ -648,10 +654,12 @@ def get_observations(self, limit=RESULTS_PER_PAGE, page=1):
             entry['observations'] = convert_observation_ids(ids)
         return observations
 
-    def _get_work(self, work_key):
+    def _get_work(self, work_key: str) -> "Work | None":
         return web.ctx.site.get(work_key)
 
-    def _get_work_details(self, work):
+    def _get_work_details(
+        self, work: "Work"
+    ) -> dict[str, list[str] | str | int | None]:
         author_keys = [a.author.key for a in work.get('authors', [])]
 
         return {
@@ -665,7 +673,7 @@ def _get_work_details(self, work):
         }
 
     @classmethod
-    def get_counts(cls, username):
+    def get_counts(cls, username: str) -> dict[str, int]:
         return {
             'notes': Booknotes.count_works_with_notes_by_user(username),
             'observations': Observations.count_distinct_observations(username),