Add base module type stubs

[joamag]

Summary

• add Python stub files for agent, container, observer, poll, service, stream and util modules

Testing

• black .
• pytest -q

---

https://chatgpt.com/codex/tasks/task_e_6845c99064488328bb41065c4cffb391

Summary by CodeRabbit

• New Features

  • Introduced enhanced type hinting and interface definitions for core networking, threading, event handling, and utility components.
  • Added type stub support for client, server, container, service, stream, polling, and observer classes, improving static analysis and IDE autocompletion.
  • Included typed utility functions for string formatting and condition verification.
  • Added automated stub testing to ensure type consistency across multiple modules.

• Documentation

  • Provided comprehensive type annotations for public interfaces, aiding in code clarity and maintainability.

[coderabbitai[bot]]

Walkthrough

This update introduces a comprehensive set of Python type stub (.pyi) files for the netius.base module. These stubs provide type annotations and interface specifications for classes and functions related to networking, event loops, threading, polling, containers, servers, services, streams, observables, and utility functions, enabling static type checking and improved IDE support.

Changes

File(s)	Change Summary
src/netius/base/agent.pyi	Added type stubs for Agent, ClientAgent, and ServerAgent classes, including methods and class attributes.
src/netius/base/client.pyi	Added type stubs for Client and DatagramClient classes, with constructors, class methods, and instance methods.
src/netius/base/common.pyi	Added type stubs for threading/event loop utilities, including BaseThread and multiple loop/control functions.
src/netius/base/container.pyi	Added type stubs for Container and ContainerServer classes, with attributes and lifecycle/management methods.
src/netius/base/observer.pyi	Added type stubs for Observable class with event management methods and attributes.
src/netius/base/poll.pyi	Added type stubs for polling abstraction: Poll, EpollPoll, KqueuePoll, PollPoll, SelectPoll.
src/netius/base/server.pyi	Added type stubs for Server and DatagramServer classes, with network/SSL attributes and methods.
src/netius/base/service.pyi	Added type stubs for Service class, including network attributes and event handler method.
src/netius/base/stream.pyi	Added type stubs for Stream class, status constants, and state/info methods.
src/netius/base/util.pyi	Added type stubs for utility functions: camel_to_underscore and verify.
src/netius/test/base/stubs.py	Added StubsTest class with methods to run mypy.stubtest on netius.base modules for stub validation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant TypeChecker

    User->>API: Imports or uses netius.base components
    API->>TypeChecker: Provides .pyi stubs for static analysis
    TypeChecker-->>User: Reports type errors, autocompletion, and interface info

Poem

In the warren of code, type stubs appear,
With signatures clear, the future is here!
Rabbits can hop from class to class,
Knowing each method, nothing to pass.
With static checks and hints so bright,
Our burrow of code is typed just right!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 222aae35670bded62d76133fefb57554c0313542 and 13ec28958e7e390270fb6e1d0bf9f91c78cd3ecd.

📒 Files selected for processing (1)

• src/netius/test/base/stubs.py (1 hunks)

🧰 Additional context used

🪛 Pylint (3.3.7)

src/netius/test/base/stubs.py

[refactor] 1-1: Useless option value for '--disable', 'C0326' was removed from pylint, see https://github.com/pylint-dev/pylint/pull/3577.

(R0022)

---

[refactor] 1-1: Useless option value for '--disable', 'C0330' was removed from pylint, see https://github.com/pylint-dev/pylint/pull/3571.

(R0022)

🔇 Additional comments (3)

src/netius/test/base/stubs.py (3)

1-35: LGTM! Standard header and imports are correct.

The file header, license information, and imports are properly structured and appropriate for the test functionality.

🧰 Tools

🪛 Pylint (3.3.7)

[refactor] 1-1: Useless option value for '--disable', 'C0326' was removed from pylint, see https://github.com/pylint-dev/pylint/pull/3577.

(R0022)

---

[refactor] 1-1: Useless option value for '--disable', 'C0330' was removed from pylint, see https://github.com/pylint-dev/pylint/pull/3571.

(R0022)

---

37-49: LGTM! Module list is comprehensive and well-organized.

The MODULES list covers all the key netius.base components and follows a logical alphabetical ordering.

---

70-74: LGTM! Test method correctly handles mypy availability.

The test method properly checks for mypy.stubtest availability using importlib.util.find_spec() and gracefully skips the test if not found. The iteration over all modules is implemented correctly.

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.