pre-0.9.7 2

Author: jonathandung

.github/workflows/deploy.yaml

@@ -20,7 +20,7 @@ jobs:
           python-version: 3.14
           cache-python: true
           activate-environment: true
-      - run: uv pip install ".[docs]" && make -C docs html
+      - run: uv pip install ".[themes]" && make -C docs html
       - uses: actions/upload-pages-artifact@v5.0.0
         with:
           path: docs/build/html

.readthedocs.yaml

@@ -24,4 +24,4 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - docs
+        - themes

AUTHORS.md

@@ -2,11 +2,11 @@
 
 ## Technical leads
 
-* Jonathan Dung - owner - Hong Kong
+- Jonathan Dung - owner - Hong Kong
 
 ## Developers
 
-* Jonathan Dung - sole maintainer - Hong Kong
+- Jonathan Dung - sole maintainer - Hong Kong
 
 ## All other contributors and their affiliations
 

CHANGELOG.md

@@ -1,3 +1,7 @@
+---
+hide-toc: true
+---
+
 # Changelog
 
 All notable changes to this project are and will be documented in this file.
@@ -63,23 +67,21 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
 
 - Declared end of life for all alpha versions.
 - Changed version shelving and unshelving schema.
-- Added the following to the public API:
-
-  - Top level:
+- Finalized the following top level objects:
 
-    Constants:
-    - \_\_version__
-    - \_\_hexversion__
-    - submodules_map
-    - preloaded_submodules
-    - console_preloaded_submodules
+  Constants:
+  - \_\_version__
+  - \_\_hexversion__
+  - submodules_map
+  - preloaded_submodules
+  - console_preloaded_submodules
 
-    Functions:
-    - time_since_boot
+  Functions:
+  - time_since_boot
 
-    Submodules:
+- Declared the following submodules and symbols as part of the public API:
 
-    - altlocks
+  - altlocks
 
     Classes:
     - ResourceGuard
@@ -89,7 +91,7 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - DynamicThrottle
     - Releasing
 
-    - base
+  - base
 
     Classes:
     - event_loop (context manager)
@@ -110,7 +112,7 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - dummy_task
     - yield_to_event_loop
 
-    - buckets
+  - buckets
 
     Classes:
     - TokenBucket
@@ -122,19 +124,19 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - AsyncLRUCache
     - CacheWithBackgroundRefresh
 
-    - channels
+  - channels
 
     Classes:
     - Observable
     - EventBus
     - Rendezvous
 
-    - cli
+  - cli
 
     Functions:
     - run
 
-    - compete
+  - compete
 
     Functions:
     - first_completed
@@ -144,7 +146,7 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - enhanced_gather
     - enhanced_staggered_race
 
-    - config
+  - config
 
     Classes:
     - debugging
@@ -162,13 +164,13 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - loaded_all
     - logging_to
 
-    - console
+  - console
 
     Classes:
     - ConsoleBase
     - AsyncUtilsConsole
 
-    - constants
+  - constants
 
     Classes:
     - sentinel_base
@@ -181,7 +183,7 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     Sentinels:
     - RAISE
 
-    - context
+  - context
 
     Classes:
     - Context
@@ -196,13 +198,13 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - getcontext
     - setcontext
 
-    - events
+  - events
 
     Classes:
     - SingleWaiterEventWithValue
     - EventWithValue
 
-    - exceptions:
+  - exceptions:
 
     Classes:
     - ref
@@ -273,7 +275,7 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - wrap_exc
     - unwrap_exc
 
-    - func
+  - func
 
     Classes:
     - RateLimited
@@ -294,7 +296,7 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - star
     - unstar
 
-    - futures
+  - futures
 
     Classes:
     - AsyncCallbacksFuture
@@ -306,7 +308,7 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - TimeAwareFuture
     - TimeAwareTask
 
-    - io
+  - io
 
     Classes:
     - AsyncReadWriteCouple
@@ -316,19 +318,19 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - double_ended_text_pipe
     - double_ended_binary_pipe
 
-    - iterclasses
+  - iterclasses
 
     Classes:
     - achain
     - apeekable
     - abucket
 
-    - iters
+  - iters
 
     Functions:
     - ... (There are too many of these, so just refer to the IDE autocomplete or read the stub)
 
-    - locks
+  - locks
 
     Classes:
     - AdvancedRateLimit
@@ -341,15 +343,16 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - LocksmithBase
     - MultiCountDownLatch
 
-    - misc
+  - misc
 
     Classes:
+    - CallbackAccumulator
     - StateMachine
 
     Functions:
     - gather_with_limited_concurrency
 
-    - mixins
+  - mixins
 
     Interfaces/Mixins:
     - LoopBoundMixin
@@ -361,7 +364,7 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - LockWithOwnerMixin
     - EventMixin
 
-    - networking
+  - networking
 
     Classes:
     - LineProtocol
@@ -370,28 +373,27 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - CRProtocol
     - SocketTransport
 
-    - pools
+  - pools
 
     Classes:
     - AdvancedPool
     - ConnectionPool
-    - CallbackAccumulator
 
-    - processors
+  - processors
 
     Classes:
     - BoundedBatchProcessor
     - BatchProcessor
     - Bulkhead
 
-    - properties
+  - properties
 
     Classes:
     - AsyncProperty
     - AsyncLockProperty
     - coercedmethod
 
-    - queues
+  - queues
 
     Interfaces:
     - PotentQueueBase
@@ -411,7 +413,7 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - ignore_qfull
     - ignore_qerrs
 
-    - rwlocks
+  - rwlocks
 
     Classes:
     - RWLock
@@ -427,7 +429,7 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     Functions:
     - wait_for_signal
 
-    - tools
+  - tools
 
     Functions:
 
@@ -441,7 +443,7 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - get_cmd_help
     - print_cmd_help
 
-    - util
+  - util
 
     Context managers (ignore_*):
     - ignore_cancellation
@@ -471,7 +473,7 @@ Added `__lazy_modules__` attribute to submodules where appropriate; added some i
     - transient_block_from_loop
     - wrap_in_coro
 
-    - version
+  - version
 
     Classes:
     - VersionInfo

CODE_OF_CONDUCT.md

@@ -10,20 +10,20 @@ of experience, nationality, personal appearance, race, religion, or sexual ident
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery
+- Unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 

EXAMPLES.md

@@ -89,7 +89,7 @@ python3 asyncutils
 python3 -m asyncutils.__main__
 python3 asyncutils/__main__.py
 # python3 -m asyncutils/__main__.py: documented to be unsupported, but works on some versions
-# note: python3 asyncutils.__main__ doesn't work because python attempts to find a file called asyncutils.__main__ in the cwd
+# note: python3 asyncutils.__main__ doesn't work because python attempts to find a file called asyncutils.__main__ in the current working directory
 ```
 
 If you're in the integrated shell of VS Code, it is recommended that you unset the `PYTHON_BASIC_REPL` environment variable or turn off shell

README.md

@@ -24,7 +24,8 @@ Takes pride in:
 
 ## Setup
 
-This package probably wouldn't work on alternate Python implementations. Make sure you have CPython 3.12 or above (even 3.15 will do), and at least one of many Python package managers.
+This package probably wouldn't work on alternate Python implementations. Make sure you have CPython 3.12 or above (even 3.15 will do), and at least
+one of many Python package managers you're comfortable with.
 
 Discounting the installation, no extra setup is usually needed. See the
 [installation guide](https://asyncutils.readthedocs.io/en/stable/installation.html) for more.
@@ -42,7 +43,7 @@ This library is currently in the beta stage, meaning the public API is subject t
 backward-incompatible. See [the compatibility page](https://asyncutils.readthedocs.io/en/stable/compat.html).
 
 See [this page](https://github.com/jonathandung/asyncutils/tags) for the version tags up to now. Version tags for alpha versions have been phased out
-and cleansed, so you will only see tags beginning with 0.9.
+and cleansed with the release of v0.9.1, so you will only see tags beginning with 0.9.
 
 ## Configuration
 

SUPPORT.md

@@ -103,8 +103,8 @@ As fast as I can; that is:
 - Security issues: 1 day
 - General questions: Community-driven
 
-If the promises above are not met, and there was no relevant post on the discussions page (e.g. hiatus announcement) or my status was not set to 'On
-vacation', that must have been a major oversight on my end.
+I will try to make a post on the discussions page (e.g. hiatus announcement) and set my status to 'On vacation' or similar in case of inactivity
+such that I cannot fulfill these promises or meet deadlines I set myself.
 
 ## Closing remarks
 

asyncutils/_internal/submodules.py

@@ -17,10 +17,10 @@
 iterclasses_all = 'abucket', 'achain', 'apeekable'
 iters_all = 'aaccumulate', 'aall', 'aallequal', 'aany', 'aargmax', 'aargmin', 'aawgenf2agenf', 'abeforeandafter', 'abfs', 'abrent', 'acanonical', 'acat', 'acollapse', 'acombinations', 'acombinations_with_replacement', 'acompress', 'aconsume', 'aconvolve', 'acount', 'acountdown', 'acycle', 'aderangements', 'adfs', 'adft', 'adistinctpermutations', 'adoublestarmap', 'adropwhile', 'aevery', 'aeveryother', 'afactor', 'afilter', 'afilterfalse', 'afirst', 'afirsttrue', 'aflatten', 'aflattentensor', 'aforever', 'afreivalds', 'agather', 'agetitems_from_indices', 'agives', 'agroupby', 'agrouper', 'aguessmax', 'aguessmin', 'ahammingdist', 'aidft', 'ailen', 'ainterleave_stopearly', 'ainterleaveevenly', 'ainterleaverandomly', 'aintersend', 'aintersperse', 'aisempty', 'aislice', 'aisprime', 'aiterate', 'aiterexcept', 'aiterindex', 'alast', 'aloops', 'amap', 'amapif', 'amatmul', 'amatprod', 'amax', 'amergesortedby', 'amin', 'amultifilter', 'amultifilterfalse', 'amultimapif', 'amultistarfilter', 'amultistarfilterfalse', 'ancycles', 'anth', 'anthcombination', 'anthorlast', 'aonlinesorter', 'apadnone', 'apairwise', 'apartition', 'apermutations', 'apolynomialderivative', 'apolynomialeval', 'apolynomialfromroots', 'apowers', 'apowerset', 'apowersetofsets', 'apowersoftwo', 'aprepend', 'aprod', 'aproduct', 'aquantify', 'arandom_combination_with_replacement', 'arandomcombination', 'arandomderangement', 'arandompermutation', 'arandomproduct', 'arange', 'arepeat', 'arepeatfunc', 'areshape', 'areversed', 'aroundrobin', 'aroundrobin2', 'arunlengthdecode', 'arunlengthencode', 'arunningmean', 'arunningmedian', 'asamplel', 'asampleweighted', 'asattolo', 'asendstream', 'aserialize', 'asideeffect', 'asieve', 'asliced', 'asorted', 'asplitat', 'aspy', 'asquaresum', 'astarfilter', 'astarfilterfalse', 'astarmap', 'astarmap_withkwds', 'asubslices', 'asubstrindices', 'asubstrings', 'asum', 'asumprod', 'atabulate', 'atail', 'atakewhile', 'atakewhile_inclusive', 'atakewhilenot', 'atakewhilenot_inclusive', 'atranspose', 'atriplewise', 'aunique', 'aunique_everseen', 'aunique_justseen', 'auniquetoeach', 'aunzip', 'azip', 'aziplongest', 'basic_collect', 'batch', 'batch2', 'batch_process', 'buffer', 'empty_agen', 'fmap', 'fmap_parallel', 'fmap_sequential', 'iter_task', 'map_on_map', 'mat_vec_mul', 'merge', 'tee', 'to_list', 'to_tuple', 'vecs_eq', 'window', 'with_aiter'
 locks_all = 'AdvancedRateLimit', 'DynamicBoundedSemaphore', 'KeyedCondition', 'MultiCountDownLatch', 'PriorityLock', 'PriorityRLock', 'PrioritySemaphore', 'RLock'
-misc_all = 'StateMachine', 'gather_with_limited_concurrency'
+misc_all = 'ConnectionPool', 'StateMachine', 'gather_with_limited_concurrency'
 mixins_all = 'AsyncContextMixin', 'AwaitableMixin', 'EventMixin', 'ExecutorRequiredAsyncContextMixin', 'LockMixin', 'LockWithOwnerMixin', 'LoopBoundMixin', 'LoopContextMixin'
 networking_all = 'CRLFProtocol', 'CRProtocol', 'LFProtocol', 'LineProtocol', 'SocketTransport'
-pools_all = 'AdvancedPool', 'CallbackAccumulator', 'ConnectionPool'
+pools_all = 'AdvancedPool', 'CallbackAccumulator'
 processors_all = 'BatchProcessor', 'BoundedBatchProcessor', 'Bulkhead'
 properties_all = 'AsyncLockProperty', 'AsyncProperty', 'coercedmethod'
 queues_all = 'PotentQueueBase', 'SmartLifoQueue', 'SmartPriorityQueue', 'SmartQueue', 'UserPriorityQueue', 'ignore_qempty', 'ignore_qerrs', 'ignore_qfull', 'ignore_qshutdown', 'password_queue'