Add poetry and fix problem from #23

.github/workflows/test.yml

@@ -1,7 +1,14 @@
 name: 'Test'
 
-on: [push, pull_request, workflow_dispatch]
-
+on:
+  push:
+    paths:
+      - /**/*.py
+      - /**/*.pyi
+      - pyproject.toml
+      - .github/workflows/test.yml
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   test:
@@ -22,31 +29,34 @@ jobs:
         python-version: ${{ matrix.python-version }}
 
     - name: Upgrade pip
-      run: |
-        python -m pip install --upgrade pip
+      run: python -m pip install --upgrade pip
+
+    - name: Install Poetry
+      run: pip install poetry
+
+    - name: Install project dependencies
+      run: poetry install -vvv
 
-    - name: Install Poetry and project dependencies
-      run: |
-        pip install poetry
-        poetry install
+    - name: Run MyPy Against Source Code
+      run: poetry run poe run_mypy_src
 
-    - name: Run Pyright
-      run: poetry run pyright
+    - name: Run Pyright Against Source Code
+      run: poetry run poe run_pyright_src
 
-    - name: Run Pytest
-      run: poetry run pytest
+    - name: Run Pytest Against Source Code
+      run: poetry run poe run_pytest_src
 
-    - name: Run MyPy
-      run: poetry run mypy pandas-stubs tests
+    - name: Build Distribution
+      run: poetry run poe build_dist
 
-    - name: Install wheel
-      run: poetry run install_wheel
+    - name: Install Distribution
+      run: poetry run poe install_dist
 
     - name: Remove Source Code
-      run: poetry run rm_src_code
+      run: poetry run poe remove_src
 
-    - name: Run Pyright against dist
-      run: poetry run pyright
+    - name: Run Pyright Against Distribution
+      run: poetry run poe run_pyright_dist
 
-    - name: Run MyPy against dist
-      run: poetry run mypy tests
+    - name: Run MyPy Against Distribution
+      run: poetry run poe run_mypy_dist

README.md

@@ -10,7 +10,7 @@ To contribute changes to the stubs, you must include an appropriate test.  See `
 
 ## Documentation
 
-- [How to setup the enviroment](docs/1%20-%20setup.md)
+- [How to set up the environment](docs/1%20-%20setup.md)
 - [How to test the project](docs/2%20-%20tests.md)
 - [How to follow the code style](docs/3%20-%20style.md)
 - [Security stuffs](docs/4%20-%20security.md)

docs/1 - setup.md

@@ -1,7 +1,9 @@
-## Setup Environment
-
-- Make sure you have python >= 3.8 installed
-- Install poetry if you still don't have: pip install poetry
-- Install the project dependencies with: poetry install -vvv
-- Run all tests to make sure the project is ok: poetry run all_tests
+## Set Up Environment
 
+- Make sure you have `python >= 3.8` installed. </br></br>
+- Install poetry if you still don't have: </br> `pip install poetry`</br> </br>
+- Install the project dependencies with: </br> `poetry install -vvv` </br></br>
+- Update if you already have the project and someone added new dependencies: </br> `poetry update -vvv`</br></br>
+- Enter the virtual environment: </br> `poetry shell`</br></br>
+- Run all tests to make sure the project is ok: </br> `poe test_all` </br></br>
+- Do you want to add a new dependency? </br> `poetry add --dev foo-pkg ` </br></br>

docs/2 - tests.md

@@ -1,5 +1,15 @@
 ## Test
 
-- These tests originally came from https://github.com/VirtusLab/pandas-stubs.
+- Run local tests against source code. </br> `poe test_src` </br> </br> 
+  - Profiles: </br>
+    - Default: Runs only mypy and pyright tests </br> `poe test_src --profile=default` </br>
+    - Pytest: Runs only pytest </br> `poe test_src --profile=pytest` </br> 
+    - Full: Run all tests (mypy, pyright and pytests) </br> `poe test_src --profiel=full` </br> </br>
 
+- Run local tests against distribution: </br> `poe test_dist` </br> </br>
 
+- Run all local tests: </br> `poe test_all` </br> </br>
+
+- Forgot some command? </br>`poe --help` </br> </br>
+
+- These tests originally came from https://github.com/VirtusLab/pandas-stubs.

pyproject.toml

@@ -1,33 +1,103 @@
 [tool.poetry]
 name = "pandas-stubs"
-version = "1.4.2.20220608"
-description = "Stubs for pandas"
-authors = ["The Pandas Development Team"]
+version = "1.4.2.220608"
+description = "Type annotations for pandas"
+authors = ["The Pandas Development Team <pandas-dev@python.org>"]
+license = "BSD-3-Clause"
+readme = "README.md"
+homepage = "https://pandas.pydata.org"
+repository = "https://github.com/pandas-dev/pandas-stubs"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Topic :: Scientific/Engineering"
+]
 packages = [
     { "include" = "pandas-stubs"}
 ]
 
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/pandas-dev/pandas-stubs/issues"
+"Documentation" = "https://pandas.pydata.org/pandas-docs/stable"
+"Source Code" = "https://github.com/pandas-dev/pandas-stubs"
+
 [tool.poetry.dependencies]
 python = ">=3.8,<3.11"
-
-[tool.poetry.dev-dependencies]
 pandas = "1.4.*"
-mypy = ">=0.960"
 typing-extensions = ">=4.2.0"
 matplotlib = ">=3.3.2"
+
+[tool.poetry.dev-dependencies]
+mypy = ">=0.960"
 pytest = ">=7.1.2"
 pyright = ">=1.1.251"
 black = ">=22.3.0"
 isort = ">=5.10.1"
+poethepoet = ">=0.13.1"
+loguru = ">=0.6.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
-[tool.poetry.scripts]
-all_tests = "scripts.tests:run_all"
-install_wheel = "scripts.tests:install_wheel"
-rm_src_code = "scripts.tests:remove_src_code"
+[tool.poe.tasks.test_src]
+help = "LOCAL TEST | Run tests against source code version: \"poe test_src -p=<profile>\""
+script = "scripts.test:test_src(profile)"
+
+    [[tool.poe.tasks.test_src.args]]
+    help = "\"default\" (mypy + pyright) or \"pytest\" (pytest only) or \"full\" (mypy + pyright + pytest)"
+    name = "profile"
+    options = ["-p", "--profile"]
+    default = "default"
+
+[tool.poe.tasks.test_dist]
+help = "Local Test | Run tests against distribuition version: \"poe test_dist\""
+script = "scripts.test:test_dist"
+
+[tool.poe.tasks.test_all]
+help = "Local Test | Run tests against source code and distribuition version: \"poe test_all\""
+script = "scripts.test:test_all"
+
+[tool.poe.tasks.run_mypy_src]
+help = "CI Test | Run mypy against source code"
+script = "scripts.test:run_mypy_src"
+
+[tool.poe.tasks.run_pyright_src]
+help = "CI Test | Run pyright against source code"
+script = "scripts.test:run_pyright_src"
+
+[tool.poe.tasks.run_pytest_src]
+help = "CI Test | Run pytest against source code"
+script = "scripts.test:run_pytest_src"
+
+[tool.poe.tasks.build_dist]
+help = "CI Test | Build distribuition"
+script = "scripts.test:build_dist"
+
+[tool.poe.tasks.install_dist]
+help = "CI Test | Install distribuition"
+script = "scripts.test:install_dist"
+
+[tool.poe.tasks.remove_src]
+help = "CI Test | Remove source code"
+script = "scripts.test:remove_src"
+
+[tool.poe.tasks.run_mypy_dist]
+help = "CI Test | Run mypy against distribuition"
+script = "scripts.test:run_mypy_dist"
+
+[tool.poe.tasks.run_pyright_dist]
+help = "CI Test | Run pyright against distribuition"
+script = "scripts.test:run_pyright_dist"
 
 [tool.black]
 line_length = 88

scripts/__init__.py

@@ -0,0 +1,18 @@
+import sys
+
+from loguru import logger
+
+config = {
+    "handlers": [
+        {
+            "sink": sys.stderr,
+            "format": (
+                "\n<level>===========================================</level>\n"
+                "<level>{message}</level>\n"
+                "<level>===========================================</level>\n"
+            ),
+        }
+    ]
+}
+
+logger.configure(**config)

scripts/_job.py

@@ -0,0 +1,31 @@
+import time
+from dataclasses import dataclass
+from subprocess import CalledProcessError
+from typing import Callable, List
+
+from loguru import logger
+
+
+@dataclass
+class Step:
+    name: str
+    run: Callable[[], None]
+
+
+def run_job(steps: List[Step]) -> None:
+    """
+    Responsible to run procedures with logs
+    """
+
+    for step in steps:
+        start = time.perf_counter()
+        logger.info(f"Beginning to run: '{step.name}'")
+
+        try:
+            step.run()
+        except CalledProcessError:
+            logger.error(f"'{step.name}' failed!")
+            break
+
+        end = time.perf_counter()
+        logger.success(f"End '{step.name}', runtime: {end - start:.3f} seconds.")

scripts/test.py

@@ -0,0 +1,117 @@
+import shutil
+import subprocess
+from pathlib import Path
+
+from scripts._job import Step, run_job
+
+
+def run_mypy_src():
+    cmd = ["mypy", "pandas-stubs", "tests"]
+    subprocess.run(cmd, check=True)
+
+
+def run_pyright_src():
+    cmd = ["pyright"]
+    subprocess.run(cmd, check=True)
+
+
+def run_pytest_src():
+    cmd = ["pytest"]
+    subprocess.run(cmd, check=True)
+
+
+def test_src(profile):
+    steps = []
+
+    # Possible steps
+    mypy_step = Step(name="Run Mypy Against Source Code", run=run_mypy_src)
+    pyright_step = Step(name="Run Pyright Against Source Code", run=run_pyright_src)
+    pytest_step = Step(name="Run Pytest Against Source Code", run=run_pytest_src)
+
+    # Defining which test is going to run according to a profile
+    if profile in (None, "", "default"):
+        steps.append(mypy_step)
+        steps.append(pyright_step)
+    elif profile == "pytest":
+        steps.append(Step(name="Run Pytest Against Source Code", run=run_pytest_src))
+    elif profile == "full":
+        steps.append(mypy_step)
+        steps.append(pyright_step)
+        steps.append(pytest_step)
+    else:
+        raise Exception("Profile not found!")
+
+    run_job(steps)
+
+
+def build_dist():
+    cmd = ["poetry", "build", "-f", "wheel"]
+    subprocess.run(cmd, check=True)
+
+
+def install_dist():
+    path = next(Path("dist/").glob("*.whl"))
+    cmd = ["pip", "install", str(path), "--force-reinstall"]
+    subprocess.run(cmd, check=True)
+
+
+def remove_src():
+    shutil.rmtree(r"pandas-stubs")
+
+
+def run_mypy_dist():
+    cmd = ["mypy", "tests"]
+    subprocess.run(cmd, check=True)
+
+
+def run_pyright_dist():
+    cmd = ["pyright", "tests"]
+    subprocess.run(cmd, check=True)
+
+
+def uninstall_dist():
+    cmd = ["pip", "uninstall", "-y", "pandas-stubs"]
+    subprocess.run(cmd, check=True)
+
+
+def restore_src():
+    cmd = ["git", "checkout", "HEAD", "pandas-stubs"]
+    subprocess.run(cmd, check=True)
+
+
+def install_poetry():
+    cmd = ["poetry", "update", "-vvv"]
+    subprocess.run(cmd, check=True)
+
+
+def test_dist():
+    steps = [
+        Step(name="Build Dist", run=build_dist),
+        Step(name="Install Dist", run=install_dist),
+        Step(name="Remove Source Code", run=remove_src),
+        Step(name="Run MyPy Against Dist", run=run_mypy_dist),
+        Step(name="Run Pyright Against Dist", run=run_pyright_dist),
+        Step(name="Uninstall Dist", run=uninstall_dist),
+        Step(name="Restore Source Code", run=restore_src),
+        Step(name="Install Poetry", run=install_poetry),
+    ]
+
+    run_job(steps)
+
+
+def test_all():
+    steps = [
+        Step(name="Run Mypy Against Source Code", run=run_mypy_src),
+        Step(name="Run Pyright Against Source Code", run=run_pyright_src),
+        Step(name="Run Pytest Against Source Code", run=run_pytest_src),
+        Step(name="Build Dist", run=build_dist),
+        Step(name="Install Dist", run=install_dist),
+        Step(name="Remove Source Code", run=remove_src),
+        Step(name="Run MyPy Against Dist", run=run_mypy_dist),
+        Step(name="Run Pyright Against Dist", run=run_pyright_dist),
+        Step(name="Uninstall Dist", run=uninstall_dist),
+        Step(name="Restore Source Code", run=restore_src),
+        Step(name="Install Poetry", run=install_poetry),
+    ]
+
+    run_job(steps)