reformat project, use black, use isort, add action

Author: AbstractUmbra

.github/linters/.isort.cfg

@@ -0,0 +1,5 @@
+[settings]
+profile = black
+src_paths = hondana
+known_first_party = hondana
+lines_after_imports = 2

.github/linters/.python-black

@@ -0,0 +1,2 @@
+[tool.black]
+line-length=125

.github/workflows/coverage_and_lint.yaml

@@ -0,0 +1,42 @@
+name: Type Coverage and Linting
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  job:
+    name: Type Coverage and Linting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python 3.9
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.9
+
+      - name: Install Poetry
+        uses: snok/[email protected]
+
+      - name: Setup node.js (pyright)
+        uses: actions/setup-node@v1
+        with:
+          node-version: "14"
+
+      - name: Install Python deps
+        run: |
+          poetry install --no-dev
+
+      - name: Type Coverage
+        run: |
+          npm install -g pyright
+          pyright --lib --ignoreexternal --verifytypes mystbin
+
+      - name: Lint
+        uses: github/super-linter@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VALIDATE_PYTHON_BLACK: true
+          VALIDATE_PYTHON_ISORT: true

.github/workflows/lint.yml

@@ -4,4 +4,3 @@ __pycache__/
 *.pyc
 /dist/
 /*.egg-info/
-.mypy_cache/

.gitignore

@@ -1,7 +1,7 @@
-Copyright 2020 AbstractUmbra
+Copyright 2020-Present AbstractUmbra
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE

@@ -1,7 +1,7 @@
 """
 The MIT License (MIT)
 
-Copyright (c) 2020 AbstractUmbra
+Copyright (c) 2020-Present AbstractUmbra
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"),
@@ -22,11 +22,19 @@
 DEALINGS IN THE SOFTWARE.
 """
 
-from collections import namedtuple
+from typing import Literal, NamedTuple
 
 from .client import HTTPClient as Client
 from .errors import *
 
-__version__ = "1.0.1"
-VersionInfo = namedtuple("VersionInfo", "major minor micro releaselevel serial")
-version_info = VersionInfo(major=2, minor=1, micro=3, releaselevel="final", serial=0)
+
+class VersionInfo(NamedTuple):
+    major: int
+    minor: int
+    micro: int
+    releaselevel: Literal["alpha", "beta", "candidate", "final"]
+    serial: int
+
+
+__version__ = "2.1.3"
+version_info: VersionInfo = VersionInfo(major=2, minor=1, micro=3, releaselevel="final", serial=0)

mystbin/__init__.py

@@ -1,7 +1,7 @@
 """
 The MIT License (MIT)
 
-Copyright (c) 2020 AbstractUmbra
+Copyright (c) 2020-Present AbstractUmbra
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"),
@@ -29,6 +29,7 @@
 import aiohttp
 import pkg_resources
 
+
 try:
     import requests
 except ImportError:
@@ -40,17 +41,9 @@
 def show_version():
     entries = []
 
-    entries.append(
-        "- Python v{0.major}.{0.minor}.{0.micro}-{0.releaselevel}".format(
-            sys.version_info
-        )
-    )
+    entries.append("- Python v{0.major}.{0.minor}.{0.micro}-{0.releaselevel}".format(sys.version_info))
     version_info = mystbin.version_info
-    entries.append(
-        "- mystbin.py v{0.major}.{0.minor}.{0.micro}-{0.releaselevel}".format(
-            version_info
-        )
-    )
+    entries.append("- mystbin.py v{0.major}.{0.minor}.{0.micro}-{0.releaselevel}".format(version_info))
     if version_info.releaselevel != "final":
         pkg = pkg_resources.get_distribution("mystbin.py")
         if pkg:
@@ -65,12 +58,8 @@ def show_version():
 
 
 def parse_args():
-    parser = argparse.ArgumentParser(
-        prog="mystbin", description="Tools for helping with mystbin.py"
-    )
-    parser.add_argument(
-        "-v", "--version", action="store_true", help="shows the wrapper version"
-    )
+    parser = argparse.ArgumentParser(prog="mystbin", description="Tools for helping with mystbin.py")
+    parser.add_argument("-v", "--version", action="store_true", help="shows the wrapper version")
     parser.set_defaults(func=core)
 
     return parser, parser.parse_args()

mystbin/__main__.py

@@ -1,7 +1,7 @@
 """
 The MIT License (MIT)
 
-Copyright (c) 2020 AbstractUmbra
+Copyright (c) 2020-Present AbstractUmbra
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"),
@@ -32,6 +32,7 @@
 from .errors import APIError, BadPasteID
 from .objects import Paste, PasteData
 
+
 if TYPE_CHECKING:
     import requests
 
@@ -60,9 +61,7 @@ def __init__(
         session: Optional[Union[aiohttp.ClientSession, requests.Session]] = None,
     ) -> None:
         self.api_key = api_key
-        self._are_we_async = session is None or isinstance(
-            session, aiohttp.ClientSession
-        )
+        self._are_we_async = session is None or isinstance(session, aiohttp.ClientSession)
         self.session = session
 
     async def _generate_async_session(self) -> aiohttp.ClientSession:
@@ -116,9 +115,7 @@ async def _perform_async_post(self, content: str, syntax: str = None) -> Paste:
         multi_part_write = aiohttp.MultipartWriter()
         paste_content = multi_part_write.append(content)
         paste_content.set_content_disposition("form-data", name="data")
-        paste_content = multi_part_write.append_json(
-            {"meta": [{"index": 0, "syntax": syntax}]}
-        )
+        paste_content = multi_part_write.append_json({"meta": [{"index": 0, "syntax": syntax}]})
         paste_content.set_content_disposition("form-data", name="meta")
 
         async with self.session.post(
@@ -159,9 +156,7 @@ def get(self, paste_id: str) -> Union[PasteData, Awaitable]:
 
     def _perform_sync_get(self, paste_id: str) -> PasteData:
         """ Sync get request. """
-        response: requests.Response = self.session.get(
-            f"{API_BASE_URL}/{paste_id}", timeout=CLIENT_TIMEOUT
-        )
+        response: requests.Response = self.session.get(f"{API_BASE_URL}/{paste_id}", timeout=CLIENT_TIMEOUT)
 
         if response.status_code not in (200,):
             raise BadPasteID("This is an invalid Mystb.in paste ID.")
@@ -174,9 +169,7 @@ async def _perform_async_get(self, paste_id: str) -> PasteData:
         if not self.session:
             self.session: aiohttp.ClientSession = await self._generate_async_session()
 
-        async with self.session.get(
-            f"{API_BASE_URL}/{paste_id}", timeout=aiohttp.ClientTimeout(CLIENT_TIMEOUT)
-        ) as response:
+        async with self.session.get(f"{API_BASE_URL}/{paste_id}", timeout=aiohttp.ClientTimeout(CLIENT_TIMEOUT)) as response:
             if response.status not in (200,):
                 raise BadPasteID("This is an invalid Mystb.in paste ID.")
             paste_data = await response.json()

mystbin/client.py

@@ -1,7 +1,7 @@
 """
 The MIT License (MIT)
 
-Copyright (c) 2020 AbstractUmbra
+Copyright (c) 2020-Present AbstractUmbra
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"),
@@ -24,6 +24,7 @@
 
 from re import compile
 
+
 __all__ = ("API_BASE_URL", "PASTE_BASE", "CLIENT_TIMEOUT", "MB_URL_RE")
 
 API_BASE_URL = "https://mystb.in/api/pastes"
@@ -32,6 +33,4 @@
 CLIENT_TIMEOUT = 15
 
 # grab the paste id: https://regex101.com/r/qkluDh/6
-MB_URL_RE = compile(
-    r"(?:(?:https?://)?mystb\.in/)?(?P<ID>[a-zA-Z]+)(?:\.(?P<syntax>[a-zA-Z0-9]+))?"
-)
+MB_URL_RE = compile(r"(?:(?:https?://)?mystb\.in/)?(?P<ID>[a-zA-Z]+)(?:\.(?P<syntax>[a-zA-Z0-9]+))?")