ENH: correct dataframe check (#255)

* ENH: correct dataframe check

* CLN: change assert comment

trackintel/analysis/location_identification.py

@@ -46,7 +46,9 @@ def location_identifier(spts, method="FREQ", pre_filter=True, **pre_filter_kwarg
     --------
     >>> ti.analysis.location_identifier(spts, pre_filter=True, method="FREQ")
     """
-    assert spts.as_staypoints
+    # assert validity of staypoints
+    spts.as_staypoints
+
     spts = spts.copy()
     if "location_id" not in spts.columns:
         raise KeyError(
@@ -119,7 +121,9 @@ def pre_filter_locations(
     >> mask = ti.analysis.pre_filter_locations(spts)
     >> spts = spts[mask]
     """
-    assert spts.as_staypoints
+    # assert validity of staypoints
+    spts.as_staypoints
+
     spts = spts.copy()
     if isinstance(thresh_loc_time, str):
         thresh_loc_time = pd.to_timedelta(thresh_loc_time)

trackintel/io/file.py

@@ -93,7 +93,9 @@ def read_positionfixes_csv(*args, columns=None, tz=None, index_col=object(), crs
     pfs = gpd.GeoDataFrame(df, geometry="geom")
     if crs:
         pfs.set_crs(crs, inplace=True)
-    assert pfs.as_positionfixes
+
+    # assert validity of positionfixes
+    pfs.as_positionfixes
     return pfs
 
 
@@ -195,7 +197,9 @@ def read_triplegs_csv(*args, columns=None, tz=None, index_col=object(), crs=None
     tpls = gpd.GeoDataFrame(df, geometry="geom")
     if crs:
         tpls.set_crs(crs, inplace=True)
-    assert tpls.as_triplegs
+
+    # assert validity of triplegs
+    tpls.as_triplegs
     return tpls
 
 
@@ -291,7 +295,9 @@ def read_staypoints_csv(*args, columns=None, tz=None, index_col=object(), crs=No
     stps = gpd.GeoDataFrame(df, geometry="geom")
     if crs:
         stps.set_crs(crs, inplace=True)
-    assert stps.as_staypoints
+
+    # assert validity of staypoints
+    stps.as_staypoints
     return stps
 
 
@@ -376,7 +382,9 @@ def read_locations_csv(*args, columns=None, index_col=object(), crs=None, **kwar
     locs = gpd.GeoDataFrame(df, geometry="center")
     if crs:
         locs.set_crs(crs, inplace=True)
-    assert locs.as_locations
+
+    # assert validity of locations
+    locs.as_locations
     return locs
 
 
@@ -464,7 +472,8 @@ def read_trips_csv(*args, columns=None, tz=None, index_col=object(), **kwargs):
         if not pd.api.types.is_datetime64tz_dtype(trips[col]):
             trips[col] = _localize_timestamp(dt_series=trips[col], pytz_tzinfo=tz, col_name=col)
 
-    assert trips.as_trips
+    # assert validity of trips
+    trips.as_trips
     return trips
 
 

trackintel/io/from_geopandas.py

@@ -49,7 +49,8 @@ def read_positionfixes_gpd(gdf, tracked_at="tracked_at", user_id="user_id", geom
         if not pd.api.types.is_datetime64tz_dtype(pfs[col]):
             pfs[col] = _localize_timestamp(dt_series=pfs[col], pytz_tzinfo=tz, col_name=col)
 
-    assert pfs.as_positionfixes
+    # assert validity of positionfixes
+    pfs.as_positionfixes
     return pfs
 
 
@@ -104,7 +105,8 @@ def read_staypoints_gpd(
         if not pd.api.types.is_datetime64tz_dtype(stps[col]):
             stps[col] = _localize_timestamp(dt_series=stps[col], pytz_tzinfo=tz, col_name=col)
 
-    assert stps.as_staypoints
+    # assert validity of staypoints
+    stps.as_staypoints
     return stps
 
 
@@ -159,7 +161,8 @@ def read_triplegs_gpd(
         if not pd.api.types.is_datetime64tz_dtype(tpls[col]):
             tpls[col] = _localize_timestamp(dt_series=tpls[col], pytz_tzinfo=tz, col_name=col)
 
-    assert tpls.as_triplegs
+    # assert validity of triplegs
+    tpls.as_triplegs
     return tpls
 
 
@@ -229,7 +232,8 @@ def read_trips_gpd(
         if not pd.api.types.is_datetime64tz_dtype(trips[col]):
             trips[col] = _localize_timestamp(dt_series=trips[col], pytz_tzinfo=tz, col_name=col)
 
-    assert trips.as_trips
+    # assert validity of trips
+    trips.as_trips
     return trips
 
 
@@ -271,7 +275,8 @@ def read_locations_gpd(gdf, user_id="user_id", center="center", mapper={}):
     locs = gdf.rename(columns=columns)
     locs = locs.set_geometry("center")
 
-    assert locs.as_locations
+    # assert validity of locations
+    locs.as_locations
     return locs
 
 
@@ -332,6 +337,6 @@ def read_tours_gpd(
     #     if not pd.api.types.is_datetime64tz_dtype(trs[col]):
     #         trs[col] = localize_timestamp(dt_series=trs[col], pytz_tzinfo=tz, col_name=col)
 
-    # assert trs.as_tours
+    # trs.as_tours
     # return trs
     pass

trackintel/io/postgis.py

@@ -35,7 +35,9 @@ def read_positionfixes_postgis(conn_string, table_name, geom_col="geom", *args,
         pfs = gpd.GeoDataFrame.from_postgis("SELECT * FROM %s" % table_name, conn, geom_col=geom_col, *args, **kwargs)
     finally:
         conn.close()
-    assert pfs.as_positionfixes
+
+    # assert validity of positionfixes
+    pfs.as_positionfixes
     return pfs
 
 
@@ -106,7 +108,9 @@ def read_triplegs_postgis(conn_string, table_name, geom_col="geom", *args, **kwa
         )
     finally:
         conn.close()
-    assert pfs.as_triplegs
+
+    # assert validity of triplegs
+    pfs.as_triplegs
     return pfs
 
 
@@ -150,7 +154,7 @@ def write_triplegs_postgis(
 
 
 def read_staypoints_postgis(conn_string, table_name, geom_col="geom", *args, **kwargs):
-    """Reads staypoints from a PostGIS database.
+    """Read staypoints from a PostGIS database.
 
     Parameters
     ----------
@@ -172,13 +176,15 @@ def read_staypoints_postgis(conn_string, table_name, geom_col="geom", *args, **k
     engine = create_engine(conn_string)
     conn = engine.connect()
     try:
-        pfs = gpd.GeoDataFrame.from_postgis(
+        stps = gpd.GeoDataFrame.from_postgis(
             "SELECT * FROM %s" % table_name, conn, geom_col=geom_col, index_col="id", *args, **kwargs
         )
     finally:
         conn.close()
-    assert pfs.as_staypoints
-    return pfs
+
+    # assert validity of staypoints
+    stps.as_staypoints
+    return stps
 
 
 def write_staypoints_postgis(staypoints, conn_string, table_name, schema=None, sql_chunksize=None, if_exists="fail"):
@@ -253,13 +259,14 @@ def read_locations_postgis(conn_string, table_name, geom_col="geom", *args, **kw
         )
     finally:
         conn.close()
-    assert locs.as_locations
+
+    # assert validity of locations
+    locs.as_locations
     return locs
 
 
 def write_locations_postgis(locations, conn_string, table_name, schema=None, sql_chunksize=None, if_exists="fail"):
-    """Stores locations to PostGIS. Usually, this is directly called on a locations
-    GeoDataFrame (see example below).
+    """Store locations to PostGIS. Usually, this is directly called on a locations GeoDataFrame (see example below).
 
     Parameters
     ----------
@@ -295,7 +302,7 @@ def write_locations_postgis(locations, conn_string, table_name, schema=None, sql
 
 
 def read_trips_postgis(conn_string, table_name, *args, **kwargs):
-    """Reads trips from a PostGIS database.
+    """Read trips from a PostGIS database.
 
     Parameters
     ----------
@@ -314,11 +321,13 @@ def read_trips_postgis(conn_string, table_name, *args, **kwargs):
     engine = create_engine(conn_string)
     conn = engine.connect()
     try:
-        trps = pd.read_sql("SELECT * FROM %s" % table_name, conn, index_col="id", *args, **kwargs)
+        trips = pd.read_sql("SELECT * FROM %s" % table_name, conn, index_col="id", *args, **kwargs)
     finally:
         conn.close()
-    assert trps.as_trips
-    return trps
+
+    # assert validity of trips
+    trips.as_trips
+    return trips
 
 
 def write_trips_postgis(trips, conn_string, table_name, schema=None, sql_chunksize=None, if_exists="fail"):

trackintel/preprocessing/positionfixes.py

@@ -364,8 +364,8 @@ def generate_triplegs(pfs_input, stps_input, method="between_staypoints", gap_th
         tpls = tpls.set_geometry("geom")
         tpls.crs = pfs.crs
 
-        # check the correctness of the generated tpls
-        assert tpls.as_triplegs
+        # assert validity of triplegs
+        tpls.as_triplegs
 
         if case == 2:
             pfs.drop(columns="staypoint_id", inplace=True)