ruff

Author: wdm0006

examples/cache_management.py

@@ -19,69 +19,69 @@ def demonstrate_cache_timestamps():
     """Demonstrate accessing cache timestamp information."""
     print("Cache Timestamp Information Demo")
     print("=" * 40)
-    
+
     # Create a repository with a cache backend
     cache = EphemeralCache(max_keys=100)
-    repo = Repository(working_dir=GIT_PANDAS_DIR, cache_backend=cache, default_branch='master')
-    
+    repo = Repository(working_dir=GIT_PANDAS_DIR, cache_backend=cache, default_branch="master")
+
     print(f"Repository: {repo.repo_name}")
     print(f"Cache backend: {type(cache).__name__}")
     print()
-    
+
     # Call some methods to populate the cache
     print("Populating cache with repository data...")
-    
+
     print("  - Getting commit history...")
-    commit_history = repo.commit_history(limit=10)
-    
+    repo.commit_history(limit=10)
+
     print("  - Getting file list...")
-    files = repo.list_files()
-    
+    repo.list_files()
+
     print("  - Getting blame information...")
-    blame = repo.blame()
-    
+    repo.blame()
+
     print(f"Cache now contains {len(cache._cache)} entries")
     print()
-    
+
     # Show cache information
     print("Cache Contents and Timestamps:")
     print("-" * 40)
-    
+
     cached_keys = cache.list_cached_keys()
     for entry in cached_keys:
         print(f"Key: {entry['key']}")
         print(f"  Cached at: {entry['cached_at'].strftime('%Y-%m-%d %H:%M:%S UTC')}")
         print(f"  Age: {entry['age_seconds']:.1f} seconds")
         print()
-    
+
     # Wait a moment and call one method again
     print("Waiting 2 seconds and refreshing commit history...")
     time.sleep(2)
-    
+
     # This should hit the cache
-    commit_history_cached = repo.commit_history(limit=10)
-    
+    repo.commit_history(limit=10)
+
     # This should create a new cache entry
-    commit_history_fresh = repo.commit_history(limit=20)
-    
+    repo.commit_history(limit=20)
+
     print("\nUpdated cache contents:")
     print("-" * 40)
-    
+
     cached_keys = cache.list_cached_keys()
     for entry in cached_keys:
         print(f"Key: {entry['key']}")
         print(f"  Cached at: {entry['cached_at'].strftime('%Y-%m-%d %H:%M:%S UTC')}")
         print(f"  Age: {entry['age_seconds']:.1f} seconds")
         print()
-    
+
     # Demonstrate getting specific cache info
     print("Getting specific cache information:")
     print("-" * 40)
-    
+
     # Find a commit_history cache key
-    commit_keys = [k for k in cached_keys if 'commit_history' in k['key']]
+    commit_keys = [k for k in cached_keys if "commit_history" in k["key"]]
     if commit_keys:
-        key = commit_keys[0]['key']
+        key = commit_keys[0]["key"]
         info = cache.get_cache_info(key)
         if info:
             print(f"Cache info for key '{key}':")
@@ -95,44 +95,43 @@ def demonstrate_disk_cache_persistence():
     print("\n" + "=" * 50)
     print("Disk Cache Persistence Demo")
     print("=" * 50)
-    
+
     cache_file = "/tmp/gitpandas_demo_cache.gz"
-    
+
     # Clean up any existing cache file
     if os.path.exists(cache_file):
         os.remove(cache_file)
-    
+
     print("Creating repository with DiskCache...")
     cache = DiskCache(filepath=cache_file, max_keys=50)
-    repo = Repository(working_dir=GIT_PANDAS_DIR, cache_backend=cache, default_branch='master')
-    
+    repo = Repository(working_dir=GIT_PANDAS_DIR, cache_backend=cache, default_branch="master")
+
     # Populate cache
     print("Populating cache...")
-    commit_history = repo.commit_history(limit=5)
-    files = repo.list_files()
-    
+    repo.commit_history(limit=5)
+    repo.list_files()
+
     print(f"Cache file created: {cache_file}")
     print(f"Cache contains {len(cache._cache)} entries")
-    
+
     # Show initial cache info
     cached_keys = cache.list_cached_keys()
     print("\nInitial cache entries:")
     for entry in cached_keys:
         print(f"  {entry['key']}: {entry['cached_at'].strftime('%H:%M:%S')}")
-    
+
     # Create a new cache instance from the same file
     print("\nCreating new cache instance from saved file...")
     cache2 = DiskCache(filepath=cache_file, max_keys=50)
-    
+
     print(f"Loaded cache contains {len(cache2._cache)} entries")
-    
+
     # Show loaded cache info
     cached_keys2 = cache2.list_cached_keys()
     print("\nLoaded cache entries:")
     for entry in cached_keys2:
-        print(f"  {entry['key']}: {entry['cached_at'].strftime('%H:%M:%S')} "
-              f"(age: {entry['age_seconds']:.1f}s)")
-    
+        print(f"  {entry['key']}: {entry['cached_at'].strftime('%H:%M:%S')} (age: {entry['age_seconds']:.1f}s)")
+
     # Clean up
     if os.path.exists(cache_file):
         os.remove(cache_file)
@@ -144,29 +143,29 @@ def demonstrate_cache_with_force_refresh():
     print("\n" + "=" * 50)
     print("Force Refresh Demo")
     print("=" * 50)
-    
+
     cache = EphemeralCache(max_keys=10)
-    repo = Repository(working_dir=GIT_PANDAS_DIR, cache_backend=cache, default_branch='master')
-    
+    repo = Repository(working_dir=GIT_PANDAS_DIR, cache_backend=cache, default_branch="master")
+
     print("Getting commit history (first time)...")
     start_time = datetime.now(timezone.utc)
-    commit_history1 = repo.commit_history(limit=5)
-    
+    repo.commit_history(limit=5)
+
     time.sleep(1)
-    
+
     print("Getting commit history (should use cache)...")
-    commit_history2 = repo.commit_history(limit=5)
-    
+    repo.commit_history(limit=5)
+
     time.sleep(1)
-    
+
     print("Getting commit history with force_refresh=True...")
-    commit_history3 = repo.commit_history(limit=5, force_refresh=True)
-    
+    repo.commit_history(limit=5, force_refresh=True)
+
     print("\nCache timeline:")
     cached_keys = cache.list_cached_keys()
     for entry in cached_keys:
-        if 'commit_history' in entry['key']:
-            age_from_start = (entry['cached_at'] - start_time).total_seconds()
+        if "commit_history" in entry["key"]:
+            age_from_start = (entry["cached_at"] - start_time).total_seconds()
             print(f"  Commit history cached at: +{age_from_start:.1f}s from start")
             print(f"  Current age: {entry['age_seconds']:.1f}s")
 
@@ -176,15 +175,15 @@ def demonstrate_cache_with_force_refresh():
         demonstrate_cache_timestamps()
         demonstrate_disk_cache_persistence()
         demonstrate_cache_with_force_refresh()
-        
+
         print("\n" + "=" * 50)
         print("Summary:")
         print("- Cache backends now track when entries were created")
         print("- No changes to Repository or ProjectDirectory API")
         print("- Users can access cache info via cache_backend.get_cache_info()")
         print("- Users can list all cached keys via cache_backend.list_cached_keys()")
         print("- Backward compatibility maintained with existing caches")
-        
+
     except Exception as e:
         print(f"Error running demo: {e}")
-        print("Make sure you're running this from the git-pandas directory") 
+        print("Make sure you're running this from the git-pandas directory")

examples/cache_timestamps.py

@@ -5,6 +5,7 @@
 """
 
 import pandas as pd
+
 from gitpandas import Repository
 
 # --- Instantiate Repository ---
@@ -22,7 +23,7 @@
     print(f"Cloned to temporary directory: {repo.git_dir}")
 except Exception as e:
     print(f"Error instantiating repository: {e}")
-    repo = None # Ensure repo is None if instantiation fails
+    repo = None  # Ensure repo is None if instantiation fails
 
 # --- Call release_tag_summary ---
 if repo:
@@ -46,20 +47,20 @@
             print(release_summary_df)
 
             # Example of how to access specific information:
-            if 'tag' in release_summary_df.columns and len(release_summary_df) > 1:
+            if "tag" in release_summary_df.columns and len(release_summary_df) > 1:
                 # Show files changed between the first two listed tags (if available)
                 # Note: The first tag in the summary won't have "previous tag" data.
-                second_tag_entry = release_summary_df.iloc[1] # Second tag in the sorted list
+                second_tag_entry = release_summary_df.iloc[1]  # Second tag in the sorted list
                 print(f"\nExample: Files changed for tag '{second_tag_entry['tag']}' (since previous tag):")
-                if isinstance(second_tag_entry['files'], list) and second_tag_entry['files']:
-                    for file_path in second_tag_entry['files']:
+                if isinstance(second_tag_entry["files"], list) and second_tag_entry["files"]:
+                    for file_path in second_tag_entry["files"]:
                         print(f"  - {file_path}")
                 else:
                     print("  No files listed or files column is not a list.")
 
-        elif release_summary_df is not None: # Empty DataFrame
+        elif release_summary_df is not None:  # Empty DataFrame
             print("No release summary data returned. The repository might not have tags, or no tags match the glob.")
-        else: # None was returned, indicating an issue
+        else:  # None was returned, indicating an issue
             print("Failed to retrieve release summary (method returned None).")
 
     except Exception as e:
@@ -77,34 +78,38 @@
     # As this is a brief example, we'll try to pick one from the summary if possible,
     # otherwise, we'll use a placeholder.
     target_commit_sha = None
-    if 'release_summary_df' in locals() and not release_summary_df.empty and 'commit_sha' in release_summary_df.columns:
+    if "release_summary_df" in locals() and not release_summary_df.empty and "commit_sha" in release_summary_df.columns:
         # Let's try to get the commit SHA of the first tag listed (if any)
         # This commit is what the tag points to.
-        potential_sha = release_summary_df['commit_sha'].iloc[0]
-        if pd.notna(potential_sha): # Check if the SHA is not NaN or None
+        potential_sha = release_summary_df["commit_sha"].iloc[0]
+        if pd.notna(potential_sha):  # Check if the SHA is not NaN or None
             target_commit_sha = potential_sha
             print(f"Attempting to get content for commit SHA (from first tag's commit_sha): {target_commit_sha}")
         else:
             print("Could not get a valid commit SHA from the release_summary_df's first entry.")
-            
+
     if not target_commit_sha:
-        target_commit_sha = "PLACEHOLDER_COMMIT_SHA" # Replace with an actual commit SHA from the repo
+        target_commit_sha = "PLACEHOLDER_COMMIT_SHA"  # Replace with an actual commit SHA from the repo
         print(f"Using placeholder commit SHA: {target_commit_sha}. Replace with a real one for actual output.")
 
     if target_commit_sha != "PLACEHOLDER_COMMIT_SHA":
         try:
             # The 'rev' parameter takes the commit SHA.
             commit_content_df = repo.get_commit_content(rev=target_commit_sha)
-            
+
             if commit_content_df is not None and not commit_content_df.empty:
                 print(f"Content changes for commit {target_commit_sha} (showing first 5 lines):")
                 # Displaying only a part of the DataFrame for brevity.
                 # Columns typically include: 'file_path', 'change_type', 'diff', 'old_blob_sha', 'new_blob_sha'
                 print(commit_content_df.head())
-            elif commit_content_df is not None: # Empty DataFrame
-                print(f"No content changes (e.g. diffs) found for commit {target_commit_sha}. This can be normal for merge commits with no textual changes, or if the commit only modified tree structure.")
-            else: # None was returned
-                print(f"Failed to get content for commit {target_commit_sha} (method returned None). Could be an invalid SHA or repository issue.")
+            elif commit_content_df is not None:  # Empty DataFrame
+                print(
+                    f"No content changes (e.g. diffs) found for commit {target_commit_sha}. This can be normal for merge commits with no textual changes, or if the commit only modified tree structure."
+                )
+            else:  # None was returned
+                print(
+                    f"Failed to get content for commit {target_commit_sha} (method returned None). Could be an invalid SHA or repository issue."
+                )
         except Exception as e:
             print(f"Error calling get_commit_content for {target_commit_sha}: {e}")
     else: