Skip to content

Commit 9b3e622

Browse files
committed
Fix typos
Found via `codespell -L datas,ser,readd,wont,frameword`
1 parent 7bc85b3 commit 9b3e622

31 files changed

+45
-45
lines changed

DEVELOPERS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ After the upload has finished, check the live pages:
317317

318318
* Automatic reconnection
319319
* Configurable WAMP connecting transports
320-
* WAMP Connection abstration
320+
* WAMP Connection abstraction
321321
* Authentication
322322

323323
**0.10** will get into "maintenance mode" after **0.10.6**. We'll have a maintenance branch for that over some time. The new development will be based on **0.11** (see below).

README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ Autobahn contains **NVX**, a network accelerator library that provides SIMD acce
209209

210210
.. note:
211211
212-
NVX lives in namespace `autobahn.nvx` and currently requires a x86-86 CPU with at least SSE2 and makes use of SSE4.1 if available. The code is written using vector instrinsics, should compile with both GCC and Clang,and interfaces with Python using CFFI, and hence runs fast on PyPy.
212+
NVX lives in namespace `autobahn.nvx` and currently requires a x86-86 CPU with at least SSE2 and makes use of SSE4.1 if available. The code is written using vector intrinsics, should compile with both GCC and Clang,and interfaces with Python using CFFI, and hence runs fast on PyPy.
213213
214214
-----
215215

autobahn/nvx/_utf8validator.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ int _nvx_utf8vld_validate_table (void* utf8vld, const uint8_t* data, size_t leng
237237
state = 1; \
238238
} \
239239
} else if (state == 1) { \
240-
/* refective state 1 */ \
240+
/* reflective state 1 */ \
241241
} else { \
242242
/* should not arrive here */ \
243243
}

autobahn/twisted/wamp.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ def accept(response):
308308
# be applied for every Autobahn/Twisted protocol instance from the factory
309309
transport_factory.setProtocolOptions(**protocol_options)
310310

311-
# supress pointless log noise
311+
# suppress pointless log noise
312312
transport_factory.noisy = False
313313

314314
if endpoint:

autobahn/util.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@ def generate_token(char_groups: int,
404404
:param chars_per_group: Number of characters per character group (or 1 to return a token with no grouping).
405405
:param chars: Characters to choose from. Default is 27 character subset
406406
of the ISO basic Latin alphabet (see: ``DEFAULT_TOKEN_CHARS``).
407-
:param sep: When separating groups in the token, the separater string.
407+
:param sep: When separating groups in the token, the separated string.
408408
:param lower_case: If ``True``, generate token in lower-case.
409409
410410
:returns: The generated token.
@@ -751,7 +751,7 @@ class ObservableMixin(object):
751751
# be a lot easier to deal with here. Having an __init__ method
752752
# with a "mix in" style class can be fragile and error-prone,
753753
# especially if it takes arguments. Since we don't use the
754-
# "parent" beavior anywhere, I didn't add a .set_parent() (yet?)
754+
# "parent" behavior anywhere, I didn't add a .set_parent() (yet?)
755755

756756
# these are class-level globals; individual instances are
757757
# initialized as-needed (e.g. the first .on() call adds a
@@ -789,7 +789,7 @@ def on(self, event, handler):
789789
790790
:param event: the name of the event
791791
792-
:param handler: a callable thats invoked when .fire() is
792+
:param handler: a callable that's invoked when .fire() is
793793
called for this events. Arguments will be whatever are given
794794
to .fire()
795795
"""
@@ -816,7 +816,7 @@ def off(self, event=None, handler=None):
816816
# maybe this should mean "remove the given handler
817817
# from any event at all that contains it"...?
818818
raise RuntimeError(
819-
"Can't specificy a specific handler without an event"
819+
"Can't specify a specific handler without an event"
820820
)
821821
self._listeners = dict()
822822
else:

autobahn/wamp/component.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ def failed(self):
319319
"""
320320
Mark this transport as failed, meaning we won't try to connect to
321321
it any longer (that is: can_reconnect() will always return
322-
False afer calling this).
322+
False after calling this).
323323
"""
324324
self._permanent_failure = True
325325

autobahn/wamp/exception.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ class ApplicationError(Error):
110110

111111
PAYLOAD_SIZE_EXCEEDED = "wamp.error.payload_size_exceeded"
112112
"""
113-
The application payload could not be transported becuase the serialized/framed payload
113+
The application payload could not be transported because the serialized/framed payload
114114
exceeds the transport limits.
115115
"""
116116

@@ -144,7 +144,7 @@ class ApplicationError(Error):
144144

145145
NO_SUCH_SESSION = "wamp.error.no_such_session"
146146
"""
147-
A router could not perform an operation, since a session ID specified was non-existant.
147+
A router could not perform an operation, since a session ID specified was non-existent.
148148
"""
149149

150150
INVALID_ARGUMENT = "wamp.error.invalid_argument"

autobahn/wamp/flatbuffers/pubsub.fbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ table Event
186186
// When using Payload.CRYPTOBOX, the public Cryptobox key of the key pair used for encrypting the payload.
187187
enc_key: [uint8];
188188

189-
// The WAMP session ID of the pubisher. Only filled when the publisher is disclosed.
189+
// The WAMP session ID of the publisher. Only filled when the publisher is disclosed.
190190
publisher: uint64;
191191

192192
// The WAMP authrole of the publisher. Only filled when publisher is disclosed.

autobahn/wamp/interfaces.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ def onUserError(self, fail, msg):
356356
current stack-trace and then error-message to stdout.
357357
358358
ApplicationSession-derived objects may override this to
359-
provide logging if they prefer. The Twisted implemention does
359+
provide logging if they prefer. The Twisted implementation does
360360
this. (See :class:`autobahn.twisted.wamp.ApplicationSession`)
361361
362362
:param fail: The failure that occurred.

autobahn/wamp/message.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1876,7 +1876,7 @@ def __init__(self,
18761876
assert(retain is None or type(retain) == bool)
18771877
assert(transaction_hash is None or type(transaction_hash) == str)
18781878

1879-
# publisher exlusion and black-/whitelisting
1879+
# publisher exclusion and black-/whitelisting
18801880
assert(exclude_me is None or type(exclude_me) == bool)
18811881

18821882
assert(exclude is None or type(exclude) == list)
@@ -1930,7 +1930,7 @@ def __init__(self,
19301930
self._payload = payload
19311931
self._acknowledge = acknowledge
19321932

1933-
# publisher exlusion and black-/whitelisting
1933+
# publisher exclusion and black-/whitelisting
19341934
self._exclude_me = exclude_me
19351935
self._exclude = exclude
19361936
self._exclude_authid = exclude_authid

autobahn/wamp/protocol.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ def _exception_from_message(self, msg):
339339
else:
340340
exc = exception.ApplicationError(msg.error)
341341

342-
# FIXME: cleanup and integate into ctors above
342+
# FIXME: cleanup and integrate into ctors above
343343
if hasattr(exc, 'enc_algo'):
344344
exc.enc_algo = msg.enc_algo
345345
if hasattr(exc, 'callee'):
@@ -1237,7 +1237,7 @@ def error(err):
12371237
reg = self._registrations[msg.registration]
12381238
except KeyError:
12391239
raise ProtocolError(
1240-
"UNREGISTERED received for non-existant registration"
1240+
"UNREGISTERED received for non-existent registration"
12411241
" ID {0}".format(msg.registration)
12421242
)
12431243
self.log.debug(

autobahn/wamp/test/test_wamp_protocol.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ def errback(fail):
308308
self.assertEqual(1, len(got_errors))
309309
# ...now let the async errback continue by completing the
310310
# Deferred we returned in our errback (could be fail or
311-
# success, shoudln't matter)
311+
# success, shouldn't matter)
312312
error_d.callback(None)
313313

314314
# ensure we (now) get our errback
@@ -666,7 +666,7 @@ def test_unregister_no_such_registration(self):
666666
message.Unregister(0, 1234)
667667
)
668668
self.assertIn(
669-
"UNREGISTERED received for non-existant registration",
669+
"UNREGISTERED received for non-existent registration",
670670
str(ctx.exception)
671671
)
672672

autobahn/wamp/test/test_wamp_user_handler_errors.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ def test_on_join(self):
120120
session.onJoin = exception_raiser(exception)
121121
msg = create_mock_welcome()
122122

123-
# give the sesion a WELCOME, from which it should call onJoin
123+
# give the session a WELCOME, from which it should call onJoin
124124
session.onMessage(msg)
125125

126126
# make sure we got the right error out of onUserError
@@ -133,7 +133,7 @@ def test_on_join_deferred(self):
133133
session.onJoin = async_exception_raiser(exception)
134134
msg = create_mock_welcome()
135135

136-
# give the sesion a WELCOME, from which it should call onJoin
136+
# give the session a WELCOME, from which it should call onJoin
137137
session.onMessage(msg)
138138

139139
# make sure we got the right error out of onUserError

autobahn/websocket/protocol.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1679,7 +1679,7 @@ def onFrameData(self, payload):
16791679
compressedLen = len(payload)
16801680
self.log.debug(
16811681
"RX compressed [length]: octets",
1682-
legnth=compressedLen,
1682+
length=compressedLen,
16831683
octets=_LazyHexFormatter(payload),
16841684
)
16851685

autobahn/websocket/types.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ def __init__(self, host=None, port=None, resource=None, headers=None, useragent=
159159
160160
:param int port: the port to present to the server
161161
162-
:param str resouce:
162+
:param str resource:
163163
164164
:param headers: extra HTTP headers to send in the opening handshake
165165
:type headers: dict

autobahn/xbr/_cli.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ async def _do_market_realm(self, details):
310310
# buyer/seller (payment/paying) channel
311311
channel_type = self.config.extra['channel_type']
312312

313-
# the delgate allowed to use the channel
313+
# the delegate allowed to use the channel
314314
delegate = self.config.extra['delegate']
315315

316316
# amount of market coins for initial channel balance

autobahn/xbr/_config.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ def convert(self, value, param, ctx):
473473
value = web3.Web3.toChecksumAddress(value)
474474
adr = binascii.a2b_hex(value[2:])
475475
if len(value) != 20:
476-
raise ValueError('Ethereum addres must be 20 bytes (160 bit), but was {} bytes'.format(len(adr)))
476+
raise ValueError('Ethereum address must be 20 bytes (160 bit), but was {} bytes'.format(len(adr)))
477477
except Exception as e:
478478
self.fail(style_error(str(e)))
479479
else:

autobahn/xbr/_mnemonic.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ def parse_derivation_path(str_derivation_path):
140140

141141

142142
def mnemonic_to_private_key(mnemonic, str_derivation_path=LEDGER_ETH_DERIVATION_PATH, passphrase=""):
143-
""" Performs all convertions to get a private key from a mnemonic sentence, including:
143+
""" Performs all conversions to get a private key from a mnemonic sentence, including:
144144
145145
BIP39 mnemonic to seed
146146
BIP32 seed to master key

autobahn/xbr/_seller.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -577,7 +577,7 @@ def close_channel(self, market_maker_adr, channel_oid, channel_seq, channel_bala
577577

578578
def sell(self, market_maker_adr, buyer_pubkey, key_id, channel_oid, channel_seq, amount, balance, signature, details=None):
579579
"""
580-
Called by a XBR Market Maker to buy a data encyption key. The XBR Market Maker here is
580+
Called by a XBR Market Maker to buy a data encryption key. The XBR Market Maker here is
581581
acting for (triggered by) the XBR buyer delegate.
582582
583583
:param market_maker_adr: The market maker Ethereum address. The technical buyer is usually the

docs/changelog.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ Changelog
502502
18.9.1
503503
------
504504

505-
* new: Interrupt has Options.reason to signal detailed origin of call cancelation (active cancel vs passive timeout)
505+
* new: Interrupt has Options.reason to signal detailed origin of call cancellation (active cancel vs passive timeout)
506506
* fix: Cancel and Interrupt gets ``"killnowait"`` mode
507507
* new: Cancel and Interrupt no longer have ``ABORT/"abort"``
508508

@@ -786,7 +786,7 @@ Changelog
786786
* new: support new UBJSON WAMP serialization format
787787
* new: publish universal wheels
788788
* fix: replaced `msgpack-python` with `u-msgpack-python`
789-
* fix: some glitches with `eligible / exlude` when used with `authid / authrole`
789+
* fix: some glitches with `eligible / exclude` when used with `authid / authrole`
790790
* fix: some logging glitches
791791
* fix: pin Twisted at 16.1.1 (for now)
792792

docs/reference/autobahn.asyncio.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Autobahn asyncio specific classes. These are used when asyncio is run as the und
77
Component
88
---------
99

10-
The component API provides a high-level funcional style method of defining and running WAMP components including authentication configuration
10+
The component API provides a high-level functional style method of defining and running WAMP components including authentication configuration
1111

1212
.. autoclass:: autobahn.asyncio.component.Component
1313
:members:

docs/reference/autobahn.twisted.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Autobahn Twisted specific classes. These are used when Twisted is run as the und
66
Component
77
---------
88

9-
The component API provides a high-level funcional style method of defining and running WAMP components including authentication configuration
9+
The component API provides a high-level functional style method of defining and running WAMP components including authentication configuration
1010

1111
.. autoclass:: autobahn.twisted.component.Component
1212
:members:

docs/wamp/programming.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ Many of the examples in this documentation use a decorator style with fixed, sta
160160

161161
It is important to remember that :class:`Component` handles re-connection -- this implies there are times when your component is **not** connected. The `on_join` handlers are run whenever a fresh WAMP session is started, so this is the appropriate way to hook in "initialization"-style code (`on_leave` is where "un-initialization" code goes). Note that each new WAMP session will use a new instance of :class:`ApplicationSession`.
162162

163-
Here's a slightly more complex example that is a small `Klein`_ Web application that publishes to a WAMP session when a certian URL is requested (note that the Crossbario.io router supports `various REST-style integrations <https://crossbar.io/docs/HTTP-Bridge/>`_ already). Using a similar pattern, you could tie together two or more :class:`Component` instances (even connecting to two or more *different* WAMP routers).
163+
Here's a slightly more complex example that is a small `Klein`_ Web application that publishes to a WAMP session when a certain URL is requested (note that the Crossbario.io router supports `various REST-style integrations <https://crossbar.io/docs/HTTP-Bridge/>`_ already). Using a similar pattern, you could tie together two or more :class:`Component` instances (even connecting to two or more *different* WAMP routers).
164164

165165
.. _Klein: https://github.com/twisted/klein
166166

@@ -438,7 +438,7 @@ A *Publisher* publishes events to topics by providing the topic URI and any payl
438438

439439
*Subscribers* subscribe to topics they are interested in with *Brokers*. *Publishers* initiate publication first at a *Broker*. *Brokers* route events incoming from *Publishers* to *Subscribers* that are subscribed to respective topics.
440440

441-
The *Publisher* and *Subscriber* will usually run application code, while the *Broker* works as a generic router for events thus decoupling *Publishers* from *Subscribers*. That is, there can be many *Subscribers* written in different languages on different machines which can all receive a single event published by an independant *Publisher*.
441+
The *Publisher* and *Subscriber* will usually run application code, while the *Broker* works as a generic router for events thus decoupling *Publishers* from *Subscribers*. That is, there can be many *Subscribers* written in different languages on different machines which can all receive a single event published by an independent *Publisher*.
442442

443443

444444
.. _subscribing-to-topics:
@@ -655,7 +655,7 @@ Before any logging happens of course you must activate the logging system. There
655655

656656
If you have instead got your own log-starting code (e.g. ``twistd``) or Twisted/asyncio specific log handlers (``logging.Handler`` subclass on asyncio and ``ILogObserver`` implementer under Twisted) then you will still get |Ab| and `Crossbar`_ messages. Probably the formatting will be slightly different from what ``txaio.start_logging`` provides. In either case, **do not depend on the formatting** of the messages e.g. by "screen-scraping" the logs.
657657

658-
We very much **recommend using the ``txaio.start_logging()`` method** of activating the logging system, as we've gone to pains to ensure that over-level logs are a "no-op" and incur minimal runtime cost. We achieve this by re-binding all out-of-scope methods on any logger created by ``txaio.make_logger()`` to a do-nothing function (by saving weak-refs of all the loggers created); at least on `PyPy`_ this is very well optimized out. This allows us to be generous with ``.debug()`` or ``.trace()`` calls without incurring very much overhead. Your Milage May Vary using other methods. If you haven't called ``txaio.start_logging()`` this optimization is not activated.
658+
We very much **recommend using the ``txaio.start_logging()`` method** of activating the logging system, as we've gone to pains to ensure that over-level logs are a "no-op" and incur minimal runtime cost. We achieve this by re-binding all out-of-scope methods on any logger created by ``txaio.make_logger()`` to a do-nothing function (by saving weak-refs of all the loggers created); at least on `PyPy`_ this is very well optimized out. This allows us to be generous with ``.debug()`` or ``.trace()`` calls without incurring very much overhead. Your Mileage May Vary using other methods. If you haven't called ``txaio.start_logging()`` this optimization is not activated.
659659

660660

661661
Upgrading

docs/work/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
* performance (passthrough of app payloads, general zero copy)
1010
* support end-to-end encryption
11-
* carrying proprietory binary payloads (MQTT)
11+
* carrying proprietary binary payloads (MQTT)
1212
* strict static typing of interfaces
1313

1414
---
@@ -44,13 +44,13 @@ The approach taken (**XX**) allows for a number of useful features:
4444

4545
1. flexible support of popular dynamically typed serializers, namely: JSON, MsgPack, CBOR and UBJSON
4646
2. allow arbitrary adhoc extensibility (as the router basically does not care about new app payloads)
47-
3. transparantly translate the *application payload* between serialization formats used by different clients connected at the same time.
47+
3. transparently translate the *application payload* between serialization formats used by different clients connected at the same time.
4848
4. support optional router side application payload validation: both static, and dynamic (calling into user supplied payload validators)
4949

5050
However, a number of downsides have become apparent as well:
5151

5252
1. resource consumption: serialization/deserialization can eat significant chunks of CPU, and produce GC pressure
53-
2. legacy (MQTT) and proprietory payloads that should simply be transported "as is" (passthrough, without ever touching)
53+
2. legacy (MQTT) and proprietary payloads that should simply be transported "as is" (passthrough, without ever touching)
5454
3. as apps and systems get larger and more complex, the dynamic typing flexibility turns into a major problem: **the internal and external interfaces and APIs in a microservices based application must be relied upon and their evolution actively managed**
5555

5656
The latter does not mean an "either or" question. You can have important base APIs and external interfaces defined rigorously, using static, strict typing discipline, while at the same time have other parts of your system evolve more freely, basically allowing weakly and dynamically typed data exchange - for limited areas.
@@ -60,7 +60,7 @@ The latter does not mean an "either or" question. You can have important base AP
6060

6161
### Payload Transparency Mode
6262

63-
**Payload Transparancy Mode (PTM)** adds a 4th application payload variant to above **XX**
63+
**Payload Transparency Mode (PTM)** adds a 4th application payload variant to above **XX**
6464

6565
4. `[CALL, Request|id, Options|dict, Procedure|uri, Payload|binary]`
6666

docs/work/apps.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ WAMP Application
44
Introduction
55
------------
66

7-
Flask-like syntaxe for WAMP projects.
7+
Flask-like syntax for WAMP projects.
88

99
This is intended to make it easier to start with autobahn/crossbar.io
1010
and abstract a lot of things : you don't have to think about the main

0 commit comments

Comments
 (0)