refactor: remove lazy-loader dependency and simplify imports (#32)

- Removed the lazy-loader dependency from environment.yml and setup.py
- Simplified the import statements in pandas_flavor/init.py by directly importing the required methods
- Updated the all variable in pandas_flavor/init.py to include the imported methods
- Cleaned up setup.py by removing unnecessary comments and adding docstrings to methods
- Add docstrings to bring up docstring coverage
- Update repo with darglint configuration file

Author: ericmjl

.darglint

@@ -0,0 +1,2 @@
+[darglint]
+docstring_style=google

docs/tracing_ext-demo.py

@@ -1,46 +1,105 @@
+"""Tracing extension demo."""
+import time
+
 import pandas as pd
+
 import pandas_flavor as pf
-import time
 
 
 @pf.register_dataframe_method
 def my_method(df: pd.DataFrame) -> pd.DataFrame:
+    """Transpose the DataFrame.
+
+    Args:
+        df: The DataFrame to transpose.
+
+    Returns:
+        The transposed DataFrame.
+    """
     print("my_method called")
     return df.transpose()
 
 
 @pf.register_dataframe_method
 def another_method(df: pd.DataFrame, new_col_d) -> pd.DataFrame:
+    """Adds a new column to the DataFrame.
+
+    Args:
+        df (DataFrame): The DataFrame to add the column to.
+        new_col_d (dict): A dictionary of column names and values.
+
+    Returns:
+        DataFrame: The DataFrame with the new column.
+    """
     print("another_method called")
     for col, v in new_col_d.items():
         df[col] = v
     return df
 
 
 class tracer:
+    """A simple tracer for method calls."""
+
     @staticmethod
     def create_tracer(*args):
+        """Creates a tracer.
+
+        Args:
+            *args: Variable length argument list for the tracer.
+
+        Returns:
+            The created tracer.
+        """
         return tracer()
 
     def __init__(self):
+        """Initialize the tracer."""
         self.method_name = None
         self.start_ts = None
         self.end_ts = None
 
     def __enter__(self):
+        """Enter the tracer.
+
+        Returns:
+            The tracer.
+        """
         return self
 
     def handle_start_method_call(
         self, method_name, method_signature, method_args, method_kwagrs
     ):
+        """Handle the start of a method call.
+
+        Args:
+            method_name: The name of the method.
+            method_signature: The signature of the method.
+            method_args: The arguments of the method.
+            method_kwagrs: The keyword arguments of the method.
+
+        Returns:
+            The arguments and keyword arguments of the method.
+        """
         self.method_name = method_name
         self.start_ts = time.time()
         return method_args, method_kwagrs
 
     def handle_end_method_call(self, ret):
+        """Handle the end of a method call.
+
+        Args:
+            ret: The return value of the method.
+        """
         self.end_ts = time.time()
 
     def __exit__(self, exc_type, value, traceback):
+        """Exit the tracer.
+
+        Args:
+            exc_type: The type of the exception.
+            value: The value of the exception.
+            traceback: The traceback of the exception.
+        """
         call_dur = self.end_ts - self.start_ts
         print(f"method {self.method_name} took {call_dur} secs to execute")
 

environment.yml

@@ -7,11 +7,10 @@ dependencies:
   - xarray
   - pip
   - pre-commit
-  - pytest  # for tests
+  - pytest # for tests
   - black # code formatting
   - twine # for uploading to PyPI
   - bump2version
   - build # for building package distributions
   - pip:
-      - lazy-loader
       - tuna

pandas_flavor/__init__.py

@@ -1,37 +1,20 @@
 """Top-level API for pandas-flavor."""
-import lazy_loader as lazy
-
-__getattr__, __dir__, __all__ = lazy.attach(
-    __name__,
-    submod_attrs={
-        "register": [
-            "register_series_method",
-            "register_series_accessor",
-            "register_dataframe_method",
-            "register_dataframe_accessor",
-        ],
-        "xarray": [
-            "register_xarray_dataarray_method",
-            "register_xarray_dataset_method",
-        ],
-    },
+from .register import (
+    register_dataframe_accessor,
+    register_dataframe_method,
+    register_series_accessor,
+    register_series_method,
+)
+from .xarray import (
+    register_xarray_dataarray_method,
+    register_xarray_dataset_method,
 )
-# from .register import (
-#     register_series_method,
-#     register_series_accessor,
-#     register_dataframe_method,
-#     register_dataframe_accessor,
-# )
-# from .xarray import (
-#     register_xarray_dataarray_method,
-#     register_xarray_dataset_method,
-# )
 
-# __all__ = [
-#     "register_series_method",
-#     "register_series_accessor",
-#     "register_dataframe_method",
-#     "register_dataframe_accessor",
-#     "register_xarray_dataarray_method",
-#     "register_xarray_dataset_method",
-# ]
+__all__ = [
+    "register_series_method",
+    "register_series_accessor",
+    "register_dataframe_method",
+    "register_dataframe_accessor",
+    "register_xarray_dataarray_method",
+    "register_xarray_dataset_method",
+]

pandas_flavor/register.py

@@ -1,3 +1,4 @@
+"""Register functions as methods of Pandas DataFrame and Series."""
 from functools import wraps
 from pandas.api.extensions import (
     register_series_accessor,
@@ -179,6 +180,16 @@ def register_series_method(method):
     method_signature = inspect.signature(method)
 
     def inner(*args, **kwargs):
+        """Inner function to register the method.
+
+        Args:
+            *args: The arguments to pass to the registered method.
+            **kwargs: The keyword arguments to pass to the registered method.
+
+        Returns:
+            method: The original method.
+        """
+
         class AccessorMethod(object):
             """Series Accessor method class."""
 

setup.py

@@ -1,9 +1,4 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-# Note: To use the 'upload' functionality of this file, you must:
-#   $ pip install twine
-
+"""Setup script."""
 import io
 import os
 import sys
@@ -19,7 +14,7 @@
 AUTHOR = "Zach Sailer"
 
 # What packages are required for this module to be executed?
-REQUIRED = ["pandas>=0.23", "xarray", "lazy-loader>=0.1"]
+REQUIRED = ["pandas>=0.23", "xarray"]
 
 # The rest you shouldn't have to touch too much :)
 # ------------------------------------------------
@@ -58,12 +53,15 @@ def status(s: str):
         print("\033[1m{0}\033[0m".format(s))
 
     def initialize_options(self):
+        """Initialize options."""
         pass
 
     def finalize_options(self):
+        """Finalize options."""
         pass
 
     def run(self):
+        """Build and publish the package."""
         try:
             self.status("Removing previous builds…")
             rmtree(os.path.join(here, "dist"))