Spaces:
Sleeping
Sleeping
File size: 14,276 Bytes
463fc7e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 | """
Git Repository Crawler - Intelligent repository cloning and file listing system.
This module serves as the entry point for ingesting Git repositories into our
dataset pipeline. It handles cloning, file listing, metadata extraction, and
statistics generation with multiple strategies for different use cases.
ARCHITECTURE POSITION:
- Ingestion Layer: Entry point for Git repositories
- File Discovery: Finds and filters repository files
- Metadata Collector: Gathers repo-level information
KEY FEATURES:
1. Multi-strategy file listing (fast/rich/smart)
2. Intelligent binary detection and filtering
3. Repository metadata extraction with git history
4. Agentic framework detection (through RepoMetadataExtractor)
5. Repository statistics and cleanup utilities
DATA FLOW:
Repository URL → Clone → File Discovery → Filtering → File Info/Metadata → Output
USE CASES:
- FAST: When only file paths are needed (performance-critical)
- RICH: When full metadata is required (dataset building)
- SMART: Auto-chooses based on needs (balanced approach)
USAGE:
crawler = GitCrawler()
repo_path = crawler.clone_repository("https://github.com/org/repo.git")
files_fast = crawler.list_files_fast(repo_path, extensions={'.py'})
files_rich, stats = crawler.list_files_with_info(repo_path)
"""
import subprocess
from pathlib import Path
from typing import List, Optional, Set, Dict, Tuple, Union, cast
import os
from dataclasses import dataclass
import time
from .repo_metadata import RepoMetadataExtractor
@dataclass
class RepoFileInfo:
"""Lightweight file info - optional for when you need it"""
path: Path
relative_path: str
size: int = 0
extension: str = ""
is_binary: Optional[bool] = None
class GitCrawler:
"""
Optimized Git crawler with fast listing + optional rich info
"""
def __init__(self, cache_dir: Path = Path("data/raw/repos")):
self.cache_dir = cache_dir
self.cache_dir.mkdir(parents=True, exist_ok=True)
# -------- CORE: Cloning (same for both) --------
def clone_repository(self, repo_url: str) -> Optional[Path]:
"""Clone a repository if not already cloned"""
repo_name = self._extract_repo_name(repo_url)
repo_path = self.cache_dir / repo_name
if repo_path.exists():
print(f"Repository already exists: {repo_path}")
return repo_path
print(f"Cloning {repo_url}...")
cmd = ["git", "clone", "--depth", "1", repo_url, str(repo_path)]
try:
start_time = time.time()
result = subprocess.run(cmd, check=True, capture_output=True, text=True)
elapsed = time.time() - start_time
print(f"Cloned to {repo_path} ({elapsed:.1f}s)")
return repo_path
except subprocess.CalledProcessError as e:
print(f"Failed to clone {repo_url}: {e.stderr}")
return None
def extract_enhanced_metadata(self, repo_path: Path) -> Dict:
"""
Extract enhanced metadata including agentic framework detection
"""
extractor = RepoMetadataExtractor(repo_path)
return extractor.extract_comprehensive_metadata()
# -------- OPTION 1: FAST listing (old style) --------
def list_files_fast(self, repo_path: Path,
extensions: Optional[Set[str]] = None,
exclude_dirs: Optional[Set[str]] = None) -> List[Path]:
"""
FAST file listing - returns just Path objects
Use when you need speed and don't need metadata
"""
if exclude_dirs is None:
exclude_dirs = {'.git', '__pycache__', 'node_modules',
'build', 'dist', '.venv', 'venv'}
files = []
for root, dirs, filenames in os.walk(repo_path):
# Filter directories
dirs[:] = [d for d in dirs if d not in exclude_dirs and not d.startswith('.')]
for filename in filenames:
if filename.startswith('.'):
continue
file_path = Path(root) / filename
# Filter by extension if specified
if extensions:
if file_path.suffix.lower() in extensions:
files.append(file_path)
else:
files.append(file_path)
return sorted(files) # Sort for consistency
# -------- OPTION 2: RICH listing with metadata --------
def list_files_with_info(self, repo_path: Path,
extensions: Optional[Set[str]] = None,
exclude_dirs: Optional[Set[str]] = None,
skip_binary: bool = True) -> Tuple[List[RepoFileInfo], Dict]:
"""
RICH file listing - returns file info + statistics
Use when you need metadata for better chunking
"""
if exclude_dirs is None:
exclude_dirs = {'.git', '__pycache__', 'node_modules',
'build', 'dist', '.venv', 'venv', '.env'}
file_infos = []
stats = {
"total_files": 0,
"total_size": 0,
"by_extension": {},
"binary_files": 0,
"text_files": 0
}
for root, dirs, filenames in os.walk(repo_path):
# Filter directories
dirs[:] = [d for d in dirs if d not in exclude_dirs and not d.startswith('.')]
for filename in filenames:
if filename.startswith('.'):
continue
file_path = Path(root) / filename
relative_path = file_path.relative_to(repo_path)
extension = file_path.suffix.lower()
# Filter by extension
if extensions and extension not in extensions:
continue
try:
size = file_path.stat().st_size
is_binary = None
# Check if binary (only when needed)
if skip_binary:
is_binary = self._is_binary_file(file_path)
if is_binary:
stats["binary_files"] += 1
continue # Skip binary files
else:
stats["text_files"] += 1
# Create file info
file_info = RepoFileInfo(
path=file_path,
relative_path=str(relative_path),
size=size,
extension=extension,
is_binary=is_binary
)
file_infos.append(file_info)
# Update stats
stats["total_files"] += 1
stats["total_size"] += size
stats["by_extension"][extension] = stats["by_extension"].get(extension, 0) + 1
except (OSError, PermissionError) as e:
print(f"[WARNING] Could not read {file_path}: {e}")
continue
# Sort by relative path
file_infos.sort(key=lambda x: x.relative_path)
return file_infos, stats
# -------- OPTION 3: SMART listing (auto-chooses) --------
def list_files(self, repo_path: Path,
extensions: Optional[Set[str]] = None,
exclude_dirs: Optional[Set[str]] = None,
rich_metadata: bool = False,
skip_binary: bool = True) -> Union[List[Path], Tuple[List[RepoFileInfo], Dict]]:
"""
SMART file listing - chooses method based on needs
Args:
rich_metadata: True for RepoFileInfo + stats, False for just Paths
skip_binary: Skip binary files (only when rich_metadata=True)
"""
if rich_metadata:
return self.list_files_with_info(repo_path, extensions, exclude_dirs, skip_binary)
else:
return self.list_files_fast(repo_path, extensions, exclude_dirs)
# -------- HELPER: Get README --------
def get_readme_content(self, repo_path: Path) -> Optional[str]:
"""Quickly get README content if exists"""
for pattern in ['README.md', 'README.rst', 'README.txt', 'README', 'readme.md']:
readme_path = repo_path / pattern
if readme_path.exists():
try:
return readme_path.read_text(encoding='utf-8', errors='ignore')[:5000] # First 5k chars
except:
continue
return None
# -------- HELPER: Get repository stats --------
def get_repo_stats(self, repo_path: Path) -> Dict:
"""ACCURATE repository statistics (excludes .git)"""
try:
total_files = 0
total_size = 0
extensions = set()
for root, dirs, files in os.walk(repo_path):
# ✅ PROPERLY skip .git directory
root_path = Path(root)
if '.git' in root_path.parts:
continue # Skip entire .git directory
total_files += len(files)
for file in files:
file_path = Path(root) / file
try:
size = file_path.stat().st_size
total_size += size
if file_path.suffix:
extensions.add(file_path.suffix.lower())
except:
pass
return {
"total_files": total_files,
"total_size_mb": round(total_size / (1024 * 1024), 2),
"unique_extensions": sorted(list(extensions))[:20],
"path": str(repo_path),
"name": repo_path.name,
"note": "Size excludes .git directory" # ✅ Add note
}
except Exception as e:
return {"error": str(e)}
# -------- UTILITY METHODS --------
def _extract_repo_name(self, repo_url: str) -> str:
"""Extract repository name from URL"""
name = repo_url.rstrip('/').split('/')[-1]
if name.endswith('.git'):
name = name[:-4]
return name
def _is_binary_file(self, file_path: Path, sample_size: int = 1024) -> bool:
"""Quick binary detection by sampling"""
try:
with open(file_path, 'rb') as f:
sample = f.read(sample_size)
if not sample:
return False
# Check for null bytes (common in binaries)
if b'\x00' in sample:
return True
# Count printable ASCII
printable = sum(1 for byte in sample if 32 <= byte <= 126 or byte in (9, 10, 13))
return (printable / len(sample)) < 0.8 # Less than 80% printable
except:
return True # If we can't read, assume binary
def cleanup_old_repos(self, max_age_days: int = 7):
"""Cleanup old cached repositories (optional)"""
import shutil
from datetime import datetime, timedelta
cutoff = datetime.now() - timedelta(days=max_age_days)
for repo_dir in self.cache_dir.iterdir():
if repo_dir.is_dir():
try:
mtime = datetime.fromtimestamp(repo_dir.stat().st_mtime)
if mtime < cutoff:
print(f"🧹 Cleaning up old repo: {repo_dir.name}")
shutil.rmtree(repo_dir)
except:
pass
# -------- SIMPLE USAGE EXAMPLES --------
def example_usage():
"""Example of how to use the crawler - FIXED VERSION"""
crawler = GitCrawler()
# 1. Clone a repository
repo_path = crawler.clone_repository("https://github.com/microsoft/autogen.git")
if not repo_path:
print("❌ Failed to clone repository")
return
# 2. OPTION A: Fast listing (just paths)
print("\n=== FAST LISTING ===")
python_files = crawler.list_files_fast(repo_path, extensions={'.py'})
print(f"Found {len(python_files)} Python files")
# 3. OPTION B: Rich listing with metadata
print("\n=== RICH LISTING ===")
file_infos, stats = crawler.list_files_with_info(
repo_path,
extensions={'.py', '.md', '.json', '.yaml'},
skip_binary=True
)
print(f"Total files: {stats['total_files']}")
print(f"Total size: {stats['total_size'] / 1024 / 1024:.2f} MB")
print(f"Extensions: {stats['by_extension']}")
# 4. OPTION C: Smart listing (auto) - FIXED
print("\n=== SMART LISTING ===")
# Returns just paths (fast)
files_fast = crawler.list_files(repo_path, extensions={'.py'}, rich_metadata=False)
# Type check for PyLance
if isinstance(files_fast, list):
print(f"Fast count: {len(files_fast)}")
else:
# This shouldn't happen with rich_metadata=False
print("Unexpected return type from list_files()")
# Returns info + stats (rich) - FIXED
result = crawler.list_files(repo_path, extensions={'.py'}, rich_metadata=True)
if isinstance(result, tuple):
files_rich, stats = result
print(f"Rich count: {len(files_rich)}")
else:
# This shouldn't happen with rich_metadata=True
print("Unexpected return type from list_files()")
# 5. Get README
readme = crawler.get_readme_content(repo_path)
if readme:
print(f"\nREADME preview: {readme[:200]}...")
# 6. Get repo stats
repo_stats = crawler.get_repo_stats(repo_path)
print(f"\nRepository stats: {repo_stats}")
if __name__ == "__main__":
example_usage()
|