brlib 0.0.2__tar.gz → 0.2.0__tar.gz

{brlib-0.0.2 → brlib-0.2.0}/.github/workflows/test.yml

@@ -1,11 +1,13 @@
-name: Run Tests
+name: Tests
 
 on: 
   push:
-    branches: '**'
+    branches:
+      - '**'
   schedule:
-    # run daily tests after the previous day's scores have hopefully been added
-    - cron: '0 12 * * *'
+    # run at 12 UTC, hopefully after BR's daily in-season updates
+    # run weekly, because anything more would be overkill
+    - cron: '0 12 * * 6'
 
 jobs:
   pytest:

{brlib-0.0.2 → brlib-0.2.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: brlib
-Version: 0.0.2
+Version: 0.2.0
 Summary: A library for collecting baseball statistics from Baseball Reference
 Project-URL: Homepage, https://github.com/john-bieren/brlib
-Project-URL: Documentation, https://github.com/john-bieren/brlib/tree/master/docs
+Project-URL: Documentation, https://github.com/john-bieren/brlib/wiki
 Project-URL: Repository, https://github.com/john-bieren/brlib.git
 Project-URL: Issues, https://github.com/john-bieren/brlib/issues
 Author-email: John Bieren <jbieren64@gmail.com>
@@ -32,10 +32,10 @@ Description-Content-Type: text/markdown
 
 # brlib
 
-![Tests](https://github.com/john-bieren/brlib/actions/workflows/test.yml/badge.svg)
-[![PyPI Latest Release](https://img.shields.io/pypi/v/brlib.svg)](https://pypi.org/project/brlib)
+[![Tests](https://github.com/john-bieren/brlib/actions/workflows/test.yml/badge.svg)](https://github.com/john-bieren/brlib/actions/workflows/test.yml)
+[![PyPI Latest Release](https://img.shields.io/pypi/v/brlib?label=PyPI&logo=pypi&logoColor=ffe873&color=0073b7)](https://pypi.org/project/brlib)
 
-A Python library for collecting baseball statistics from [Baseball Reference](https://www.baseball-reference.com).
+A library for collecting baseball statistics from [Baseball Reference](https://www.baseball-reference.com).
 
 > [!IMPORTANT]
 > brlib is in beta, breaking changes are possible until the release of version 1.
@@ -43,8 +43,8 @@ A Python library for collecting baseball statistics from [Baseball Reference](ht
 ## Key Features
 
 * `Game`, `Player`, and `Team` classes give you easy access to all associated data in one place, with attributes for stats tables, information, and more.
-* Aggregate these into `Games`, `Players`, or `Teams` classes, which contain similar attributes, for easy analysis of larger samples.
-* Quickly search for games, players, and teams of interest, and gather their stats without violating the [rate limit](https://www.sports-reference.com/bot-traffic.html).
+* Aggregate these into `GameSet`, `PlayerSet`, or `TeamSet` classes, which have similar attributes, for easy analysis of larger samples.
+* Quickly search for games, players, and teams of interest, and gather their stats without violating the [rate limit](https://www.sports-reference.com/429.html).
 
 Learn more by reading the documentation on the [wiki](https://github.com/john-bieren/brlib/wiki).
 
@@ -69,3 +69,7 @@ Once installed, you can import brlib into your Python scripts:
 ```python
 import brlib as br
 ```
+
+## Data Use
+
+Since brlib gathers data from Baseball Reference, your use of this data is subject to their [data use policy](https://www.sports-reference.com/data_use.html).

{brlib-0.0.2 → brlib-0.2.0}/README.md

@@ -1,9 +1,9 @@
 # brlib
 
-![Tests](https://github.com/john-bieren/brlib/actions/workflows/test.yml/badge.svg)
-[![PyPI Latest Release](https://img.shields.io/pypi/v/brlib.svg)](https://pypi.org/project/brlib)
+[![Tests](https://github.com/john-bieren/brlib/actions/workflows/test.yml/badge.svg)](https://github.com/john-bieren/brlib/actions/workflows/test.yml)
+[![PyPI Latest Release](https://img.shields.io/pypi/v/brlib?label=PyPI&logo=pypi&logoColor=ffe873&color=0073b7)](https://pypi.org/project/brlib)
 
-A Python library for collecting baseball statistics from [Baseball Reference](https://www.baseball-reference.com).
+A library for collecting baseball statistics from [Baseball Reference](https://www.baseball-reference.com).
 
 > [!IMPORTANT]
 > brlib is in beta, breaking changes are possible until the release of version 1.
@@ -11,8 +11,8 @@ A Python library for collecting baseball statistics from [Baseball Reference](ht
 ## Key Features
 
 * `Game`, `Player`, and `Team` classes give you easy access to all associated data in one place, with attributes for stats tables, information, and more.
-* Aggregate these into `Games`, `Players`, or `Teams` classes, which contain similar attributes, for easy analysis of larger samples.
-* Quickly search for games, players, and teams of interest, and gather their stats without violating the [rate limit](https://www.sports-reference.com/bot-traffic.html).
+* Aggregate these into `GameSet`, `PlayerSet`, or `TeamSet` classes, which have similar attributes, for easy analysis of larger samples.
+* Quickly search for games, players, and teams of interest, and gather their stats without violating the [rate limit](https://www.sports-reference.com/429.html).
 
 Learn more by reading the documentation on the [wiki](https://github.com/john-bieren/brlib/wiki).
 
@@ -37,3 +37,7 @@ Once installed, you can import brlib into your Python scripts:
 ```python
 import brlib as br
 ```
+
+## Data Use
+
+Since brlib gathers data from Baseball Reference, your use of this data is subject to their [data use policy](https://www.sports-reference.com/data_use.html).

{brlib-0.0.2 → brlib-0.2.0}/pyproject.toml

@@ -37,7 +37,7 @@ dev = ["pytest>=9.0.0"]
 
 [project.urls]
 Homepage = "https://github.com/john-bieren/brlib"
-Documentation = "https://github.com/john-bieren/brlib/tree/master/docs"
+Documentation = "https://github.com/john-bieren/brlib/wiki"
 Repository = "https://github.com/john-bieren/brlib.git"
 Issues = "https://github.com/john-bieren/brlib/issues"
 

brlib-0.2.0/src/brlib/__init__.py

@@ -0,0 +1,33 @@
+from .all_major_leaguers import all_major_leaguers
+from .find_asg import find_asg
+from .find_games import find_games
+from .find_teams import find_teams
+from .game import Game
+from .game_set import GameSet
+from .get_games import get_games
+from .get_players import get_players
+from .get_teams import get_teams
+from .options import options
+from .player import Player
+from .player_set import PlayerSet
+from .team import Team
+from .team_set import TeamSet
+
+__version__ = "0.2.0"
+
+__all__ = [
+    "all_major_leaguers",
+    "find_asg",
+    "find_games",
+    "find_teams",
+    "Game",
+    "GameSet",
+    "get_games",
+    "get_players",
+    "get_teams",
+    "options",
+    "Player",
+    "PlayerSet",
+    "Team",
+    "TeamSet"
+]

{brlib-0.0.2 → brlib-0.2.0}/src/brlib/_helpers/abbreviations_manager.py

@@ -58,8 +58,7 @@ class AbbreviationsManager(Singleton):
     def _load(self) -> None:
         """Loads abbreviations data from cache."""
         self.df = pd.read_csv(self._cache_file)
-        self.df["Alias"] = self.df["Alias"].astype(str)
-        self.df.loc[self.df["Alias"] == "nan", "Alias"] = ""
+        self.df.loc[self.df["Alias"].isna(), "Alias"] = ""
 
     def _get(self) -> None:
         """Gets abbreviations data from Baseball Reference."""
@@ -122,7 +121,7 @@ class AbbreviationsManager(Singleton):
         Can return an empty DataFrame if there is no match.
 
         If `era_adjustment` is True, the return DataFrame will contain the row associated with
-        `abbrevation`'s franchise during `season` even if the abbreviation is not correct.
+        `abbreviation`'s franchise during `season` even if the abbreviation is not correct.
         For example, `self._find_correct_teams("FLA", 2025, True)` returns the `MIA` team row.
         There can be multiple rows in the return DataFrame if an abbreviation, e.g. `BAL`,
         is valid during a season, e.g. 1915, and is also associated with a franchise that

{brlib-0.0.2 → brlib-0.2.0}/src/brlib/_helpers/constants.py

@@ -49,6 +49,7 @@ else:
 CACHE_TIMEZONE = pytz.timezone("US/Aleutian")
 
 # pre-compiled regular expressions
+MULTI_TEAM_REGEX = re.compile("^[1-9]TM$")
 SEASON_REGEX = re.compile("^[1-2][0-9]{3}$")
 SEASON_RANGE_REGEX = re.compile("^[1-2][0-9]{3}-[1-2][0-9]{3}$")
 GAME_DATE_REGEX = re.compile("^[0-9]{4}[0-1][0-9][0-3][0-9]$")
@@ -57,11 +58,11 @@ DATE_REGEX = re.compile("^[0-1]?[0-9][0-3][0-9]$")
 DATE_RANGE_REGEX = re.compile("^[0-1]?[0-9][0-3][0-9]-[0-1]?[0-9][0-3][0-9]$")
 PLAYER_ID_REGEX = re.compile("^[a-z.'_]{3,7}[0-9]{2}$")
 SCHEDULE_TAG_REGEX = re.compile("^all_[0-9]")
-GAME_URL_REGEX = re.compile(r"https:\/\/www\.baseball-reference\.com\/boxes\/[A-Z1-2]{2,3}\/[A-Z1-2]{2,3}[0-9]{4}[0-1][0-9][0-3][0-9][0-3]\.shtml")
-ALLSTAR_GAME_URL_REGEX = re.compile(r"https:\/\/www\.baseball-reference\.com\/allstar\/[1-2][0-9]{3}-allstar-game-?[1-2]?\.shtml")
-PLAYER_URL_REGEX = re.compile(r"https:\/\/www\.baseball-reference\.com\/players\/[a-z]\/[a-z.'_]{3,7}[0-9]{2}\.shtml")
-TEAM_URL_REGEX = re.compile(r"https:\/\/www\.baseball-reference\.com\/teams\/[A-Z1-4]{2,3}\/[1-2][0-9]{3}\.shtml")
-SB_ATTEMPT_REGEX = re.compile(r"^(?P<base>2nd base|3rd base|Home) (?:off|by) (?P<pitcher>\D+)\/(?P<catcher>\D+)(?P<times>[0-9]?)$")
+GAME_URL_REGEX = re.compile(r"https://www\.baseball-reference\.com/boxes/[A-Z1-2]{2,3}/[A-Z1-2]{2,3}[0-9]{4}[0-1][0-9][0-3][0-9][0-3]\.shtml")
+ALLSTAR_GAME_URL_REGEX = re.compile(r"https://www\.baseball-reference\.com/allstar/[1-2][0-9]{3}-allstar-game-?[1-2]?\.shtml")
+PLAYER_URL_REGEX = re.compile(r"https://www\.baseball-reference\.com/players/[a-z]/[a-z.'_]{3,7}[0-9]{2}\.shtml")
+TEAM_URL_REGEX = re.compile(r"https://www\.baseball-reference\.com/teams/[A-Z1-4]{2,3}/[1-2][0-9]{3}\.shtml")
+SB_ATTEMPT_REGEX = re.compile(r"^(?P<base>2nd base|3rd base|Home) (?:off|by) (?P<pitcher>\D+)/(?P<catcher>\D+)(?P<times>[0-9]?)$")
 PICKOFF_REGEX = re.compile(r"^(?P<base>1st base|2nd base|3rd base|Home) by (?P<pitcher>\D+)(?P<times>[0-9]?)$")
 
 # old names for teams (which have box scores) that didn't relocate
@@ -105,54 +106,52 @@ RANGE_TEAM_REPLACEMENTS = (
     (1901, 1960, "Washington Senators", "Washington Nationals (1901-1960)")
 )
 
-# old names for stadiums
+# map all names of a venue to its best known name, or current name, if applicable
 VENUE_REPLACEMENTS = {
-    "Angel Stadium of Anaheim": "Anaheim Stadium",
-    "Edison Field": "Anaheim Stadium",
+    "Miller Park": "American Family Field",
+    "Anaheim Stadium": "Angel Stadium of Anaheim",
+    "Edison Field": "Angel Stadium of Anaheim",
     "BB&T Park": "Bowman Field",
     "Muncy Bank Ballpark": "Bowman Field",
     "Journey Bank Ballpark": "Bowman Field",
+    "3Com Park": "Candlestick Park",
     "Bank One Ballpark": "Chase Field",
     "White Sox Park": "Comiskey Park I",
-    "U.S. Cellular Field": "Comiskey Park II",
-    "Guaranteed Rate Field": "Comiskey Park II",
-    "Rate Field": "Comiskey Park II",
     "Mile High Stadium": "Coors Field",
     "Redland Field": "Crosley Field",
     "Enron Field": "Daikin Park",
     "Minute Maid Park": "Daikin Park",
-    "The Ballpark in Arlington": "Globe Life Park",
-    "Ameriquest Field": "Globe Life Park",
-    "Rangers Ballpark in Arlington": "Globe Life Park",
-    "Globe Life Park in Arlington": "Globe Life Park",
-    "Sun Life Stadium": "Hard Rock Stadium",
-    "Land Shark Stadium": "Hard Rock Stadium",
-    "Dolphin Stadium": "Hard Rock Stadium",
-    "Dolphins Stadium": "Hard Rock Stadium",
-    "Pro Player Stadium": "Hard Rock Stadium",
+    "The Ballpark in Arlington": "Globe Life Park in Arlington",
+    "Ameriquest Field": "Globe Life Park in Arlington",
+    "Rangers Ballpark in Arlington": "Globe Life Park in Arlington",
+    "Comiskey Park II": "Rate Field",
+    "U.S. Cellular Field": "Rate Field",
+    "Guaranteed Rate Field": "Rate Field",
     "Joe Robbie Stadium": "Hard Rock Stadium",
+    "Pro Player Stadium": "Hard Rock Stadium",
+    "Dolphins Stadium": "Hard Rock Stadium",
+    "Dolphin Stadium": "Hard Rock Stadium",
+    "Land Shark Stadium": "Hard Rock Stadium",
+    "Sun Life Stadium": "Hard Rock Stadium",
     "Royals Stadium": "Kauffman Stadium",
-    "loanDepot park": "Marlins Park",
-    "American Family Field": "Miller Park",
-    "Municipal Stadium": "Oakland Coliseum",
-    "Oakland-Alameda County Coliseum": "Oakland Coliseum",
-    "Network Associates Coliseum": "Oakland Coliseum",
-    "McAfee Coliseum": "Oakland Coliseum",
-    "O.co Coliseum": "Oakland Coliseum",
-    "RingCentral Coliseum": "Oakland Coliseum",
-    "AT&T Park": "Oracle Park",
-    "SBC Park": "Oracle Park",
+    "Marlins Park": "loanDepot park",
+    "Oakland Coliseum": "Oakland-Alameda County Coliseum",
+    "Network Associates Coliseum": "Oakland-Alameda County Coliseum",
+    "McAfee Coliseum": "Oakland-Alameda County Coliseum",
+    "O.co Coliseum": "Oakland-Alameda County Coliseum",
+    "RingCentral Coliseum": "Oakland-Alameda County Coliseum",
     "Pacific Bell Park": "Oracle Park",
-    "3Com Park": "Oracle Park",
+    "SBC Park": "Oracle Park",
+    "AT&T Park": "Oracle Park",
     "Jacobs Field": "Progressive Field",
     "Cinergy Field": "Riverfront Stadium",
     "SkyDome": "Rogers Centre",
-    "Jack Murphy Stadium": "San Diego Stadium",
-    "Qualcomm Stadium": "San Diego Stadium",
+    "San Diego Stadium": "Jack Murphy Stadium",
+    "Qualcomm Stadium": "Jack Murphy Stadium",
     "Connie Mack Stadium": "Shibe Park",
+    "Safeco Field": "T-Mobile Park",
     "Navin Field": "Tiger Stadium",
     "Briggs Stadium": "Tiger Stadium",
-    "Safeco Field": "T-Mobile Park",
     "SunTrust Park": "Truist Park",
     "Weeghman Park": "Wrigley Field",
     "Cubs Park": "Wrigley Field",
@@ -233,7 +232,24 @@ MISSING_SEASONS_DICT = {
     1940: {"JRC"}
 }
 
-# for distniguishing between league and team abbreviations when processing player career totals
+# some games need their winners altered due to forfeits (https://www.retrosheet.org/forfeits.htm)
+FORFEITED_GAME_WINNERS = {
+    "NY1190105130": "New York Giants",
+    "DET190105310": "Detroit Tigers",
+    "CLE190107230": "Washington Senators",
+    "PIT190508050": "Pittsburgh Pirates",
+    "NYA190609032": "New York Highlanders",
+    "SLN190710051": "St. Louis Cardinals",
+    "NY1190910042": "New York Giants",
+    "CHN191607180": "Brooklyn Robins",
+    "CHA191709090": "Chicago White Sox",
+    "WS1194108150": "Boston Red Sox",
+    "NY1194209262": "Boston Braves",
+    "WS2197109300": "New York Yankees",
+    "CLE197406040": "Texas Rangers"
+}
+
+# for distinguishing between league and team abbreviations when processing player career totals
 LEAGUE_ABVS = {
     "WS", "NL", "AL", "NNL", "NN2", "NAL", "ECL", "ANL",
     "EWL", "NSL", "FL", "AA", "PL", "UA", "NA"
@@ -315,12 +331,11 @@ GAME_INFO_COLS = (
     "Innings",
     "Field Condition",
     "Temperature",
-    "Windspeed",
+    "Wind Speed",
     "Wind Direction",
     "Weather",
     "Precipitation",
-    "Game Type",
-    "Doubleheader"
+    "Game Type"
 )
 
 GAME_BATTING_COLS = (
@@ -482,12 +497,6 @@ GAME_TEAM_INFO_COLS = (
     "Game ID"
 )
 
-GAME_UMP_INFO_COLS = (
-    "Game ID",
-    "Position",
-    "Umpire"
-)
-
 PLAYER_INFO_COLS = (
     "Player",
     "Player ID",
@@ -510,9 +519,9 @@ PLAYER_INFO_COLS = (
     "Draft Pick",
     "Draft Year",
     "Draft Type",
-    "High School",
+    "High Schools",
     "Schools",
-    "Debut",
+    "Debut Date",
     "Debut Game ID",
     "Debut Age",
     "Debut Age (Days)",
@@ -521,11 +530,11 @@ PLAYER_INFO_COLS = (
     "Last Game ID",
     "Last Game Age",
     "Last Game Age (Days)",
-    "Exceeded Rookie Limits",
-    "Full Name",
     "HOF Year",
     "HOF Type",
     "HOF %",
+    "Exceeded Rookie Limits",
+    "Full Name",
     "bWAR",
     "Years Played",
     "Minimum Career Earnings",
@@ -763,6 +772,7 @@ PLAYER_FIELDING_COLS = (
     "CS%",
     "lgCS%",
     "Pick",
+    "Salary",
     "AS",
     "GG",
     "SS",
@@ -788,7 +798,7 @@ TEAM_INFO_COLS = (
     "General Manager",
     "Farm Director",
     "Scouting Director",
-    "Ballpark",
+    "Venue",
     "Attendance",
     "Attendance Rank",
     "Multi-Year Batting Park Factor",
@@ -799,7 +809,7 @@ TEAM_INFO_COLS = (
     "Pythagorean Losses",
     "Team Gold Glove",
     "Pennant",
-    "Championship"
+    "World Series"
 )
 
 TEAM_BATTING_COLS = (

{brlib-0.0.2 → brlib-0.2.0}/src/brlib/_helpers/no_hitter_dicts.py

@@ -114,16 +114,19 @@ class NoHitterDicts(Singleton):
         records = []
         for row in individual_table.find_all("tr"):
             record = [ele.text.strip("*") for ele in row.find_all(["th", "td"])]
-            records.append(record[:8])
+            records.append(record[:9])
         individual_df = pd.DataFrame(
             records,
-            columns=("Rk", "Name", "Perfect", "Gcar", "Gtm", "Year", "Date", "Team")
+            columns=("Rk", "Name", "Perfect", "Gcar", "Gtm", "Year", "Date", "Team", "Home/Away")
         )
         # remove the header rows which appear every 25 rows
         individual_df = individual_df.loc[individual_df["Name"] != "Name"].reset_index(drop=True)
         individual_df["Game Type"] = "R"
         postseason_mask = ((individual_df["Gcar"] == "") &
-                           (individual_df["Year"].astype(int) > FIRST_GAMES_YEAR))
+                           # before FIRST_GAMES_YEAR, Gcar is always blank
+                           (individual_df["Year"].astype(int) >= FIRST_GAMES_YEAR) &
+                           # Gcar is blank and Home/Away is "?" for regular season Negro League NHs
+                           (individual_df["Home/Away"] != "?"))
         individual_df.loc[postseason_mask, "Game Type"] = "P"
         individual_df.loc[individual_df["Perfect"] == "", "Perfect"] = "N"
         individual_df = individual_df.reindex(
@@ -142,7 +145,11 @@ class NoHitterDicts(Singleton):
                 game_id_column.append(game_id)
 
         individual_df["Player ID"] = player_id_column
+        # fix the only exception to postseason_mask
+        individual_df.loc[individual_df["Player ID"] == "griercl01", "Game Type"] = "P"
+
         individual_df["Game ID"] = individual_df["Game ID"].astype("object")
+        # filter out games without box scores and IDs
         individual_df.loc[
             (~individual_df["Team"].isin(BML_TEAM_ABVS)) &
             (individual_df["Year"].astype(int) >= FIRST_GAMES_YEAR),
@@ -156,16 +163,17 @@ class NoHitterDicts(Singleton):
         records = []
         for row in combined_table.find_all("tr"):
             record = [ele.text.strip("*") for ele in row.find_all(["th", "td"])]
-            records.append(record[:11])
+            records.append(record[:9])
         combined_df = pd.DataFrame(
             records,
-            columns=("Rk", "Year", "Date", "Team", "Home/Away", "Opp", "Rslt", "Name", "Gcar", "Gtm", "Inngs")
+            columns=("Rk", "Year", "Date", "Team", "Home/Away", "Opp", "Rslt", "Name", "Gcar")
         )
         # remove the header rows which appear every 25 rows
         combined_df = combined_df.loc[combined_df["Name"] != "Name"].reset_index(drop=True)
         combined_df["Game Type"] = "R"
         postseason_mask = ((combined_df["Gcar"] == "") &
-                           (combined_df["Inngs"] != ""))
+                           # Gcar is blank and Home/Away is "?" for regular season Negro League NHs
+                           (combined_df["Home/Away"] != "?"))
         combined_df.loc[postseason_mask, "Game Type"] = "P"
         combined_df = combined_df.reindex(
             columns=["Player ID", "Perfect", "Combined", "Year", "Team", "Game ID", "Game Type"]
@@ -191,12 +199,12 @@ class NoHitterDicts(Singleton):
                 player_id_column.append(player_id)
             elif href.startswith("/boxes"):
                 game_id = str_between(href, "/", ".", anchor="end")
-                # filter out links to non-existant pages
+                # filter out links to non-existent pages
                 if game_id[:-9] not in BML_TEAM_ABVS:
                     game_id_column.append(game_id)
 
         combined_df["Player ID"] = player_id_column
-        combined_df["Game ID"] = combined_df["Game ID"].astype("object")
+        combined_df["Game ID"] = combined_df["Game ID"].astype("object") # cast to nullable dtype
         combined_df.loc[
             (~combined_df["Team"].isin(BML_TEAM_ABVS)) &
             (combined_df["Year"].astype(int) >= FIRST_GAMES_YEAR),

{brlib-0.0.2 → brlib-0.2.0}/src/brlib/_helpers/utils.py

@@ -3,10 +3,11 @@
 """Defines utility functions used throughout the codebase."""
 
 import functools
+import typing
 from collections.abc import Callable
 from datetime import datetime
 from types import UnionType
-from typing import Any, get_args, get_origin, get_type_hints
+from typing import Any
 
 import pandas as pd
 from bs4 import BeautifulSoup as bs
@@ -18,7 +19,7 @@ from tqdm import tqdm
 def report_on_exc(resp_index: int = 1) -> Callable[..., Any]:
     """
     Prints the URL of a page which causes an exception.
-    `resp_index` is the index of the decorated function's Response arugment which
+    `resp_index` is the index of the decorated function's Response argument which
     corresponds to the offending page.
     """
     def decorator(func: Callable[..., Any]) -> Callable[..., Any]:
@@ -40,7 +41,7 @@ def runtime_typecheck(func: Callable[..., Any]) -> Callable[..., Any]:
     Raises a TypeError at runtime if values passed to the function
     do not match its type annotations.
     """
-    hints = get_type_hints(func)
+    hints = typing.get_type_hints(func)
 
     @functools.wraps(func)
     def wrapper(*args: Any, **kwargs: Any) -> Any:
@@ -61,11 +62,11 @@ def is_type(value: Any, expected_type: type) -> bool:
     if expected_type == Any:
         return True
 
-    origin = get_origin(expected_type)
+    origin = typing.get_origin(expected_type)
     if origin is None:
         return isinstance(value, expected_type)
 
-    args = get_args(expected_type)
+    args = typing.get_args(expected_type)
     if origin is UnionType:
         return any(is_type(value, arg) for arg in args)
 
@@ -97,10 +98,10 @@ def str_between(string: str, start: str, end: str, anchor: str = "start") -> str
     Returns the substring of `string` which appears between `start` and `end`.
     `string` must contain `start` and `end`.
 
-    If `anchor` == "start", the substring between the first occurrence of `start`
+    If `anchor` == `"start"`, the substring between the first occurrence of `start`
     and the first subsequent occurrence of `end` will be returned.
 
-    If `anchor` == "end", the substring between the final occurrence of `end`
+    If `anchor` == `"end"`, the substring between the final occurrence of `end`
     and the final prior occurrence of `start` will be returned.
     """
     if start not in string:
@@ -120,10 +121,14 @@ def str_remove(string: str, *substrings: str) -> str:
         string = string.replace(substring, "")
     return string
 
+def clean_spaces(string: str) -> str:
+    """Removes consecutive, leading, and trailing spaces from `string`."""
+    return " ".join(string.split()).strip()
+
 def reformat_date(string_date: str) -> str:
     """
-    Converts `string_date` of "MM DD, YYYY" to "YY-MM-DD" for formatting consistency.
-    If `string_date` does not match this format, and empty string will be returned.
+    Converts `string_date` of "Month DD, YYYY" to "YY-MM-DD" for formatting consistency.
+    If `string_date` does not match this format, an empty string will be returned.
     """
     try:
         date = datetime.strptime(string_date, "%B %d, %Y")
@@ -135,7 +140,7 @@ def reformat_date(string_date: str) -> str:
     day = f"0{day}" if day < 10 else day
     return f"{date.year}-{month}-{day}"
 
-def soup_from_comment(tag: Tag, only_if_table: bool = False) -> bs | Tag:
+def soup_from_comment(tag: Tag, only_if_table: bool) -> bs | Tag:
     """
     Returns contents from the first comment within `tag`.
     If `tag` does not include a table and `only_if_table` == True, returns `tag`.
@@ -149,7 +154,7 @@ def soup_from_comment(tag: Tag, only_if_table: bool = False) -> bs | Tag:
     except (IndexError, ValueError):
         return tag
 
-def scrape_player_ids(table: bs) -> list[str]:
+def scrape_player_ids(table: bs | Tag) -> list[str]:
     """Returns player IDs from anchor tags in `table`."""
     player_id_column = []
     for row in table.find_all("a", href=True):

brlib-0.2.0/src/brlib/all_major_leaguers.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+
+"""Defines all_major_leaguers function."""
+
+from io import StringIO
+
+import pandas as pd
+
+from ._helpers.requests_manager import req_man
+from .options import print_page
+
+
+def all_major_leaguers() -> pd.DataFrame:
+    """
+    Returns a DataFrame of basic information about all players in major league history.
+
+    ## Parameters
+
+    None
+
+    ## Returns
+
+    `pandas.DataFrame`
+
+    ## Examples
+
+    The output (as of 2025-26 offseason):
+
+    ```
+    >>> br.all_major_leaguers()
+        Player ID             Name  Career Start  Career End  Active
+    0      aardsda01    David Aardsma          2004        2015   False
+    1      aaronha01      Henry Aaron          1954        1976   False
+    2      aaronto01     Tommie Aaron          1962        1971   False
+    3       aasedo01         Don Aase          1977        1990   False
+    4       abadan01        Andy Abad          2001        2006   False
+    ...          ...              ...           ...         ...     ...
+    23610   zupofr01       Frank Zupo          1957        1961   False
+    23611  zuvelpa01     Paul Zuvella          1982        1991   False
+    23612  zuverge01  George Zuverink          1951        1959   False
+    23613  zwilldu01   Dutch Zwilling          1910        1916   False
+    23614   zychto01        Tony Zych          2015        2017   False
+
+    [23615 rows x 5 columns]
+    ```
+
+    You can filter results and convert them into a `get_players` input:
+
+    ```
+    >>> aml = br.all_major_leaguers()
+    >>> mask = aml["Player ID"].str.startswith("q")
+    >>> aml = aml.loc[mask]
+    >>> aml["Player ID"].values.tolist()
+    ['quackke01', 'quallch01', 'quallji01', ...]
+    ```
+    """
+    page = req_man.get_page("/short/inc/players_search_list.csv")
+    print_page("All MLB Players")
+    csv_lines = str(page.content, "UTF-8").strip()
+    # add column names, which are not included in the payload
+    columns = "Player ID,Name,Career Span,Active,1,2,3,4,5\n"
+    players_df = pd.read_csv(StringIO(columns + csv_lines))
+
+    # split career span into start and end (if span is one year, only year is listed, no range)
+    players_df["Career Start"] = players_df["Career Span"].str.split("-", n=1).str[0].astype(int)
+    players_df["Career End"] = players_df["Career Span"].str.split("-", n=1).str[-1].astype(int)
+    # convert active column from 0/1 to boolean
+    players_df["Active"] = players_df["Active"].astype(bool)
+
+    columns = ["Player ID", "Name", "Career Start", "Career End", "Active"]
+    players_df = players_df.reindex(columns=columns)
+    return players_df