Merge pull request #22 from Pilifer/typing

Type annotations in api wrappers and scripts

Author: filiplajszczak

.gitignore

@@ -69,6 +69,9 @@ target/
 # IPython Notebook
 .ipynb_checkpoints
 
+# Mypy
+.mypy_cache/
+
 # pyenv
 .python-version
 
@@ -83,7 +86,7 @@ celerybeat-schedule
 venv/
 ENV/
 
-#PyCharm project folder
+# PyCharm project folder
 .idea/
 
 # Spyder project settings

.travis.yml

@@ -20,3 +20,4 @@ install:
 script:
   - pytest
   - pytest --cov=pythonanywhere --cov=scripts --cov-fail-under=65
+  - pytest --mypy -m mypy

mypy.ini

@@ -0,0 +1,2 @@
+[mypy]
+ignore_missing_imports = True

pythonanywhere/api.pyi

@@ -0,0 +1,25 @@
+from pathlib import Path
+from typing import Dict, List, Any
+
+from requests import Response
+
+PYTHON_VERSIONS = Dict[str, str]
+
+class AuthenticationError(Exception): ...
+class NoTokenError(Exception): ...
+
+def get_api_endpoint() -> str: ...
+def call_api(url: str, method: str, **kwargs) -> Response: ...
+
+class Webapp:
+    domain: str = ...
+    def __init__(self, domain: str) -> None: ...
+    def __eq__(self, other: Webapp) -> bool: ...
+    def sanity_checks(self, nuke: bool) -> None: ...
+    def create(self, python_version: str, virtualenv_path: Path, project_path: Path, nuke: bool) -> None: ...
+    def add_default_static_files_mappings(self, project_path: Path) -> None: ...
+    def reload(self) -> None: ...
+    def set_ssl(self, certificate: str, private_key: str) -> None: ...
+    def get_ssl_info(self) -> Dict[str, Any]: ...
+    def delete_log(self, log_type: str, index: int = 0) -> None: ...
+    def get_log_info(self) -> Dict[str, List[int]]: ...

pythonanywhere/django_project.pyi

@@ -0,0 +1,17 @@
+from pathlib import Path
+
+from pythonanywhere.project import Project
+from typing import Optional
+
+class DjangoProject(Project):
+    def download_repo(self, repo: str, nuke: bool) -> None: ...
+    def create_virtualenv(self, django_version: Optional[str] = ..., nuke: bool = ...) -> None: ...
+    def detect_requirements(self): ...
+    def run_startproject(self, nuke: bool) -> None: ...
+    settings_path: Path = ...
+    manage_py_path: Path = ...
+    def find_django_files(self) -> None: ...
+    def update_settings_file(self) -> None: ...
+    def run_collectstatic(self) -> None: ...
+    def run_migrate(self) -> None: ...
+    def update_wsgi_file(self) -> None: ...

pythonanywhere/exceptions.pyi

@@ -0,0 +1 @@
+class SanityException(Exception): ...

pythonanywhere/project.pyi

@@ -0,0 +1,17 @@
+from pathlib import Path
+
+from pythonanywhere.api import Webapp
+from pythonanywhere.virtualenvs import Virtualenv
+
+class Project:
+    domain: str = ...
+    python_version: str = ...
+    project_path: Path = ...
+    virtualenv: Virtualenv = ...
+    wsgi_file_path: Path = ...
+    webapp: Webapp = ...
+    def __init__(self, domain: str, python_version: str) -> None: ...
+    def sanity_checks(self, nuke: bool) -> None: ...
+    def create_webapp(self, nuke: bool) -> None: ...
+    def add_static_file_mappings(self) -> None: ...
+    def start_bash(self) -> None: ...

pythonanywhere/snakesay.pyi

@@ -0,0 +1,7 @@
+from typing import Type, Tuple, List, Iterator
+
+MESSAGE = Type[str]
+
+def snakesay(*things) -> str: ...
+def speech_bubble_lines(speech: str) -> Iterator[str]: ...
+def rewrap(speech: str) -> Tuple[List[str], int]: ...

pythonanywhere/virtualenvs.pyi

@@ -0,0 +1,12 @@
+from pathlib import Path
+from typing import List
+
+
+class Virtualenv:
+    domain: str = ...
+    python_version: str = ...
+    path: Path = ...
+    def __init__(self, domain: str, python_version: str) -> None: ...
+    def __eq__(self, other: Virtualenv) -> bool: ...
+    def create(self, nuke: bool) -> None: ...
+    def pip_install(self, packages: List[str]) -> None: ...

requirements.txt

@@ -9,6 +9,7 @@ psutil==5.4.0
 py==1.7.0
 pytest==3.2.3
 pytest-cov==2.6.0
+pytest-mypy==0.4.2
 python-dateutil==2.7.5
 requests==2.22.0
 responses==0.8.1