flashforge-python-api 1.2.0__tar.gz → 1.2.1__tar.gz

{flashforge_python_api-1.2.0 → flashforge_python_api-1.2.1}/.github/workflows/publish.yml

@@ -78,11 +78,28 @@ jobs:
           ls -lh dist/
           twine check dist/*
 
+      - name: Extract changelog for this version
+        id: changelog
+        run: |
+          VERSION="${{ steps.validate.outputs.version }}"
+          # Extract the section for this version from CHANGELOG.md
+          # Matches from "## [X.Y.Z]" until the next "## [" or end of file
+          CHANGELOG=$(awk "/^## \[$VERSION\]/{found=1; next} /^## \[/{if(found) exit} found{print}" CHANGELOG.md)
+
+          if [ -z "$CHANGELOG" ]; then
+            echo "Warning: No changelog entry found for version $VERSION"
+            CHANGELOG="No changelog entry found. See [CHANGELOG.md](https://github.com/GhostTypes/ff-5mp-api-py/blob/main/CHANGELOG.md) for details."
+          fi
+
+          # Write to file to preserve multiline content
+          echo "$CHANGELOG" > /tmp/changelog_body.md
+
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v2
         with:
           tag_name: v${{ steps.validate.outputs.version }}
           name: Release ${{ steps.validate.outputs.version }}
+          body_path: /tmp/changelog_body.md
           files: dist/*
           generate_release_notes: true
           draft: false

{flashforge_python_api-1.2.0 → flashforge_python_api-1.2.1}/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.1] - 2026-03-23
+
+### Fixed
+
+- Increased `currentPrintSpeed` and `printSpeedAdjust` validation limit from 200 to 1000 to support AD5X printers reporting speeds up to 500 (contributed by @spawnegit)
+- Replaced per-request `aiohttp.ClientSession()` creation with shared HTTP session across all control modules (`control.py`, `files.py`, `info.py`, `job_control.py`), fixing connection churn and respecting the configured timeout
+- Increased default HTTP timeout from 5s to 15s to prevent timeouts during print operations
+
+### Changed
+
+- Extracted duplicate `try/except aiohttp.ContentTypeError` JSON parsing pattern into a shared `json_from_response()` helper in `api/network/utils.py`
+- Release workflow now includes curated changelog entry alongside auto-generated commit notes in GitHub Releases
+
 ## [1.2.0] - 2026-03-21
 
 ### Added
@@ -123,7 +136,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Type hints for all public APIs
 - Inline code documentation
 
-[Unreleased]: https://github.com/GhostTypes/ff-5mp-api-py/compare/v1.2.0...HEAD
+[Unreleased]: https://github.com/GhostTypes/ff-5mp-api-py/compare/v1.2.1...HEAD
+[1.2.1]: https://github.com/GhostTypes/ff-5mp-api-py/compare/v1.2.0...v1.2.1
 [1.2.0]: https://github.com/GhostTypes/ff-5mp-api-py/compare/v1.1.1...v1.2.0
 [1.1.1]: https://github.com/GhostTypes/ff-5mp-api-py/releases/tag/v1.1.1
 [1.0.2]: https://github.com/GhostTypes/ff-5mp-api-py/releases/tag/v1.0.2

{flashforge_python_api-1.2.0 → flashforge_python_api-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flashforge-python-api
-Version: 1.2.0
+Version: 1.2.1
 Summary: A comprehensive Python library for controlling FlashForge 3D printers
 Project-URL: Homepage, https://github.com/GhostTypes/ff-5mp-api-py
 Project-URL: Documentation, https://github.com/GhostTypes/ff-5mp-api-py#readme

{flashforge_python_api-1.2.0 → flashforge_python_api-1.2.1}/flashforge/api/controls/control.py

@@ -4,12 +4,10 @@ FlashForge Python API - Control Module
 
 from typing import TYPE_CHECKING, Any
 
-import aiohttp
-
 from ...models.responses import FilamentArgs
 from ..constants.commands import Commands
 from ..constants.endpoints import Endpoints
-from ..network.utils import NetworkUtils
+from ..network.utils import NetworkUtils, json_from_response
 
 if TYPE_CHECKING:
     from ...client import FlashForgeClient
@@ -239,26 +237,16 @@ class Control:
         try:
             await self.client.is_http_client_busy()
 
-            async with aiohttp.ClientSession() as session:
-                async with session.post(
-                    self.client.get_endpoint(Endpoints.CONTROL),
-                    json=payload,
-                    headers={"Content-Type": "application/json"},
-                ) as response:
-                    # Fix for FlashForge printer's malformed Content-Type header
-                    # Some printers return "appliation/json" instead of "application/json"
-                    try:
-                        data = await response.json()
-                    except aiohttp.ContentTypeError:
-                        # Fallback: manually parse as JSON if Content-Type is malformed
-                        text = await response.text()
-                        import json
-
-                        data = json.loads(text)
-
-                    print(f"Command reply: {data}")
-
-                    return NetworkUtils.is_ok(data)
+            session = await self.client.get_http_session()
+            async with session.post(
+                self.client.get_endpoint(Endpoints.CONTROL),
+                json=payload,
+                headers={"Content-Type": "application/json"},
+            ) as response:
+                data = await json_from_response(response)
+                print(f"Command reply: {data}")
+
+                return NetworkUtils.is_ok(data)
 
         except Exception as e:
             print(f"Error in send_control_command: {e}")

flashforge_python_api-1.2.1/flashforge/api/controls/files.py

@@ -0,0 +1,170 @@
+"""
+FlashForge Python API - Files Module
+"""
+
+import base64
+from typing import TYPE_CHECKING
+
+from pydantic import ValidationError
+
+from ...models.machine_info import FFGcodeFileEntry
+from ...models.responses import GCodeListResponse, ThumbnailResponse
+from ..constants.endpoints import Endpoints
+from ..network.utils import NetworkUtils, json_from_response
+
+if TYPE_CHECKING:
+    from ...client import FlashForgeClient
+
+
+class Files:
+    """
+    Provides methods for managing files on the FlashForge 3D printer.
+    This includes retrieving file lists and thumbnails.
+    """
+
+    def __init__(self, client: "FlashForgeClient"):
+        """
+        Creates an instance of the Files class.
+
+        Args:
+            client: The FlashForgeClient instance used for communication with the printer.
+        """
+        self.client = client
+
+    async def get_file_list(self) -> list[str]:
+        """
+        Retrieves a list of files stored locally on the printer.
+
+        Returns:
+            A list of file names, or empty list if retrieval fails.
+        """
+        # This method uses the TCP client to get file list
+        if hasattr(self.client, "tcp_client") and self.client.tcp_client:
+            return await self.client.tcp_client.get_file_list_async()
+        return []
+
+    async def get_local_file_list(self) -> list[str]:
+        """
+        Retrieves a list of files stored locally on the printer.
+
+        Returns:
+            A list of file names, or empty list if retrieval fails.
+        """
+        return await self.get_file_list()
+
+    async def get_recent_file_list(self) -> list[FFGcodeFileEntry]:
+        """
+        Retrieves a list of the 10 most recently printed files from the printer's API.
+        For AD5X and newer printers, returns detailed file entries with material info.
+        For older printers, returns basic file entries with normalized data.
+
+        Returns:
+            A list of FFGcodeFileEntry objects. Returns an empty list if the request fails or an error occurs.
+        """
+        payload = {"serialNumber": self.client.serial_number, "checkCode": self.client.check_code}
+
+        try:
+            session = await self.client.get_http_session()
+            async with session.post(
+                self.client.get_endpoint(Endpoints.GCODE_LIST),
+                json=payload,
+                headers={"Content-Type": "application/json"},
+            ) as response:
+                if response.status != 200:
+                    return []
+
+                data = await json_from_response(response)
+
+                if not NetworkUtils.is_ok(data):
+                    print(f"Error retrieving file list: {NetworkUtils.get_error_message(data)}")
+                    return []
+
+                # Parse the response using GCodeListResponse
+                try:
+                    result = GCodeListResponse(**data)
+                except ValidationError:
+                    raw_list = data.get("gcodeList", [])
+                    if isinstance(raw_list, list):
+                        entries: list[FFGcodeFileEntry] = []
+                        for file_name in raw_list:
+                            if isinstance(file_name, str):
+                                entries.append(
+                                    FFGcodeFileEntry(
+                                        gcodeFileName=file_name,
+                                        printingTime=0,
+                                    )
+                                )
+                        return entries
+                    return []
+
+                # AD5X and newer printers provide detailed info in gcodeListDetail
+                if result.gcode_list_detail and len(result.gcode_list_detail) > 0:
+                    return result.gcode_list_detail
+
+                # Fallback for older printers using gcodeList
+                if result.gcode_list and len(result.gcode_list) > 0:
+                    # Check if it's a list of strings or already FFGcodeFileEntry objects
+                    first_item = result.gcode_list[0]
+
+                    if isinstance(first_item, str):
+                        # Convert string array to FFGcodeFileEntry objects
+                        return [
+                            FFGcodeFileEntry(gcodeFileName=file_name, printingTime=0)
+                            for file_name in result.gcode_list
+                            if isinstance(file_name, str)
+                        ]
+                    elif isinstance(first_item, FFGcodeFileEntry):
+                        # Already FFGcodeFileEntry objects - need explicit type narrowing
+                        return [
+                            item
+                            for item in result.gcode_list
+                            if isinstance(item, FFGcodeFileEntry)
+                        ]
+
+                return []
+
+        except Exception as err:
+            print(f"GetRecentFileList error: {err}")
+            return []
+
+    async def get_gcode_thumbnail(self, file_name: str) -> bytes | None:
+        """
+        Retrieves the thumbnail image for a specified G-code file.
+        The image data is returned as bytes.
+
+        Args:
+            file_name: The name of the G-code file (e.g., "my_print.gcode") for which to retrieve the thumbnail.
+
+        Returns:
+            Bytes containing the thumbnail image data (decoded from base64),
+            or None if the request fails, the file has no thumbnail, or an error occurs.
+        """
+        payload = {
+            "serialNumber": self.client.serial_number,
+            "checkCode": self.client.check_code,
+            "fileName": file_name,
+        }
+
+        try:
+            session = await self.client.get_http_session()
+            async with session.post(
+                self.client.get_endpoint(Endpoints.GCODE_THUMB),
+                json=payload,
+                headers={"Content-Type": "application/json"},
+            ) as response:
+                if response.status != 200:
+                    return None
+
+                data = await json_from_response(response)
+
+                if NetworkUtils.is_ok(data):
+                    # Parse response and return decoded image bytes
+                    result = ThumbnailResponse(**data)
+                    return base64.b64decode(result.image_data)
+                else:
+                    print(f"Error retrieving thumbnail: {NetworkUtils.get_error_message(data)}")
+                    return None
+
+        except Exception as err:
+            print(f"GetGcodeThumbnail error: {err}")
+            return None

{flashforge_python_api-1.2.0 → flashforge_python_api-1.2.1}/flashforge/api/controls/info.py

@@ -5,11 +5,10 @@ FlashForge Python API - Info Module
 from datetime import datetime, timedelta
 from typing import TYPE_CHECKING
 
-import aiohttp
-
 from ...models.machine_info import FFMachineInfo, MachineState, Temperature
 from ...models.responses import DetailResponse, FFPrinterDetail
 from ..constants.endpoints import Endpoints
+from ..network.utils import json_from_response
 
 if TYPE_CHECKING:
     from ...client import FlashForgeClient
@@ -262,29 +261,18 @@ class Info:
         payload = {"serialNumber": self.client.serial_number, "checkCode": self.client.check_code}
 
         try:
-            async with aiohttp.ClientSession() as session:
-                async with session.post(
-                    self.client.get_endpoint(Endpoints.DETAIL),
-                    json=payload,
-                    headers={"Content-Type": "application/json"},
-                ) as response:
-                    if response.status != 200:
-                        print(f"Non-200 status from detail endpoint: {response.status}")
-                        return None
-
-                    # Fix for FlashForge printer's malformed Content-Type header
-                    # Some printers return "appliation/json" instead of "application/json"
-                    # We'll manually parse the text as JSON to bypass Content-Type validation
-                    try:
-                        data = await response.json()
-                    except aiohttp.ContentTypeError:
-                        # Fallback: manually parse as JSON if Content-Type is malformed
-                        text = await response.text()
-                        import json
-
-                        data = json.loads(text)
-
-                    return DetailResponse(**data)
+            session = await self.client.get_http_session()
+            async with session.post(
+                self.client.get_endpoint(Endpoints.DETAIL),
+                json=payload,
+                headers={"Content-Type": "application/json"},
+            ) as response:
+                if response.status != 200:
+                    print(f"Non-200 status from detail endpoint: {response.status}")
+                    return None
+
+                data = await json_from_response(response)
+                return DetailResponse(**data)
 
         except Exception as error:
             print(f"GetDetailResponse Request error: {error}")

{flashforge_python_api-1.2.0 → flashforge_python_api-1.2.1}/flashforge/api/controls/job_control.py

@@ -17,7 +17,7 @@ from ...models.responses import (
     AD5XUploadParams,
 )
 from ..constants.endpoints import Endpoints
-from ..network.utils import NetworkUtils
+from ..network.utils import NetworkUtils, json_from_response
 
 if TYPE_CHECKING:
     from ...client import FlashForgeClient
@@ -180,17 +180,7 @@ class JobControl:
                             print(f"Upload failed: Printer responded with status {response.status}")
                             return False
 
-                        # Fix for FlashForge printer's malformed Content-Type header
-                        # Some printers return "appliation/json" instead of "application/json"
-                        try:
-                            result = await response.json()
-                        except aiohttp.ContentTypeError:
-                            # Fallback: manually parse as JSON if Content-Type is malformed
-                            text = await response.text()
-                            import json
-
-                            result = json.loads(text)
-
+                        result = await json_from_response(response)
                         print("Upload Response Data:", result)
 
                         if NetworkUtils.is_ok(result):
@@ -240,27 +230,17 @@ class JobControl:
             }
 
         try:
-            async with aiohttp.ClientSession() as session:
-                async with session.post(
-                    self.client.get_endpoint(Endpoints.GCODE_PRINT),
-                    json=payload,
-                    headers={"Content-Type": "application/json"},
-                ) as response:
-                    if response.status != 200:
-                        return False
-
-                    # Fix for FlashForge printer's malformed Content-Type header
-                    # Some printers return "appliation/json" instead of "application/json"
-                    try:
-                        result = await response.json()
-                    except aiohttp.ContentTypeError:
-                        # Fallback: manually parse as JSON if Content-Type is malformed
-                        text = await response.text()
-                        import json
-
-                        result = json.loads(text)
-
-                    return NetworkUtils.is_ok(result)
+            session = await self.client.get_http_session()
+            async with session.post(
+                self.client.get_endpoint(Endpoints.GCODE_PRINT),
+                json=payload,
+                headers={"Content-Type": "application/json"},
+            ) as response:
+                if response.status != 200:
+                    return False
+
+                result = await json_from_response(response)
+                return NetworkUtils.is_ok(result)
 
         except Exception as error:
             print(f"PrintLocalFile error: {error}")
@@ -344,13 +324,7 @@ class JobControl:
                             )
                             return False
 
-                        # Fix for FlashForge printer's malformed Content-Type header
-                        try:
-                            result = await response.json()
-                        except aiohttp.ContentTypeError:
-                            text = await response.text()
-                            result = json.loads(text)
-
+                        result = await json_from_response(response)
                         print("AD5X Upload Response Data:", result)
 
                         if NetworkUtils.is_ok(result):
@@ -415,23 +389,17 @@ class JobControl:
         }
 
         try:
-            async with aiohttp.ClientSession() as session:
-                async with session.post(
-                    self.client.get_endpoint(Endpoints.GCODE_PRINT),
-                    json=payload,
-                    headers={"Content-Type": "application/json"},
-                ) as response:
-                    if response.status != 200:
-                        return False
-
-                    # Fix for FlashForge printer's malformed Content-Type header
-                    try:
-                        result = await response.json()
-                    except aiohttp.ContentTypeError:
-                        text = await response.text()
-                        result = json.loads(text)
-
-                    return NetworkUtils.is_ok(result)
+            session = await self.client.get_http_session()
+            async with session.post(
+                self.client.get_endpoint(Endpoints.GCODE_PRINT),
+                json=payload,
+                headers={"Content-Type": "application/json"},
+            ) as response:
+                if response.status != 200:
+                    return False
+
+                result = await json_from_response(response)
+                return NetworkUtils.is_ok(result)
 
         except Exception as error:
             print(f"AD5X Multi-Color Job error: {error}")
@@ -473,23 +441,17 @@ class JobControl:
         }
 
         try:
-            async with aiohttp.ClientSession() as session:
-                async with session.post(
-                    self.client.get_endpoint(Endpoints.GCODE_PRINT),
-                    json=payload,
-                    headers={"Content-Type": "application/json"},
-                ) as response:
-                    if response.status != 200:
-                        return False
-
-                    # Fix for FlashForge printer's malformed Content-Type header
-                    try:
-                        result = await response.json()
-                    except aiohttp.ContentTypeError:
-                        text = await response.text()
-                        result = json.loads(text)
-
-                    return NetworkUtils.is_ok(result)
+            session = await self.client.get_http_session()
+            async with session.post(
+                self.client.get_endpoint(Endpoints.GCODE_PRINT),
+                json=payload,
+                headers={"Content-Type": "application/json"},
+            ) as response:
+                if response.status != 200:
+                    return False
+
+                result = await json_from_response(response)
+                return NetworkUtils.is_ok(result)
 
         except Exception as error:
             print(f"AD5X Single-Color Job error: {error}")

{flashforge_python_api-1.2.0 → flashforge_python_api-1.2.1}/flashforge/api/network/utils.py

@@ -2,9 +2,26 @@
 FlashForge Python API - Network Utilities
 """
 
+import json
+
+import aiohttp
+
 from ...models.responses import GenericResponse
 
 
+async def json_from_response(response: aiohttp.ClientResponse) -> dict:
+    """Parse JSON from a response, with a fallback for malformed Content-Type headers.
+
+    Some FlashForge printers return "appliation/json" instead of "application/json",
+    causing aiohttp to raise ContentTypeError. This helper handles both cases.
+    """
+    try:
+        return await response.json()  # type: ignore[no-any-return]
+    except aiohttp.ContentTypeError:
+        text = await response.text()
+        return json.loads(text)
+
+
 class NetworkUtils:
     """Utility class for handling network responses and status codes."""
 

{flashforge_python_api-1.2.0 → flashforge_python_api-1.2.1}/flashforge/client.py

@@ -13,7 +13,7 @@ import aiohttp
 from .api.constants.endpoints import CAMERA_STREAM_PORT, Endpoints
 from .api.controls import Control, Files, Info, JobControl, TempControl
 from .api.controls.info import MachineInfoParser
-from .api.network.utils import NetworkUtils
+from .api.network.utils import NetworkUtils, json_from_response
 from .models import FFMachineInfo, Product, ProductResponse
 from .tcp import FlashForgeClient as TcpClient
 from .tcp import FlashForgeTcpClientOptions, PrinterInfo
@@ -60,7 +60,7 @@ class FlashForgeClient:
 
         # Constants
         self._PORT = options.http_port if options and options.http_port is not None else 8898
-        self._HTTP_TIMEOUT = 5.0
+        self._HTTP_TIMEOUT = 15.0
 
         # HTTP client state
         self._http_session: aiohttp.ClientSession | None = None
@@ -379,16 +379,7 @@ class FlashForgeClient:
                 if response.status != 200:
                     return False
 
-                # Fix for FlashForge printer's malformed Content-Type header
-                # Some printers return "appliation/json" instead of "application/json"
-                try:
-                    data = await response.json()
-                except aiohttp.ContentTypeError:
-                    # Fallback: manually parse as JSON if Content-Type is malformed
-                    text = await response.text()
-                    import json
-
-                    data = json.loads(text)
+                data = await json_from_response(response)
 
                 # Validate response structure
                 if not NetworkUtils.is_ok(data):

{flashforge_python_api-1.2.0 → flashforge_python_api-1.2.1}/flashforge/models/machine_info.py

@@ -218,7 +218,7 @@ class FFPrinterDetail(BaseModel):
     coordinate: list[float] | None = Field(default=None, alias="coordinate")
     cumulative_filament: float | None = Field(default=None, ge=0, alias="cumulativeFilament")
     cumulative_print_time: int | None = Field(default=None, ge=0, alias="cumulativePrintTime")
-    current_print_speed: int | None = Field(default=None, ge=0, le=200, alias="currentPrintSpeed")
+    current_print_speed: int | None = Field(default=None, ge=0, le=1000, alias="currentPrintSpeed")
     door_status: str | None = Field(default=None, alias="doorStatus")
     error_code: str | None = Field(default=None, alias="errorCode")
     estimated_left_len: float | None = Field(default=None, ge=0, alias="estimatedLeftLen")
@@ -259,7 +259,7 @@ class FFPrinterDetail(BaseModel):
     print_file_thumb_url: str | None = Field(default=None, alias="printFileThumbUrl")
     print_layer: int | None = Field(default=None, ge=0, alias="printLayer")
     print_progress: float | None = Field(default=None, ge=0, le=100, alias="printProgress")
-    print_speed_adjust: int | None = Field(default=None, ge=0, le=200, alias="printSpeedAdjust")
+    print_speed_adjust: int | None = Field(default=None, ge=0, le=1000, alias="printSpeedAdjust")
     remaining_disk_space: float | None = Field(default=None, ge=0, alias="remainingDiskSpace")
     right_filament_type: str | None = Field(default=None, alias="rightFilamentType")
     right_target_temp: float | None = Field(default=None, ge=-50, le=500, alias="rightTargetTemp")

{flashforge_python_api-1.2.0 → flashforge_python_api-1.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "flashforge-python-api"
-version = "1.2.0"
+version = "1.2.1"
 description = "A comprehensive Python library for controlling FlashForge 3D printers"
 readme = "README.md"
 license = "MIT"