Merge pull request #284 from markfairbanks/glimpse

Add `.glimpse()`

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## v0.3.2 (in development)
 
+#### New tibble methods
+
+* `.glimpse()`
+
 #### Functionality improvements
 
 * `pl.Null` is rexported as `tp.Null`

docs/reference.md

@@ -12,6 +12,7 @@
 * [`.drop()`](https://tidypolars.readthedocs.io/en/latest/autoapi/tidypolars/tibble/index.html#tidypolars.tibble_df.tibble.drop)
 * [`.head()`](https://tidypolars.readthedocs.io/en/latest/autoapi/tidypolars/tibble/index.html#tidypolars.tibble_df.tibble.head)
 * [`.filter()`](https://tidypolars.readthedocs.io/en/latest/autoapi/tidypolars/tibble/index.html#tidypolars.tibble_df.tibble.filter)
+* [`.glimpse()`](https://tidypolars.readthedocs.io/en/latest/autoapi/tidypolars/tibble/index.html#tidypolars.tibble_df.tibble.glimpse)
 * Joins
   * [`.full_join()`](https://tidypolars.readthedocs.io/en/latest/autoapi/tidypolars/tibble/index.html#tidypolars.tibble_df.tibble.full_join)
   * [`.inner_join()`](https://tidypolars.readthedocs.io/en/latest/autoapi/tidypolars/tibble/index.html#tidypolars.tibble_df.tibble.inner_join)

tidypolars/tibble_df.py

@@ -40,6 +40,7 @@ def __dir__(self):
             'arrange', 'as_dict', 'as_pandas', 'as_polars',
             'bind_cols', 'bind_rows', 'colnames', 'clone', 'count',
             'distinct', 'drop', 'drop_null', 'head', 'fill', 'filter',
+            'glimpse',
             'inner_join', 'left_join', 'mutate', 'names', 'nrow', 'ncol',
             'full_join', 'pivot_longer', 'pivot_wider',
             'print',
@@ -289,9 +290,14 @@ def equals(self, other, null_equal = True):
         other = other.as_polars()
         return df.equals(other, null_equal = null_equal)
 
-    def head(self, n = 5, *, _by = None):
-        """Alias for `.slice_head()`"""
-        return self.slice_head(n, _by = _by)
+    def glimpse(self):
+        """
+        Return a dense preview of the DataFrame.
+        
+        The formatting shows one line per column so that wide dataframes display cleanly. 
+        Each line shows the column name, the data type, and the first few values.
+        """
+        return self.as_polars().glimpse()
 
     def fill(self, *args, direction = 'down', _by = None):
         """
@@ -394,6 +400,10 @@ def full_join(self, df, left_on = None, right_on = None, on = None, suffix: str
             on = list(set(self.names) & set(df.names))
         out = super().join(df, on, "full", left_on = left_on, right_on = right_on, suffix = suffix, coalesce = True)
         return out.pipe(from_polars)
+
+    def head(self, n = 5, *, _by = None):
+        """Alias for `.slice_head()`"""
+        return self.slice_head(n, _by = _by)
 
     def inner_join(self, df, left_on = None, right_on = None, on = None, suffix = '_right'):
         """