Remove types from docstrings

Author: JoostGevaert

src/bedrock_ge/gi/ags.py

@@ -17,23 +17,22 @@ def ags_to_brgi_db_mapping(
     """Map AGS 3 or AGS 4 data to the Bedrock GI data model.
 
     Args:
-        source (str | Path | IO[str] | IO[bytes] | bytes): The AGS file (str or Path)
-            or a file-like object that represents the AGS file.
-        projected_crs (CRS): Projected Coordinate Reference System (CRS). For example:
+        source: The AGS file (str or Path) or a file-like object that represents the AGS file.
+        projected_crs: Projected Coordinate Reference System (CRS). For example:
             - OSGB36 / British National Grid: `pyproj.CRS("EPSG:27700")`
             - Hong Kong 1980 Grid System: `pyproj.CRS("EPSG:2326")`
-        vertical_crs (CRS, optional): Vertical CRS. Defaults to EGM2008 height, EPSG:3855
+        vertical_crs: Vertical CRS. Defaults to EGM2008 height, EPSG:3855,
             which measures the orthometric height w.r.t. the Earth Gravitational Model 2008.
             - Ordnance Datum Newlyn (ODN) Height: `pyproj.CRS("EPSG:5701")`
             - Hong Kong Principle Datum (HKPD) Height: `pyproj.CRS("EPSG:5738")`
-        encoding (str | None, optional): Encoding of the text file or bytes stream.
-            Defaults to None. An attempt at detecting the encoding will be made if None.
+        encoding: Encoding of the text file or bytes stream. Defaults to None.
+            An attempt at detecting the encoding will be made if None.
 
     Raises:
         ValueError: If the data does not match AGS 3 or AGS 4 format.
 
     Returns:
-        BedrockGIDatabaseMapping: Object that maps AGS 3 or AGS 4 data to Bedrock GI data model.
+        Object that maps AGS 3 or AGS 4 data to Bedrock GI data model.
     """
     if not encoding:
         encoding = detect_encoding(source)

src/bedrock_ge/gi/ags4.py

@@ -11,13 +11,12 @@ def ags4_to_dfs(
     """Converts AGS 4 data to a dictionary of pandas DataFrames.
 
     Args:
-        source (str | Path | IO[str] | IO[bytes] | bytes): The AGS4 file (str or Path) or a file-like
-            object that represents and AGS4 file.
+        source: The AGS4 file (str or Path) or a file-like object that represents and AGS 4 file.
 
     Returns:
-        dict[str, pd.DataFrame]: A dictionary of pandas DataFrames, where each key
-            represents a group name from AGS 4 data, and the corresponding value is a
-            pandas DataFrame containing the data for that group.
+        A dictionary of pandas DataFrames, where each key represents a group name
+            from AGS 4 data, and the corresponding value is a pandas DataFrame
+            containing the data for that group.
     """
     ags4_tups = AGS4.AGS4_to_dataframe(source)
 

src/bedrock_ge/gi/ags_schemas.py

@@ -7,13 +7,13 @@ def check_ags_proj_group(ags_proj: pd.DataFrame) -> bool:
     """Checks if the AGS 3 or AGS 4 PROJ group is correct.
 
     Args:
-        ags_proj (pd.DataFrame): The DataFrame with the PROJ group.
+        ags_proj: The DataFrame with the PROJ group.
 
     Raises:
         ValueError: If AGS 3 of AGS 4 PROJ group is not correct.
 
     Returns:
-        bool: Returns True if the AGS 3 or AGS 4 PROJ group is correct.
+        Returns True if the AGS 3 or AGS 4 PROJ group is correct.
     """
     if len(ags_proj) != 1:
         raise ValueError("The PROJ group must contain exactly one row.")

src/bedrock_ge/gi/db_operations.py

@@ -28,7 +28,7 @@ def merge_dbs(
         brgi_dbs: The Bedrock GI databases containing the data to be merged.
 
     Returns:
-        BedrockGIDatabase: Merged Bedrock GI database.
+        Merged Bedrock GI database.
     """
     dbs = list(brgi_dbs)
 

src/bedrock_ge/gi/geospatial.py

@@ -32,10 +32,10 @@ def create_brgi_geodb(
     5. Returns a BedrockGIGeospatialDatabase object.
 
     Args:
-        brgi_db (BedrockGIDatabase): The Bedrock GI database to be converted.
+        brgi_db: The Bedrock GI database to be converted.
 
     Returns:
-        BedrockGIGeospatialDatabase: The resulting Bedrock GI geospatial database.
+        The resulting Bedrock GI geospatial database.
     """
     location_geodf = create_location_geodf(brgi_db)
     lon_lat_height_geodf = create_lon_lat_height_geodf(brgi_db)
@@ -72,13 +72,12 @@ def create_location_geodf(brgi_db: BedrockGIDatabase) -> gpd.GeoDataFrame:
     project data.
 
     Args:
-        brgi_db (BedrockGIDatabase): The Bedrock GI database containing location
+        brgi_db: The Bedrock GI database containing location
             data and project CRS information.
 
     Returns:
-        gpd.GeoDataFrame: A GeoDataFrame with LineString geometries representing
-            vertical boreholes, using the compound CRS derived from the project's
-            horizontal and vertical CRS.
+        A GeoDataFrame with LineString geometries representing vertical boreholes,
+            using the compound CRS derived from the project's horizontal and vertical CRS.
     """
     # TODO: Implement logic to handle multiple CRS'es in the input GI data:
     #       1. Create WKT geometry for each location in original CRS
@@ -130,13 +129,11 @@ def create_lon_lat_height_geodf(brgi_db: BedrockGIDatabase) -> gpd.GeoDataFrame:
     EGM2008 ground level height, along with the corresponding point geometries in EPSG:9518.
 
     Args:
-        brgi_db (BedrockGIDatabase): The source Bedrock Ground Investigation database
-            containing location and project information.
+        brgi_db: The source Bedrock Ground Investigation database containing location and project information.
 
     Returns:
-        gpd.GeoDataFrame: A GeoDataFrame with the transformed longitude, latitude,
-            and EGM2008 ground level height, along with the corresponding point
-            geometries in EPSG:9518.
+        A GeoDataFrame with the transformed longitude, latitude, and EGM2008 ground level height,
+            along with the corresponding point geometries in EPSG:9518.
     """
     wgs84_egm2008_crs = CRS("EPSG:9518")
     crs_lookup = brgi_db.Project.set_index("project_uid")
@@ -198,8 +195,7 @@ def interpolate_gi_geometry(
         location_geodf: The location GeoDataFrame containing the location LineStrings to be used for interpolation.
 
     Returns:
-        gpd.GeoDataFrame: A GeoDataFrame containing the interpolated geospatial geometry
-            for the In-Situ test DataFrame.
+        A GeoDataFrame containing the interpolated geospatial geometry for the In-Situ test DataFrame.
     """
     # TODO: implement a warning when interpolating GI geospatial geometry when
     # TODO: a single GI location has waaay too many rows in a certain In-Situ test.
@@ -271,7 +267,7 @@ def interpolate_3d(linestring: LineString, distance: float) -> Point:
         distance: Distance along the line in 3D space
 
     Returns:
-        Point: The interpolated 3D point
+        The interpolated 3D point
     """
     if distance <= 0:
         return Point(linestring.coords[0])
@@ -312,7 +308,7 @@ def substring_3d(
         end_dist: End distance along the line in 3D space
 
     Returns:
-        LineString: The extracted 3D LineString segment
+        The extracted 3D LineString segment
     """
     # Ensure start_dist <= end_dist
     if start_dist > end_dist:

src/bedrock_ge/gi/io_utils.py

@@ -19,14 +19,14 @@ def detect_encoding(source: str | Path | IO[str] | IO[bytes] | bytes) -> str:
     """Detect the character encoding of various input types.
 
     Args:
-        source (str | Path | IO[str] | IO[bytes] | bytes): The source to detect encoding from.
+        source: The source to detect encoding from.
             - str or Path: File path.
             - IO[str]: Already decoded text stream (returns `DEFAULT_ENCODING`)
             - IO[bytes]: Binary stream to detect encoding from
             - bytes: Binary data to detect encoding from
 
     Returns:
-        str: The detected encoding name (e.g., 'utf-8', 'iso-8859-1', 'ascii', etc.)
+        The detected encoding name (e.g., 'utf-8', 'iso-8859-1', 'ascii', etc.)
 
     Raises:
         TypeError: If the source type is unsupported
@@ -122,15 +122,15 @@ def open_text_data_source(
     """Opens or wraps a given source for reading AGS (text-based) data.
 
     Args:
-        source (str | Path | IO[str] | IO[bytes] | bytes): The source to read from.
+        source: The source to read from.
             - str or Path: File path or direct string content.
             - IO[str]: A file-like text stream.
             - IO[bytes]: Byte stream
             - bytes: Binary content or stream (will be decoded).
         encoding (str | None): Encoding to use for decoding bytes. Default is None.
 
     Returns:
-        ContextManager[TextIOBase]: A context manager yielding a text stream.
+        A context manager yielding a text stream.
 
     Raises:
         TypeError: If the source type is unsupported or binary streams are not decoded.
@@ -177,15 +177,14 @@ def coerce_string(string: str) -> None | bool | float | str:
     """Converts a string to an appropriate Python data type.
 
     Args:
-        string (str): The input string to be converted.
+        string: The input string to be converted.
 
     Returns:
-        None: If the string is 'none', 'null', or empty.
-        bool: If the string is 'true' or 'false' (case insensitive).
-        int: If the string can be converted to a float and has no decimal part.
-        float: If the string can be converted to a float with a decimal part.
-        str: If the string cannot be converted to any of the above types.
-
+        None if the string is 'none', 'null', or empty.
+        bool if the string is 'true' or 'false' (case insensitive).
+        int if the string can be converted to a float and has no decimal part.
+        float if the string can be converted to a float with a decimal part.
+        str if the string cannot be converted to any of the above types.
     """
     if string.lower() in {"none", "null", ""}:
         return None
@@ -210,12 +209,11 @@ def brgi_db_to_dfs(
     """Converts a Bedrock GI (geospatial) database to a dictionary of DataFrames.
 
     Args:
-        brgi_db (BedrockGIDatabase | BedrockGIGeospatialDatabase): The Bedrock GI (geospatial) database.
+        brgi_db: The Bedrock GI (geospatial) database.
 
     Returns:
-        dict[str, pd.DataFrame | gpd.GeoDataFrame]: A dictionary where the keys are
-            the Bedrock GI table names and the values are the DataFrames that contain
-            the data for each table.
+        A dictionary where the keys are the Bedrock GI table names and the values are
+        the DataFrames that contain the data for each table.
     """
     dict_of_dfs = {
         "Project": brgi_db.Project,
@@ -254,8 +252,7 @@ def convert_object_col_content_to_string(
         in_place: Whether to modify the DataFrame in-place (default) or return a new DataFrame.
 
     Returns:
-        pd.DataFrame: The modified DataFrame with object dtypes converted to string dtypes.
-
+        The modified DataFrame with object dtypes converted to string dtypes.
     """
     if not in_place:
         df = df.copy()

src/bedrock_ge/gi/mapper.py

@@ -24,7 +24,7 @@ def map_to_brgi_db(brgi_db_mapping: BedrockGIMapping) -> BedrockGIDatabase:
     table, validates them against their respective schemas, and constructs the final
     BedrockGIDatabase object.
 
-    Examples:
+    Example:
         ```python
         from pyproj import CRS
         from bedrock_ge.gi.mapping_models import BedrockGIMapping
@@ -69,12 +69,10 @@ def map_to_brgi_db(brgi_db_mapping: BedrockGIMapping) -> BedrockGIDatabase:
         ```
 
     Args:
-        brgi_db_mapping (BedrockGIDatabaseMapping): The mapping object containing GI
-            data and metadata for mapping to Bedrock's schema.
+        brgi_db_mapping: The mapping object containing GI data and metadata for mapping to Bedrock's schema.
 
     Returns:
-        BedrockGIDatabase: The transformed Bedrock GI database containing validated
-            DataFrames for each table type.
+        The transformed Bedrock GI database containing validated DataFrames for each table type.
     """
     # Create a base64 hash from the project data, such that a project Unique ID
     # can be created from the project_id and the hash of the project data.

src/bedrock_ge/gi/validate.py

@@ -21,12 +21,6 @@ def check_brgi_geodb(
     - Sample
     - All Lab test tables
 
-    Args:
-        brgi_geodb (BedrockGIGeospatialDatabase): Bedrock GI geospatial database object.
-
-    Returns:
-        is_valid (bool): True if all tables are valid and relationships are properly maintained.
-
     Example:
         ```python
         brgi_geodb = BedrockGIGeospatialDatabase(
@@ -39,6 +33,12 @@ def check_brgi_geodb(
         )
         check_brgi_geodb(brgi_db)
         ```
+
+    Args:
+        brgi_geodb: Bedrock GI geospatial database object.
+
+    Returns:
+        True if all tables are valid and relationships are properly maintained.
     """
     # TODO: implement this
     return True
@@ -57,12 +57,6 @@ def check_brgi_db(
     - Sample (without geospatial geometry)
     - All Lab test tables (never has geospatial geometry)
 
-    Args:
-        brgi_db (BedrockGIDatabase): A Bedrock GI database object.
-
-    Returns:
-        bool: True if all tables are valid and relationships are properly maintained.
-
     Example:
         ```python
         brgi_db = BedrockGIDatabase(
@@ -74,6 +68,12 @@ def check_brgi_db(
         )
         check_brgi_db(brgi_db)
         ```
+
+    Args:
+        brgi_db: A Bedrock GI database object.
+
+    Returns:
+        True if all tables are valid and relationships are properly maintained.
     """
     # TODO: implement this
     return True
@@ -89,21 +89,21 @@ def check_foreign_key(
     This function ensures that all foreign key values in a child table exist in the corresponding
     parent table, maintaining data integrity in the GIS database.
 
+    Example:
+        ```python
+        check_foreign_key("project_uid", projects_df, locations_df)
+        ```
+
     Args:
-        foreign_key (str): The name of the column that serves as the foreign key.
-        parent_table (pd.DataFrame| gpd.GeoDataFrame): The parent table containing the primary keys.
-        table_with_foreign_key (pd.DataFrame| gpd.GeoDataFrame): The child table containing the foreign keys.
+        foreign_key: The name of the column that serves as the foreign key.
+        parent_table: The parent table containing the primary keys.
+        table_with_foreign_key: The child table containing the foreign keys.
 
     Returns:
-        bool: True if all foreign keys exist in the parent table.
+        True if all foreign keys exist in the parent table.
 
     Raises:
         ValueError: If any foreign key values in the child table do not exist in the parent table.
-
-    Example:
-        ```python
-        check_foreign_key("project_uid", projects_df, locations_df)
-        ```
     """
     # Get the foreign keys that are missing in the parent group
     missing_foreign_keys = table_with_foreign_key[

src/bedrock_ge/gi/write.py

@@ -20,9 +20,9 @@ def write_brgi_db_to_file(
     determined by the `driver` argument. Possible values are "GPKG" and "EXCEL".
 
     Args:
-        brgi_db (BedrockGIDatabase | BedrockGIGeospatialDatabase): The Bedrock GI (geospatial) database.
-        path (str | Path): The path of the output file.
-        driver (str): The type of the output file. Possible values are "GPKG" and "EXCEL".
+        brgi_db: The Bedrock GI (geospatial) database.
+        path: The path of the output file.
+        driver: The type of the output file. Possible values are "GPKG" and "EXCEL".
 
     Returns:
         None
@@ -47,10 +47,9 @@ def write_gi_db_to_gpkg(
     separate table named by the keys of the dictionary.
 
     Args:
-        dict_of_dfs (dict[str, pd.DataFrame | gpd.GeoDataFrame]): A dictionary where
-            keys are brgi table names and values are pandas DataFrames or GeoDataFrames
-            with brgi data.
-        gpkg_path (str | Path): The name of the output GeoPackage file.
+        dict_of_dfs: A dictionary where keys are brgi table names and values are pandas
+            DataFrames or GeoDataFrames with brgi data.
+        gpkg_path: The name of the output GeoPackage file.
 
     Returns:
         None
@@ -77,10 +76,8 @@ def write_gi_db_to_excel(
     AGS, Bedrock, or another format.
 
     Args:
-        dict_of_dfs (dict[str, pd.DataFrame | gpd.GeoDataFrame]): A dictionary where
-            keys are GI table names and values are DataFrames with GI data.
-        excel_path (str | Path): Path to the output Excel file. Can be provided as a
-            string or Path object.
+        dict_of_dfs: A dictionary where keys are GI table names and values are DataFrames with GI data.
+        excel_path: Path to the output Excel file. Can be provided as a string or Path object.
 
     Returns:
         None
@@ -103,10 +100,10 @@ def sanitize_table_name(sheet_name):
     replacing invalid characters and spaces with underscores.
 
     Args:
-        sheet_name (str): The original sheet name.
+        sheet_name: The original sheet name.
 
     Returns:
-        sanitized_name (str): A sanitized sheet name with invalid characters and spaces replaced.
+        A sanitized sheet name with invalid characters and spaces replaced.
     """
     invalid_chars = [":", "/", "\\", "?", "*", "[", "]"]
     sanitized_name = sheet_name.strip()