refactor: Add emitter event types and fix mypy

[ajbozarth]

Which issue(s) does this pull-request address?

Ref #415
Ref #433

Description

This include both the first part of typing the emitter event emits and addressing mypy:

Event Type work includes

• Adds types for each event in a events.py file for each submodule
• Updates emitter to take in and store an optional events dict that defines the expected events for that emitter. This events dict can be dynamically updated by users as needed
• Adds a event_data key to EventMeta that contains the data type for the event
• Add a events dict to each emitter instance with it's correct events and data types
• Update all internal event names to use underscores not camelCase
• Reintroduce regex support in emitter match

Event Types work TODOs

• Update internal emits to return the new event classes instead of dicts
• Update examples and tests to handle new event types
• Update docs

MyPy updates

• mypy passes on everything in beeai_framework/ except for beeai_framework/adapters and beeai_framework/memory
• I had to add ignore lines in a few places where fixing the mypy warn would change how the code works
• Most updates deal with adding type hints or type params for generics
• Updated the generic names in Tool to match TS
• Added AnyTool, AnyAgent and AnyMessage
• created types.py for the backend, tools, and workflows submodules and move the relevant classes into those files

Checklist

General

• I have read the appropriate contributor guide: Python
  / TypeScript
• I have signed off on my commit: Python instructions / TypeScript instructions
• Commit messages and PR title follow conventional commits
• Appropriate label(s) added to PR: Python for Python changes, TypeScript for TypeScript changes

Code quality checks

• Linting passes: Python poe lint or poe lint --fix / TypeScript yarn lint or yarn lint:fix
• Formatting is applied: Python poe format or poe format --fix / TypeScript: yarn format or yarn format:fix
• Static type checks pass: Python poe type-check

Testing

• Unit tests pass: Python poe test --type unit / TypeScript yarn test:unit
• E2E tests pass: Python poe test --type e2e / TypeScript: yarn test:e2e
• Integration tests pass: Python poe test --type integration
• Tests are included (for bug fixes or new features)

Documentation

• Documentation is updated
• Embedme embeds code examples in docs. To update after edits, run: Python poe docs --type build

[ajbozarth]

While working #415 I started addressing a lot of mypy issues as they came and I found that the majority of my changes had become mypy fixes. As such I decided to push what I have at this point since my event types work done so far is currently backwards compatible and could be merged as is.

My next step is to start updating the actual emit call to return the typed data objects rather than dicts and to update any code that listens on those objects. This step will be the breaking change. I will continue work on this branch unless we decide to merge it as is and I'll continue my work in a follow up PR

[ajbozarth]

Inspired by my review of #551 I updated some more mypy and added AnyTool as in #551 and well as AnyAgent

[Tomas2D]

• I would consider extracting event classes to events.py per submodule if possible.
• Message[Any] could be replaced with a type alias AnyMessage
• Changing event names is a breaking change -> should be documented (mentioned somewhere).

[ajbozarth]

Followup tasks from review:

• extracting event classes to events.py per submodule
• You can set default events in base _create_emitter method, but user should be able to extend them (not overwrite)

[ajbozarth]

I've pushed the updates addressing the review items I did not mention in my above comment to handle in a followup

[ajbozarth]

While waiting for review I took a stab at "extracting event classes to events.py per submodule" but hit an issue. It was actually tribal to do so for agents, but for chat, tool, and workflow it causes circular inputs due to the lack of type.py files in those submodules to hold the common types.

I can create a types.py file for backend, tools, and workflows if that's what we want though @Tomas2D

[ajbozarth]

I was also able to address users extending emitter events dict rather than overwriting it, so no more followup PR work from review remaining

[ajbozarth]

So after some work leveraging PyCharm's "Refactor > Move File" feature I created the types.py file for backend/, tools/, and workflows/ which then allowed me to also create events.py for those submodules as well. Make this fully address al previous review

[ajbozarth]

FYI I've enabled auto-merge with the requested merge commit message (BREAKING CHANGE)

[Tomas2D]

Well done. I like it, just the one event name and feel free to merge.