Merge pull request #1045 from appwrite/add-python-types

chore: add python types
appwrite · Mar 10, 2025 · f0ee4cc · f0ee4cc
2 parents 6a10a65 + ce3ab1b
commit f0ee4cc
Show file tree

Hide file tree

Showing 9 changed files with 184 additions and 107 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -36,9 +36,10 @@ jobs:
           Node20,
           PHP80,
           PHP83,
-          Python38,
           Python39,
           Python310,
+          Python311,
+          Python312,
           Ruby27,
           Ruby30,
           Ruby31,

diff --git a/composer.lock b/composer.lock
diff --git a/example.php b/example.php
@@ -220,6 +220,7 @@ function getSSLPage($url) {
 
     $sdk
         ->setName('NAME')
+        ->setVersion('7.2.0')
         ->setDescription('Repo description goes here')
         ->setShortDescription('Repo short description goes here')
         ->setURL('https://example.com')

diff --git a/src/SDK/Language/Python.php b/src/SDK/Language/Python.php
@@ -231,16 +231,26 @@ public function getTypeName(array $parameter, array $spec = []): string
         if (!empty($parameter['enumValues'])) {
             return \ucfirst($parameter['name']);
         }
-        return match ($parameter['type'] ?? '') {
-            self::TYPE_FILE => 'InputFile',
-            self::TYPE_NUMBER,
-            self::TYPE_INTEGER => 'float',
-            self::TYPE_BOOLEAN => 'bool',
-            self::TYPE_STRING => 'str',
-            self::TYPE_ARRAY => 'list',
-            self::TYPE_OBJECT => 'dict',
-            default => $parameter['type'],
-        };
+        switch ($parameter['type'] ?? '') {
+            case self::TYPE_FILE:
+                return 'InputFile';
+            case self::TYPE_NUMBER:
+            case self::TYPE_INTEGER:
+                return 'float';
+            case self::TYPE_BOOLEAN:
+                return 'bool';
+            case self::TYPE_STRING:
+                return 'str';
+            case self::TYPE_ARRAY:
+                if (!empty(($parameter['array'] ?? [])['type']) && !\is_array($parameter['array']['type'])) {
+                    return 'list[' . $this->getTypeName($parameter['array']) . ']';
+                }
+                return 'list[str]';
+            case self::TYPE_OBJECT:
+                return 'dict';
+            default:
+                return $parameter['type'];
+        }
     }
 
     /**
@@ -360,6 +370,9 @@ public function getFilters(): array
             new TwigFilter('caseEnumKey', function (string $value) {
                 return $this->toUpperSnakeCase($value);
             }),
+            new TwigFilter('getPropertyType', function ($value, $method = []) {
+                return $this->getTypeName($value, $method);
+            }),
         ];
     }
 }
diff --git a/templates/python/.github/workflows/publish.yml.twig b/templates/python/.github/workflows/publish.yml.twig
@@ -14,7 +14,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.8'
+          python-version: '3.9'
 
       - name: Build package
         run: |

diff --git a/templates/python/package/client.py.twig b/templates/python/package/client.py.twig
@@ -13,7 +13,7 @@ class Client:
         self._endpoint = '{{spec.endpoint}}'
         self._global_headers = {
             'content-type': '',
-            'user-agent' : '{{spec.title | caseUcfirst}}{{ language.name | caseUcfirst }}SDK/{{ sdk.version }} (${os.uname().sysname}; ${os.uname().version}; ${os.uname().machine})',
+            'user-agent' : f'{{spec.title | caseUcfirst}}{{ language.name | caseUcfirst }}SDK/{{ sdk.version }} ({os.uname().sysname}; {os.uname().version}; {os.uname().machine})',
             'x-sdk-name': '{{ sdk.name }}',
             'x-sdk-platform': '{{ sdk.platform }}',
             'x-sdk-language': '{{ language.name | caseLower }}',

diff --git a/templates/python/package/services/service.py.twig b/templates/python/package/services/service.py.twig
@@ -1,13 +1,34 @@
 from ..service import Service
 from ..exception import AppwriteException
+{% set added = [] %}
+{% for method in service.methods %}
+{% for parameter in method.parameters.all %}
+{% if parameter.type == 'file' and parameter.type not in added %}
+from ..input_file import InputFile
+{% set added = added|merge(['InputFile']) %}
+{% endif %}
+{% if parameter.enumValues is not empty%}
+{% if parameter.enumName is not empty %}
+{% set name = parameter.enumName %}
+{% else %}
+{% set name = parameter.name %}
+{% endif %}
+{% if name not in added %}
+from ..enums.{{ name | caseSnake }} import {{ name | caseUcfirst }};
+{% set added = added|merge([name]) %}
+{% endif %}
+{% endif %}
+{% endfor %}
+{% endfor %}
 
 class {{ service.name | caseUcfirst }}(Service):
 
     def __init__(self, client):
         super({{ service.name | caseUcfirst }}, self).__init__(client)
 {% for method in service.methods %}
 
-    def {{ method.name | caseSnake }}(self{% if method.parameters.all|length > 0 %}, {% endif %}{% for parameter in method.parameters.all %}{{ parameter.name | escapeKeyword | caseSnake }}{% if not parameter.required %} = None{% endif %}{% if not loop.last %}, {% endif %}{% endfor %}{% if 'multipart/form-data' in method.consumes %}, on_progress = None{% endif %}):
+    def {{ method.name | caseSnake }}(self{% if method.parameters.all|length > 0 %}, {% endif %}{% for parameter in method.parameters.all %}{{ parameter.name | escapeKeyword | caseSnake }}: {{ parameter | getPropertyType(method) | raw }}{% if not parameter.required %} = None{% endif %}{% if not loop.last %}, {% endif %}{% endfor %}{% if 'multipart/form-data' in method.consumes %}, on_progress = None{% endif %}):
+        """{{method.title}}"""
 
         api_path = '{{ method.path }}'
 {{ include('python/base/params.twig') }}

diff --git a/tests/Python38Test.php → tests/Python311Test.php b/tests/Python38Test.php → tests/Python311Test.php
@@ -2,7 +2,7 @@
 
 namespace Tests;
 
-class Python38Test extends Base
+class Python311Test extends Base
 {
     protected string $sdkName = 'python';
     protected string $sdkPlatform = 'server';
@@ -14,10 +14,10 @@ class Python38Test extends Base
     protected array $build = [
         'cp tests/languages/python/tests.py tests/sdks/python/test.py',
         'echo "" > tests/sdks/python/__init__.py',
-        'docker run --rm -v $(pwd):/app -w /app --env PIP_TARGET=tests/sdks/python/vendor python:3.8-alpine pip install -r tests/sdks/python/requirements.txt --upgrade',
+        'docker run --rm -v $(pwd):/app -w /app --env PIP_TARGET=tests/sdks/python/vendor python:3.11-alpine pip install -r tests/sdks/python/requirements.txt --upgrade',
     ];
     protected string $command =
-        'docker run --network="mockapi" --rm -v $(pwd):/app -w /app --env PIP_TARGET=tests/sdks/python/vendor --env PYTHONPATH=tests/sdks/python/vendor python:3.8-alpine python tests/sdks/python/test.py';
+        'docker run --network="mockapi" --rm -v $(pwd):/app -w /app --env PIP_TARGET=tests/sdks/python/vendor --env PYTHONPATH=tests/sdks/python/vendor python:3.11-alpine python tests/sdks/python/test.py';
 
     protected array $expectedOutput = [
         ...Base::FOO_RESPONSES,

diff --git a/tests/Python312Test.php b/tests/Python312Test.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Tests;
+
+class Python312Test extends Base
+{
+    protected string $sdkName = 'python';
+    protected string $sdkPlatform = 'server';
+    protected string $sdkLanguage = 'python';
+    protected string $version = '0.0.1';
+
+    protected string $language = 'python';
+    protected string $class = 'Appwrite\SDK\Language\Python';
+    protected array $build = [
+        'cp tests/languages/python/tests.py tests/sdks/python/test.py',
+        'echo "" > tests/sdks/python/__init__.py',
+        'docker run --rm -v $(pwd):/app -w /app --env PIP_TARGET=tests/sdks/python/vendor python:3.12-alpine pip install -r tests/sdks/python/requirements.txt --upgrade',
+    ];
+    protected string $command =
+        'docker run --network="mockapi" --rm -v $(pwd):/app -w /app --env PIP_TARGET=tests/sdks/python/vendor --env PYTHONPATH=tests/sdks/python/vendor python:3.12-alpine python tests/sdks/python/test.py';
+
+    protected array $expectedOutput = [
+        ...Base::FOO_RESPONSES,
+        ...Base::BAR_RESPONSES,
+        ...Base::GENERAL_RESPONSES,
+        ...Base::UPLOAD_RESPONSES,
+        ...Base::ENUM_RESPONSES,
+        ...Base::EXCEPTION_RESPONSES,
+        ...Base::OAUTH_RESPONSES,
+        ...Base::QUERY_HELPER_RESPONSES,
+        ...Base::PERMISSION_HELPER_RESPONSES,
+        ...Base::ID_HELPER_RESPONSES
+    ];
+}