@@ -6,12 +6,69 @@ Changelog
66This page keeps a fairly detailed, human readable version
77of what has changed, and whats new for each version of the lib.
88
9+ v0.1.1
10+ --------
11+ BugFixes
12+ ~~~~~~~~~
13+ - Stop nested asyncio loops from failing.
14+
15+ Important
16+ ~~~~~~~~~~
17+
18+ - New methods
19+
20+ - :meth: `.Client.get_clans(tags) ` returns an AsyncIterator of clans.
21+ - :meth: `.Client.get_current_wars(tags) ` returns an AsyncIterator of current wars
22+ - :meth: `.Client.get_players(tags) ` returns an AsyncIterator of players
23+ - :meth: `.SearchClan.get_detailed_members ` returns an AsyncIterator of :class: `.SearchPlayer ` for clans members
24+ - :meth: `.Client.set_cache(*cache_names, max_size, expiry) ` enables you to override the default cache settings
25+ on a per-cache basis. Expiry is in seconds.
26+
27+ - Removed parameters
28+
29+ - ``json=False `` on all calls has been removed. Use :attr: `DataClass._data ` to get the dict as returned by the API
30+ if you so desire
31+
32+ - Implemented ratelimits
33+
34+ - ``throttle_limit `` has been added as a parameter to :class: `.Client `. This is the number of calls per token, per second,
35+ to be made
36+
37+ - asyncio.Semaphore lock has been implemented
38+
39+ - New cache structure and implementation.
40+
41+ - Max size and expiry (in seconds) can be set with :meth: `Client.set_cache `
42+ - New instances of cache on a per-object (returned) basis, so different methods will implement
43+ different instances of the cache.
44+ - ``lru-dict `` has been added as a requirement.
45+ - LRU is very fast and memory efficient, written in C.
46+
47+ - Enum for :class: `CacheType ` has been implemented. This is the preferred way to pass in ``cache_names `` to :meth: `Client.set_cache `
48+ as string names may change.
49+
50+ - Can be called with :meth: `Client.set_cache(CacheType.search_clans, max_size=128, expiry=10) `
51+
52+ - New Exception: :exc: `InvalidCredentials `
53+
54+ - This essentially replaces the (now redundant) :exc: `InvalidToken ` exception, and is called when the email/pass pair
55+ passed is incorrect.
56+
57+ - New util function: :func: `coc.utils.clean_tag(tag, prefix='#') ` will return a 'cleaned up' version of the tag.
58+ It will:
59+
60+ - Make all letters UPPERCASE
61+ - Replace o ('oh') with 0 (zero)s
62+ - Remove non-alphanumeric and whitespace
63+
64+
65+
966v0.1.0
1067---------
1168BugFixes
1269~~~~~~~~~~
1370- Fixed bug with loops breaking when reloading the client in a discord cog.
14- - A more specific error, `aiohttp.ContentTypeError ` is raised when parsing non-json responses.
71+ - A more specific error, `` aiohttp.ContentTypeError ` ` is raised when parsing non-json responses.
1572
1673Important
1774~~~~~~~~~~~
0 commit comments