Add comprehensive docstrings to explain code functionality

[Copilot]

Added Python docstrings throughout the codebase to explain functionality of classes, methods, and utilities.

Changes

• Module-level: Overview of OneShot's architecture, components, and purpose (989 chars)
• Classes (7/7): NetworkAddress, WPSpin, PixiewpsData, ConnectionStatus, BruteforceStatus, Companion, WiFiScanner
• Methods (30+): Key operations including PIN generation, WPA supplicant communication, network scanning, attack coordination
• Utilities (4/4): recvuntil, get_hex, ifaceUp, die

All docstrings follow PEP 257 with structured Args/Returns/Raises sections.

Example

import oneshot

# Module now self-documents
print(oneshot.__doc__)
# "OneShot - WiFi WPS Penetration Testing Tool
#  This module implements a comprehensive WPS penetration testing tool..."

# Classes explain their purpose and usage
print(oneshot.WPSpin.__doc__)
# "WPS PIN generator supporting 30+ different algorithms.
#  Generates PINs using MAC-based algorithms (24-bit, 28-bit, 32-bit),
#  vendor-specific algorithms (D-Link, ASUS, Broadcom, Realtek, etc.)..."

# Methods document parameters and return values
print(oneshot.WPSpin.generate.__doc__)
# "Generate a WPS PIN using the specified algorithm.
#  Args: algo (str): Algorithm ID, mac (str or NetworkAddress): MAC address
#  Returns: str: Generated 8-digit WPS PIN..."

Stats: +400 lines documentation, 0 functional changes, 0 CodeQL alerts

Original prompt

explain

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.