crossbario / autobahn-python

WebSocket and WAMP in Python for Twisted and asyncio
https://crossbar.io/autobahn
MIT License
2.48k stars 766 forks source link

Statement rgd API and feature stability for 1.0 #313

Closed oberstet closed 6 years ago

oberstet commented 9 years ago

We need to have a clear statement regarding what's the public API and featureset that we strive to support long-term (after 1.0).

oberstet commented 9 years ago

We probably should follow http://semver.org/ at least after 1.0

oberstet commented 9 years ago

I think we should do semver. This requires a definition of "public API" first.

In a way, we have that already:

But this doesn't cover

oberstet commented 9 years ago

We should look at these issues at least:

oberstet commented 9 years ago

We don't have a consolidated list of API which is supposed to be "public and supported".

Well, we do have:

but this isn't exhaustive.

oberstet commented 9 years ago

another thing I am unhappy with is https://github.com/tavendo/AutobahnPython/blob/master/autobahn/websocket/protocol.py#L3557 and even https://github.com/tavendo/AutobahnPython/blob/master/autobahn/websocket/protocol.py#L1097

oberstet commented 9 years ago

https://github.com/tavendo/AutobahnPython/blob/master/autobahn/websocket/interfaces.py#L107 is limiting: it should have been def on_message(msg) where msg is a struct like thing.

oberstet commented 9 years ago

Also, the logging should be sanitized, and more importantly, parameters like debug_wamp=False should go away.

oberstet commented 6 years ago

subseded/fixed in https://github.com/crossbario/autobahn-python/issues/964