Add CodeQL workflow for GitHub code scanning (#94)

* Add CodeQL workflow for GitHub code scanning

* removed erroneous 'public' name of private helpers

Co-authored-by: LGTM Migrator <[email protected]>
Co-authored-by: Max Fischer <[email protected]>

Author: 3 people

.github/workflows/codeql.yml

@@ -0,0 +1,41 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  schedule:
+    - cron: "4 9 * * 4"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ python ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          queries: +security-and-quality
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{ matrix.language }}"

.github/workflows/unittests.yml

@@ -4,7 +4,7 @@ on: [push, pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
         python-version: ['3.6', '3.7', '3.8', '3.9', '3.10', 'pypy-3.6', 'pypy-3.7']

asyncstdlib/_core.py

@@ -97,7 +97,7 @@ def awaitify(
 ) -> Callable[..., Awaitable[T]]:
     """Ensure that ``function`` can be used in ``await`` expressions"""
     if iscoroutinefunction(function):
-        return function  # type: ignore
+        return function
     else:
         return Awaitify(function)
 

asyncstdlib/_lrucache.py

@@ -100,7 +100,6 @@ def cache_discard(self, *args: Any, **kwargs: Any) -> None:
         # of just passing in `self`/`cls`/... directly.
 
 
-@public_module("asyncstdlib.functools")
 class LRUAsyncBoundCallable(LRUAsyncCallable[AC]):
     """A :py:class:`~.LRUAsyncCallable` that is bound like a method"""
 
@@ -293,16 +292,16 @@ def cache__get(
     return LRUAsyncBoundCallable(self, instance)
 
 
-@public_module("asyncstdlib.functools")
 class UncachedLRUAsyncCallable(LRUAsyncCallable[AC]):
     """Wrap the async ``call`` to track accesses as for caching/memoization"""
 
     __slots__ = ("__weakref__", "__dict__", "__wrapped__", "__misses", "__typed")
 
+    __wrapped__: AC
     __get__ = cache__get
 
     def __init__(self, call: AC, typed: bool):
-        self.__wrapped__ = call  # type: ignore
+        self.__wrapped__ = call
         self.__misses = 0
         self.__typed = typed
 
@@ -323,7 +322,6 @@ def cache_discard(self, *args: Any, **kwargs: Any) -> None:
         return
 
 
-@public_module("asyncstdlib.functools")
 class MemoizedLRUAsyncCallable(LRUAsyncCallable[AC]):
     """Wrap the async ``call`` with async memoization"""
 
@@ -337,10 +335,11 @@ class MemoizedLRUAsyncCallable(LRUAsyncCallable[AC]):
         "__cache",
     )
 
+    __wrapped__: AC
     __get__ = cache__get
 
     def __init__(self, call: AC, typed: bool):
-        self.__wrapped__ = call  # type: ignore
+        self.__wrapped__ = call
         self.__hits = 0
         self.__misses = 0
         self.__typed = typed
@@ -377,7 +376,6 @@ def cache_discard(self, *args: Any, **kwargs: Any) -> None:
         self.__cache.pop(CallKey.from_call(args, kwargs, typed=self.__typed), None)
 
 
-@public_module("asyncstdlib.functools")
 class CachedLRUAsyncCallable(LRUAsyncCallable[AC]):
     """Wrap the async ``call`` with async LRU caching of finite capacity"""
 
@@ -392,10 +390,11 @@ class CachedLRUAsyncCallable(LRUAsyncCallable[AC]):
         "__cache",
     )
 
+    __wrapped__: AC
     __get__ = cache__get
 
     def __init__(self, call: AC, typed: bool, maxsize: int):
-        self.__wrapped__ = call  # type: ignore
+        self.__wrapped__ = call
         self.__hits = 0
         self.__misses = 0
         self.__typed = typed

asyncstdlib/_typing.py

@@ -38,6 +38,7 @@
     "T4",
     "T5",
     "R",
+    "C",
     "AC",
     "HK",
     "LT",

asyncstdlib/asynctools.py

@@ -49,9 +49,9 @@ def __init__(self, iterator: Union[AsyncIterator[T], AsyncGenerator[T, S]]):
         # running aiter(self).aclose closes the underlying iterator.
         self.__anext__ = self._wrapper.__anext__  # type: ignore
         if hasattr(iterator, "asend"):
-            self.asend = iterator.asend  # type: ignore
+            self.asend = iterator.asend
         if hasattr(iterator, "athrow"):
-            self.athrow = iterator.athrow  # type: ignore
+            self.athrow = iterator.athrow
 
     # Py3.6 compatibility
     # Use ``(item async for item in iterator)`` inside

asyncstdlib/contextlib.py

@@ -94,7 +94,7 @@ async def __aexit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> bool:
                 # Use `aclose` to have additional checks for the child to
                 # handle shutdown properly.
                 if exc_type is GeneratorExit:
-                    result = await self.gen.aclose()
+                    result = await self.gen.aclose()  # type: ignore
                 else:
                     result = await self.gen.athrow(exc_type, exc_val, exc_tb)
             except StopAsyncIteration as exc:
@@ -439,7 +439,7 @@ async def __aexit__(self, exc_type: Any, exc_val: Any, tb: Any) -> bool:
                 self._stitch_context(exc, exc_val, unwind_context)
                 reraise_exc = True
                 exc_type, exc_val, tb = type(exc), exc, exc.__traceback__
-        if reraise_exc:
+        if reraise_exc and exc_val is not None:
             # The __context__ is replaced by a normal `raise`, and only
             # preserved by a bare `raise` in an except block.
             exc_context = exc_val.__context__

asyncstdlib/heapq.py

@@ -174,7 +174,7 @@ async def merge(
     finally:
         for itr, _ in iter_heap:
             if hasattr(itr.tail, "aclose"):
-                await itr.tail.aclose()  # type: ignore
+                await itr.tail.aclose()
 
 
 class ReverseLT(Generic[LT]):

asyncstdlib/itertools.py

@@ -342,7 +342,7 @@ async def tee_peer(
                 break
         # if we are the last peer, try and close the iterator
         if not peers and hasattr(iterator, "aclose"):
-            await iterator.aclose()  # type: ignore
+            await iterator.aclose()
 
 
 @public_module(__name__, "tee")

unittests/test_contextlib.py

@@ -185,6 +185,7 @@ async def exit_ge():
         try:
             yield
         except GeneratorExit:
+            # treat GE as regular exit
             pass
 
     with pytest.raises(GeneratorExit):