libentry 1.11.10__py3-none-any.whl → 1.11.12__py3-none-any.whl

libentry/api.py

@@ -170,8 +170,8 @@ class APIClient:
 
     def __init__(
             self,
-            base_url: str,
-            api_key: str = None,
+            base_url: Optional[str] = None,
+            api_key: Optional[str] = None,
             accept: str = "application/json",
             content_type: str = "application/json",
             user_agent: str = "API Client",
@@ -219,10 +219,10 @@ class APIClient:
             retry_factor: float = 2,
             timeout: float = 15
     ):
-        api_url = urljoin(self.base_url, path)
+        full_url = urljoin(self.base_url, path) if self.base_url else path
         response = self._request(
             "get",
-            url=api_url,
+            url=full_url,
             headers=self.headers,
             verify=self.verify,
             num_trials=num_trials,
@@ -254,7 +254,7 @@ class APIClient:
             chunk_suffix: str = None,
             error_prefix: str = "ERROR: "
     ):
-        full_url = urljoin(self.base_url, path)
+        full_url = urljoin(self.base_url, path) if self.base_url else path
 
         headers = {**self.headers}
         headers["Accept"] = headers["Accept"] + f"; stream={int(stream)}"

libentry/service/flask.py

@@ -10,14 +10,14 @@ import re
 import traceback
 from inspect import signature
 from types import GeneratorType
-from typing import Callable, Iterable, Optional, Type, Union
+from typing import Any, Callable, Iterable, Optional, Type, Union
 
 from flask import Flask, request
 from gunicorn.app.base import BaseApplication
 from pydantic import BaseModel, Field, create_model
 from pydantic.json_schema import GenerateJsonSchema
 
-from libentry import json
+from libentry import api, json
 from libentry.api import APIInfo, list_api_info
 from libentry.logging import logger
 
@@ -120,7 +120,11 @@ def create_model_from_signature(fn):
             fields[name] = (param.annotation, None)
         else:
             fields[name] = (param.annotation, Field())
-    fields["return"] = (sig.return_annotation, None)
+
+    return_annotation = sig.return_annotation
+    if return_annotation is sig.empty:
+        return_annotation = Any
+    fields["return"] = (return_annotation, None)
     return create_model(f"__{fn.__name__}_signature", **fields)
 
 
@@ -253,27 +257,45 @@ class FlaskServer(Flask):
                 self.post(path)(wrapped_fn)
             else:
                 raise RuntimeError(f"Unsupported method \"{method}\" for ")
-        logger.info("Flask application initialized.")
 
-        self.get("/")(self.index)
+        for fn, api_info in list_api_info(self):
+            method = api_info.method
+            path = api_info.path
+            if asyncio.iscoroutinefunction(fn):
+                logger.error(f"Async function \"{fn.__name__}\" is not supported.")
+                continue
+            logger.info(f"Serving {method}-API for {path}")
 
-    def index(self):
-        args = request.args
-        if "name" not in args:
+            wrapped_fn = FlaskWrapper(self, fn, api_info)
+            if method == "GET":
+                self.get(path)(wrapped_fn)
+            elif method == "POST":
+                self.post(path)(wrapped_fn)
+            else:
+                raise RuntimeError(f"Unsupported method \"{method}\" for ")
+
+        logger.info("Flask application initialized.")
+
+    @api.get("/")
+    def index(self, name: str = None):
+        if name is None:
             all_api = []
             for _, api_info in self.api_info_list:
                 all_api.append({"path": api_info.path})
-            return self.ok(json.dumps(all_api, indent=4))
+            return all_api
 
-        name = args["name"]
         for fn, api_info in self.api_info_list:
             if api_info.path == "/" + name:
                 # noinspection PyTypeChecker
                 dynamic_model = create_model_from_signature(fn)
                 schema = dynamic_model.model_json_schema(schema_generator=CustomGenerateJsonSchema)
-                return self.ok(json.dumps(schema, indent=4))
+                return schema
+
+        return f"No API named \"{name}\""
 
-        return self.error(f"No API named \"{name}\"")
+    @api.get()
+    def live(self):
+        return "OK"
 
     def ok(self, body: Union[str, Iterable[str]], mimetype="application/json"):
         return self.response_class(body, status=200, mimetype=mimetype)

{libentry-1.11.10.dist-info → libentry-1.11.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: libentry
-Version: 1.11.10
+Version: 1.11.12
 Summary: Entries for experimental utilities.
 Home-page: https://github.com/XoriieInpottn/libentry
 Author: xi
@@ -9,13 +9,24 @@ License: Apache-2.0 license
 Platform: any
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests
-Requires-Dist: pydantic
-Requires-Dist: json5
-Requires-Dist: PyYAML
 Requires-Dist: Flask
+Requires-Dist: PyYAML
 Requires-Dist: gunicorn
+Requires-Dist: json5
+Requires-Dist: pydantic
+Requires-Dist: requests
 
 # libentry
 
+## Define a Service Class
+1. Define a normal python class.
+2. Use @api.post() or @api.get() to tag a method as API method. 
+3. Ensure every API method has type hint for both arguments and return value.
+
+## Access a Service
+1. Create an APIClient instance.
+2. Use its post() or get() method to send the request.
+
+
+
+

{libentry-1.11.10.dist-info → libentry-1.11.12.dist-info}/RECORD

@@ -1,5 +1,5 @@
 libentry/__init__.py,sha256=rDBip9M1Xb1N4wMKE1ni_DldrQbkRjp8DxPkTp3K2qo,170
-libentry/api.py,sha256=BWPeeHEgExWt0NOejH6v76baDLv4OxMoBqi1KsdaDeU,10031
+libentry/api.py,sha256=OZ-KZvSV2sWHshYB6vgS-qIu1P6bdfqcMCrOQs-_RwA,10114
 libentry/argparse.py,sha256=NxzXV-jBN51ReZsNs5aeyOfzwYQ5A5nJ95rWoa-FYCs,10415
 libentry/dataclasses.py,sha256=AQV2PuxplJCwGZ5HKX72U-z-POUhTdy3XtpEK9KNIGQ,4541
 libentry/executor.py,sha256=cTV0WxJi0nU1TP-cOwmeodN8DD6L1691M2HIQsJtGrU,6582
@@ -7,17 +7,16 @@ libentry/experiment.py,sha256=ejgAHDXWIe9x4haUzIFuz1WasLY0_aD1z_vyEVGjTu8,4922
 libentry/json.py,sha256=1-Kv5ZRb5dBrOTU84n6sZtYZV3xE-O6wEt_--ynbSaU,1209
 libentry/logging.py,sha256=IiYoCUzm8XTK1fduA-NA0FI2Qz_m81NEPV3d3tEfgdI,1349
 libentry/server.py,sha256=gYPoZXd0umlDYZf-6ZV0_vJadg3YQvnLDc6JFDJh9jc,1503
-libentry/start_service.py,sha256=Mm0HRwikW1KcDsnkK_Jo2QlNqe5BBBgMqtGd9jZxX1o,1902
 libentry/service/__init__.py,sha256=1oLL20yLB1GL9IbFiZD8OReDqiCpFr-yetIR6x1cNkI,23
 libentry/service/common.py,sha256=OVaW2afgKA6YqstJmtnprBCqQEUZEWotZ6tHavmJJeU,42
-libentry/service/flask.py,sha256=x3R_DJElxxWkuaO4zY5A0ze0y5diUgsfHMwsyvMKtnE,11643
+libentry/service/flask.py,sha256=IWA9GKyuLCcdpuwZxjKXMOy8MCnEWympMyNjHxRXu-Q,12333
 libentry/service/list.py,sha256=ElHWhTgShGOhaxMUEwVbMXos0NQKjHsODboiQ-3AMwE,1397
 libentry/service/running.py,sha256=FrPJoJX6wYxcHIysoatAxhW3LajCCm0Gx6l7__6sULQ,5105
 libentry/service/start.py,sha256=mZT7b9rVULvzy9GTZwxWnciCHgv9dbGN2JbxM60OMn4,1270
 libentry/service/stop.py,sha256=wOpwZgrEJ7QirntfvibGq-XsTC6b3ELhzRW2zezh-0s,1187
-libentry-1.11.10.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-libentry-1.11.10.dist-info/METADATA,sha256=07AZ2hkh4xxZEaN9Yz5eun-_SnfttEcmAGWarWJWxXY,501
-libentry-1.11.10.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-libentry-1.11.10.dist-info/top_level.txt,sha256=u2uF6-X5fn2Erf9PYXOg_6tntPqTpyT-yzUZrltEd6I,9
-libentry-1.11.10.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-libentry-1.11.10.dist-info/RECORD,,
+libentry-1.11.12.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+libentry-1.11.12.dist-info/METADATA,sha256=GLIiUoxHfO_byVbTFbyBMar-S8ywTkGzZR_tQpRBmII,794
+libentry-1.11.12.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+libentry-1.11.12.dist-info/top_level.txt,sha256=u2uF6-X5fn2Erf9PYXOg_6tntPqTpyT-yzUZrltEd6I,9
+libentry-1.11.12.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+libentry-1.11.12.dist-info/RECORD,,

{libentry-1.11.10.dist-info → libentry-1.11.12.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.1)
+Generator: bdist_wheel (0.45.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

libentry/start_service.py

@@ -1,74 +0,0 @@
-#!/usr/bin/env python3
-
-__author__ = "xi"
-
-import os
-import subprocess
-from cgi import parse
-from typing import Dict, List, Optional
-
-import yaml
-from pydantic import BaseModel, Field
-
-from libentry import ArgumentParser
-
-
-class Config(BaseModel):
-    exec: str = Field()
-    envs: Dict[str, str] = Field(default_factory=dict)
-    stdout: Optional[str] = Field(default="-")
-    stderr: Optional[str] = Field(default="-")
-
-
-class Status(BaseModel):
-    pid: int = Field()
-
-
-def main():
-    parser = ArgumentParser()
-    parser.add_argument("--config_dir", "-d")
-    parser.add_argument("--config_filename", "-f", default="config.json")
-    parser.add_argument("--status_filename", default="status.json")
-    args = parser.parse_args()
-
-    config_dir = args.config_dir
-    if config_dir is None:
-        config_dir = os.getcwd()
-    config_dir = os.path.abspath(config_dir)
-    os.chdir(config_dir)
-
-    if not os.path.exists(args.config_filename):
-        raise FileNotFoundError(f"Cannot find \"{args.config_filename}\".")
-
-    with open(args.config_filename) as f:
-        config = Config.model_validate(yaml.safe_load(f))
-
-    if config.stdout == "-":
-        stdout = None
-    elif config.stdout is None:
-        stdout = subprocess.DEVNULL
-    else:
-        stdout = open(config.stdout, "a")
-    if config.stderr == "-":
-        stderr = None
-    elif config.stderr is None:
-        stderr = subprocess.DEVNULL
-    else:
-        stderr = open(config.stderr, "a")
-
-    process = subprocess.Popen(
-        ["/bin/bash", "-c", config["exec"]],
-        cwd=os.getcwd(),
-        env={**os.environ, **config.envs} if len(config.envs) > 0 else None,
-        preexec_fn=os.setpgrp,
-        stdout=stdout,
-        stderr=stderr
-    )
-    pgid = os.getpgid(process.pid)
-    with open(PID_FILENAME, "w") as f:
-        f.write(str(pgid))
-    return 0
-
-
-if __name__ == "__main__":
-    raise SystemExit(main())