move stubs dir, fix hidden issues (#571)

bumped minimum ruamel-yaml version to 0.16.12 on py3.6 and 0.17.6 on py3.7+

Author: mr-c

.github/workflows/ci-tests.yml

@@ -91,7 +91,7 @@ jobs:
             source .env/bin/activate && \
             python -m pip install --upgrade pip wheel setuptools_scm[toml] && \
             python -m pip install -r mypy-requirements.txt -r requirements.txt && \
-            MYPYPATH=typeshed SCHEMA_SALAD_USE_MYPYC=1 python -m pip install -e .[pycodegen] && \
+            MYPYPATH=mypy-stubs SCHEMA_SALAD_USE_MYPYC=1 python -m pip install -e .[pycodegen] && \
             deactivate'
     - name: Test with pytest
       run: |

.github/workflows/wheel-prep.sh

@@ -1,3 +1,3 @@
 export SCHEMA_SALAD_USE_MYPYC=1
-export MYPYPATH=typeshed
+export MYPYPATH=mypy-stubs
 export SETUPTOOLS_SCM_PRETEND_VERSION=$(grep __version__ schema_salad/_version.py  | awk -F\' '{ print $2 }')

.gitignore

@@ -5,8 +5,7 @@
 
 build/
 dist/
-ruamel
-typeshed/ruamel/yaml
+mypy-stubs/ruamel/yaml
 # virtualenv 
 venv/
 .cache/

MANIFEST.in

@@ -12,6 +12,6 @@ include schema_salad/tests/foreign/*.cwl
 recursive-include schema_salad/tests/test_real_cwl *
 include schema_salad/metaschema/*
 include schema_salad/tests/docimp/*
-recursive-include typeshed *.py?
+recursive-include mypy-stubs *.py?
 global-exclude *~
 global-exclude *.pyc

Makefile

@@ -49,7 +49,7 @@ install-dep: install-dependencies
 
 install-dependencies: FORCE
 	pip install --upgrade $(DEVPKGS)
-	pip install -r requirements.txt -r mypy-requirements.txt -r docs/requirements.txt
+	pip install -r requirements.txt -r mypy-requirements.txt
 
 ## install     : install the ${MODULE} module and script(s)
 install: FORCE
@@ -80,7 +80,7 @@ clean: FORCE
 # Linting and code style related targets
 ## sorting imports using isort: https://github.com/timothycrosley/isort
 sort_imports: $(filter-out schema_salad/metaschema.py,$(PYSOURCES))
-	isort $^ typeshed
+	isort $^ mypy-stubs
 
 remove_unused_imports: $(filter-out schema_salad/metaschema.py,$(PYSOURCES))
 	autoflake --in-place --remove-all-unused-imports $^
@@ -98,10 +98,10 @@ diff_pydocstyle_report: pydocstyle_report.txt
 
 ## format      : check/fix all code indentation and formatting (runs black)
 format:
-	black --exclude metaschema.py --exclude _version.py schema_salad setup.py typeshed
+	black --exclude metaschema.py --exclude _version.py schema_salad setup.py mypy-stubs
 
 format-check:
-	black --diff --check --exclude metaschema.py --exclude _version.py schema_salad setup.py typeshed
+	black --diff --check --exclude metaschema.py --exclude _version.py schema_salad setup.py mypy-stubs
 
 ## pylint      : run static code analysis on Python code
 pylint: $(PYSOURCES)
@@ -169,16 +169,10 @@ list-author-emails:
 
 mypy3: mypy
 mypy: $(filter-out setup.py,$(PYSOURCES))
-	if ! test -f $(shell python3 -c 'import ruamel.yaml; import os.path; print(os.path.dirname(ruamel.yaml.__file__))')/py.typed ; \
-	then \
-		rm -Rf typeshed/ruamel/yaml ; \
-		ln -s $(shell python3 -c 'import ruamel.yaml; import os.path; print(os.path.dirname(ruamel.yaml.__file__))') \
-			typeshed/ruamel/ ; \
-	fi  # if minimally required ruamel.yaml version is 0.15.99 or greater, than the above can be removed
-	MYPYPATH=$$MYPYPATH:typeshed mypy $^
+	MYPYPATH=$$MYPYPATH:mypy-stubs mypy $^
 
 mypyc: $(PYSOURCES)
-	MYPYPATH=typeshed SCHEMA_SALAD_USE_MYPYC=1 python setup.py test
+	MYPYPATH=mypy-stubs SCHEMA_SALAD_USE_MYPYC=1 python setup.py test
 
 pyupgrade: $(filter-out schema_salad/metaschema.py,$(PYSOURCES))
 	pyupgrade --exit-zero-even-if-changed --py36-plus $^

docs/typeshed.rst

@@ -3,12 +3,12 @@ How to add new types to the local Typeshed
 
 
 If when running ``make mypy`` you receive errors about modules that can't be
-found you may need to add type stubs for new modules to the ``typeshed/``
+found you may need to add type stubs for new modules to the ``mypy-stubs/``
 directory.
 
 ::
 
- stubgen -o typeshed module_name
+ stubgen -o mypy-stubs module_name
  make mypy
 
 Note: the module name is not always the name of the PyPI package

typeshed/cachecontrol/__init__.pyi renamed to mypy-stubs/cachecontrol/__init__.pyi

@@ -6,7 +6,4 @@ from typing import Any
 
 from .wrapper import CacheControl as CacheControl
 
-# from .adapter import CacheControlAdapter as CacheControlAdapter
-# from .controller import CacheController as CacheController
-
 __email__ = ...  # type: Any

mypy-stubs/cachecontrol/cache.pyi

@@ -0,0 +1,5 @@
+class BaseCache:
+    def get(self, key: str) -> str | None: ...
+    def set(self, key: str, value: str) -> None: ...
+    def delete(self, key: str) -> None: ...
+    def close(self) -> None: ...

typeshed/cachecontrol/caches/__init__.pyi renamed to mypy-stubs/cachecontrol/caches/__init__.pyi

@@ -0,0 +1,31 @@
+from os import PathLike
+from typing import ContextManager
+
+from ..cache import BaseCache as BaseCache
+from ..controller import CacheController as CacheController
+
+class _LockClass:
+    path: str
+
+_lock_class = ContextManager[_LockClass]
+
+class FileCache(BaseCache):
+    directory: str | PathLike[str]
+    forever: bool
+    filemode: str
+    dirmode: str
+    lock_class: _lock_class
+    def __init__(
+        self,
+        directory: str | PathLike[str],
+        forever: bool = ...,
+        filemode: int = ...,
+        dirmode: int = ...,
+        use_dir_lock: bool | None = ...,
+        lock_class: _lock_class | None = ...,
+    ) -> None: ...
+    @staticmethod
+    def encode(x: str) -> str: ...
+    def get(self, key: str) -> None | str: ...
+    def set(self, key: str, value: str) -> None: ...
+    def delete(self, key: str) -> None: ...