release-2024-10-17 (#145)

The new update brings several changes. Mainly in the core, all SQL and parameters are now rust-prepared using pysqlx-core.
The PySQLX Engine maintains almost all compatibility with version 0.2.*. This release brings an extra layer of security for your SQL parameters.

***Note: You may need some revisions or small changes to your code.***

- (`Native SQL Params`): Add native support to send the parameters separately to the database. Now, the PySQLX Engine supports sending the SQL and Parameters to the database.
- (`New Pool`): Add new Pool async and sync. This release includes a new pool class for the PySQLX Engine to support concurrency connections.
- (`Dev Mode`): Now the SQL built could be showing using the env var `PYSQLX_DEV_MODE`; this SQL is not sent to the database; it is just a help to dev identify possible bugs previously.

Author: carlos-rian

.github/prod.py

@@ -3,18 +3,18 @@
 import toml
 
 with open("pyproject.toml", mode="r") as file:
-    text: str = file.read()
+	text: str = file.read()
 
 
 def get_version():
-    uri = "https://pypi.org/pypi/pysqlx-engine/json"
-    for _ in range(3):
-        resp = httpx.get(uri)
-        if resp.is_success:
-            break
-    json: dict = resp.json()
+	uri = "https://pypi.org/pypi/pysqlx-engine/json"
+	for _ in range(3):
+		resp = httpx.get(uri)
+		if resp.is_success:
+			break
+	json: dict = resp.json()
 
-    return json["info"]["version"]
+	return json["info"]["version"]
 
 
 file_version = toml.loads(text)["tool"]["poetry"]["version"]
@@ -23,11 +23,11 @@ def get_version():
 print("Package version:", current_version)
 
 if file_version.replace(".", "") > current_version.replace(".", ""):
-    MAJOR, MINOR, PATCH = file_version.split(".")
+	MAJOR, MINOR, PATCH = file_version.split(".")
 
 else:
-    MAJOR, MINOR, PATCH = current_version.split(".")
-    PATCH = str(int(PATCH) + 1)
+	MAJOR, MINOR, PATCH = current_version.split(".")
+	PATCH = str(int(PATCH) + 1)
 
 new_version: str = ".".join([MAJOR, MINOR, PATCH])
 
@@ -36,9 +36,9 @@ def get_version():
 new_text = text.replace(f'version = "{file_version}"', f'version = "{new_version}"')
 
 with open("pyproject.toml", mode="w") as file:
-    file.write(new_text)
+	file.write(new_text)
 
 env_file = os.getenv("GITHUB_ENV")
 
 with open(env_file, mode="a") as file:
-    file.write(f"\nPY_SQLX_VERSION=v{new_version}")
+	file.write(f"\nPY_SQLX_VERSION=v{new_version}")

.github/release.py

@@ -2,21 +2,21 @@
 import toml
 
 with open("pyproject.toml", mode="r") as file:
-    text: str = file.read()
+	text: str = file.read()
 
 
 def get_version():
-    uri = "https://pypi.org/pypi/pysqlx-engine/json"
-    for _ in range(3):
-        resp = httpx.get(uri)
-        if resp.is_success:
-            break
-    json: dict = resp.json()
+	uri = "https://pypi.org/pypi/pysqlx-engine/json"
+	for _ in range(3):
+		resp = httpx.get(uri)
+		if resp.is_success:
+			break
+	json: dict = resp.json()
 
-    releases = json["releases"]
-    versions = sorted(releases.keys(), key=lambda x: int(x.replace(".", "").replace("b", "")), reverse=True)
-    versions = [v for v in versions if v.startswith("0.2.0") and "b" in v]
-    return versions[0]
+	releases = json["releases"]
+	versions = sorted(releases.keys(), key=lambda x: int(x.replace(".", "").replace("b", "")), reverse=True)
+	versions = [v for v in versions if v.startswith("0.3.0") and "b" in v]
+	return versions[0] if versions else "0.3.0b-1"
 
 
 file_version = toml.loads(text)["tool"]["poetry"]["version"]
@@ -40,4 +40,4 @@ def get_version():
 new_text = text.replace(f'version = "{file_version}"', f'version = "{new_version}"')
 
 with open("pyproject.toml", mode="w") as file:
-    file.write(new_text)
+	file.write(new_text)

.github/workflows/ci.yml

@@ -21,15 +21,15 @@ jobs:
       max-parallel: 6
       matrix:
         os: [ubuntu-latest]
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
       fail-fast: false
 
     steps:
       - name: checkout
         uses: actions/checkout@v3
 
       - name: setup python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -42,7 +42,7 @@ jobs:
 
       - name: up database
         run: cp tests/docker/docker-compose.yml docker-compose.yml &&
-          docker-compose up --build --detach
+          docker compose up --build --detach
 
       - name: wait container up
         run: |
@@ -86,7 +86,7 @@ jobs:
         run: |
           pip install pydantic --upgrade
           pip freeze | grep pydantic
-          poetry run pytest --ignore=tests/benchmark --cov=pysqlx_engine --cov=tests --cov-report=term-missing:skip-covered --cov-report=xml tests ${@}
+          poetry run pytest --cov-report=xml tests ${@}
 
       - name: upload coverage v2
         uses: codecov/codecov-action@v3
@@ -99,27 +99,32 @@ jobs:
     runs-on: ubuntu-latest
     needs: [test]
     steps:
-      - name: checkout
+      - name: Checkout
         uses: actions/checkout@v3
 
-      - name: release - check package version
-        if: github.ref != 'refs/heads/main'
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Release - check package version
+        if: contains(github.ref, 'release')
         run: |
           pip install --upgrade httpx toml
           python .github/release.py
 
-      - name: prod - check package version
+      - name: Main - check package version
         if: github.ref == 'refs/heads/main'
         run: |
           pip install --upgrade httpx toml
           python .github/prod.py
 
-      - name: build and publish to pypi
+      - name: Build and Publish to pypi
         uses: JRubics/poetry-publish@v1.13
         with:
           pypi_token: ${{ secrets.PYPI_TOKEN }}
 
-      - name: create celease
+      - name: Create Release
         if: github.ref == 'refs/heads/main'
         id: create_release
         uses: actions/create-release@v1

.gitignore

@@ -242,7 +242,7 @@ ipython_config.py
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
 #   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
+poetry.lock
 
 # pdm
 #   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
@@ -348,5 +348,3 @@ $RECYCLE.BIN/
 *.lnk
 
 # End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,python,windows,macos,linux,pycharm+all
-
-test.py

.vscode/settings.json

@@ -4,6 +4,17 @@
     "files.watcherExclude": {
         "**/__pycache__/**": true,
     },
+    "files.exclude": {
+        "**/.git": true,
+        "**/.svn": true,
+        "**/.hg": true,
+        "**/CVS": true,
+        "**/.DS_Store": true,
+        "**/Thumbs.db": true,
+        "**/__pycache__/**": true,
+        "**/.pytest_cache/**": true,
+        "**.coverage": true,
+    },
     "[python]": {
         "editor.rulers": [
             120
@@ -12,7 +23,7 @@
         "editor.codeActionsOnSave": {
             "source.organizeImports": "explicit"
         },
-        "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.defaultFormatter": "charliermarsh.ruff",
         "editor.bracketPairColorization.enabled": true
     },
 }